앱에 Device Sync 추가 - Kotlin SDK

Device Sync

Device Sync 는 클라이언트 기기와 Atlas 간에 데이터를 동기화합니다. 데이터는 오프라인 상태에서도 기기에 유지됩니다. 기기가 네트워크에 연결되어 있으면 Device Sync 는 배경 에서 데이터를 업로드 및 다운로드하고 충돌 해결 을 관리합니다.

클라이언트 앱 과 Atlas 간에 동기화되는 데이터는 적격 데이터에 액세스 할 수 있는 사용자 권한에 따라 결정됩니다. 적격 데이터는 다음의 교집합입니다.

• 데이터 모델: 데이터 유형 정보

• 구독 쿼리: 저장 데이터를 정의하는 조건

• 권한: 지정된 조건을 충족하는 데이터와 상호 작용 하는 데 필요한 역할 기반 권한

Device Sync 에 대한 자세한 설명은 Atlas App Services 문서에서 Atlas Device Sync 시작하기를 참조하세요.

전제 조건

앱 및 데이터 상태에 따라 여러 가지 방법으로 Device Sync를 앱에 추가할 수 있습니다. 이 가이드에서는 개발 모드를 사용하여 기존 클라이언트 앱에 동기화를 추가하는 방법을 설명합니다. 이 가이드에서는 앱이 Realm Kotlin SDK를 사용하고 클라이언트 코드에 데이터 모델을 이미 정의했다고 가정합니다.

Device Sync 는 Atlas App Atlas App Services 앱을 통해 클라이언트 앱을 Atlas App Services 백엔드에 연결하므로 시작하기 전에 다음을 수행해야 합니다.

1. 인증이 활성화된 Atlas App Services App. 방법을 알아보려면 App Services 설명서에서 App Services 앱 생성을 참조하세요.

2. 앱이 Atlas App Services 백엔드에 연결할 수 있는지 확인합니다. 방법을 알아보려면 Atlas App Services에 연결 - Kotlin SDK를 참조하세요.

해당 페이지의 예시에 대한 정보

이 페이지의 예제는 Item 객체 목록이 포함된 List 객체를 포함하는 데이터 모델이 이미 정의된 Kotlin Todo 앱의 예시를 참조합니다.

class List : RealmObject {
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    var ownerId: String = ""
    var items: RealmList<Item> = realmListOf()
}
class Item : RealmObject {
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    var complete: Boolean = false
}

App Services 에서 Device Sync 활성화

클라이언트 앱에 동기화를 추가하려면 먼저 Atlas App Services 앱에서 Device Sync를 활성화해야 합니다.

앱에서 Device Sync 를 활성화하려면 Atlas App Services 문서의 Atlas Device Sync구성 및 활성화 절차에 설명된 단계를 완료하세요.

이 프로세스 중에 개발 모드 활성화 여부와 앱 사용자의 기본값 역할 을 선택할 수 있습니다. 사용 가능한 설정에 대한 자세한 내용은 App Services 문서에서 동기화 설정 을 참조하세요.

예시 앱 에서는 개발 모드로 Device Sync 를 활성화 한 다음 기본값 "사용자는 모든 데이터를 읽고 쓰기 (write) 수 있음" 기본값 역할 을 추가합니다. 즉, 네트워크에 연결되어 있는 권한이 부여된 사용자의 경우 Device Sync 가 적격 데이터를 클라이언트 에 다운로드 하고 Atlas 가 클라이언트 에 대한 쓰기를 허용한 다음 백엔드 를 동기화합니다. 권한이 부여된 사용자가 네트워크에 연결되어 있지 않을 때 어떻게 되는지 학습 보려면 쓰기 보상하기를 참조하세요.

클라이언트 앱에 동기화 추가

Atlas App Services에서 동기화를 구성하고 활성화한 후 클라이언트 앱에 동기화를 추가할 수 있습니다.

// Replace `YOUR_APP_ID` with your Atlas App ID
val app = App.create(YOUR_APP_ID)

// Authenticate the Atlas App Services user
val myAuthenticatedUser = app.login(Credentials.anonymous())

// Define the configuration for the synced realm
val config =
    // Pass the authenticated user and the set of
    // all objects types you want to be able to sync
    SyncConfiguration.Builder(
        user = myAuthenticatedUser,
        schema = setOf(List::class, Item::class)
    )
        // Define an initial subscription with queries that include
        // the user's lists with incomplete items
        .initialSubscriptions{ realm ->
            add(realm.query<List>("ownerId == $0", myAuthenticatedUser.id),
                name = "user-lists"
            )
            add(realm.query<Item>("complete = false"),
                name = "incomplete-items"
            )
        }
        .build()

// Open the synced realm with the defined configuration
val realm = Realm.open(config)
Log.v("Successfully opened synced realm: ${realm.configuration.name}")
// Wait for initial subscriptions to sync to Atlas
realm.subscriptions.waitForSynchronization()

Realm 사용

이제 구성된 동기화된 영역 을 열었으므로 영역 에서 데이터로 작업할 수 있습니다. 로컬 데이터로 작업하는 동안 배경 스레드는 변경 세트를 효율적으로 통합, 업로드 및 다운로드합니다.

읽기, 쓰기 (write) 및 변경 사항 감시 구문은 동기화되지 않은 영역의 구문과 동일합니다. 그러나 동기화된 영역 에 데이터를 쓸 때는 추가 고려 사항이 있습니다. 자세한 내용 은 동기화된 Realm 에 데이터 쓰기 - 코틀린 SDK (Kotlin SDK) 를 참조하세요.

예시 앱 에서는 새 List 및 Item 객체 를 쓰기 (write) 다음 동기화된 영역 에 복사합니다.

// Write List and Item objects to the synced realm
// Objects that match the subscription query are synced to Atlas
realm.write {
    val list = List().apply {
        name = "My Todo List"
        ownerId = myAuthenticatedUser.id
        items.add(Item().apply {
            name = "Check email"
            complete = false
        })
    }
    copyToRealm(list)
}
realm.syncSession.uploadAllLocalChanges(30.seconds)

객체가 디바이스에 성공적으로 기록된 후 다음과 같은 이유로 Atlas와 동기화됩니다.

• 두 객체 모두 구독 쿼리 의 매개변수 내에 있습니다( List 은 사용자가 소유하고 있으며 Item 는 불완전합니다).

• 현재 사용자는 백엔드 에 데이터를 쓰기 (write) 수 있는 권한이 있습니다(이 역할 통해 권한이 부여된 사용자는 모든 데이터를 읽고 쓰기 (write) 수 있음).

쓰기 (write) 작업이 쿼리 와 일치하지 않거나 현재 사용자에게 필요한 권한이 없는 경우 Realm 은 보상 쓰기 (write)라는 치명적이지 않은 오류 작업을 통해 쓰기 (write) 를 되돌립니다.

다음 단계

앱이 원하는 데이터를 Atlas에 성공적으로 동기화하면 Kotlin SDK와 동기화를 사용하는 방법에 대해 자세히 알아볼 수 있습니다.

• 동기화된 Realm 구성 및 열기 - 코틀린 SDK (Kotlin SDK): 디버그 앱 이름 설정, 사용자 지정 요청 헤더 제공 또는 디스패처 지정과 같은 사용 가능한 앱 클라이언트 구성 옵션에 대해 알아봅니다.

• 동기화 구독 관리 - 코틀린 SDK (Kotlin SDK): 앱 에서 구독 쿼리를 정의하고 관리 하는 방법을 알아보세요.

• 동기화된 Realm 에 데이터 쓰기 - 코틀린 SDK (Kotlin SDK): 동기화된 영역 에 쓰는 방법, 쓰기 (write) 오류 보상을 처리하다 하는 방법, 성능 향상을 위해 쓰기 (write) 를 그룹 하는 방법에 자세히 보기 .

• 동기화 세션 관리 - 코틀린 SDK (Kotlin SDK): 동기화 세션을 통해 App Services 와의 통신을 관리 하는 방법을 알아보세요.

• 동기화 오류 처리 - Kotlin SDK: 클라이언트 재설정을 포함하여 발생할 수 있는 동기화 오류를 처리하는 방법을 알아보세요.