[RealmSwift] Migration, 운영 중인 앱의 필드 추가한 후 마이그레이션 해주기

class Customer: Object {
    
    @objc dynamic var idx = 0
    @objc private dynamic var privateType: Int = CustomerType.active.rawValue
    let products = List<Product>()
    
}

• 이미 운영 중인 앱에(혹은 코드를 작성 중) 3개의 프로퍼티가 있음. 이미 realm을 이용해서 객체를 생성해 realm 데이터베이스에 add 해준 후 나중에 다른 프로퍼티를 생성하려 하면 오류가 발생

• Realm Studio를 사용해서 조회해 보면 이미 3개의 프로퍼티에 대한 값만 지정되어 있음

class Customer: Object {
    
    @objc dynamic var idx = 0
    @objc dynamic var name = "무명"
    @objc private dynamic var privateType: Int = CustomerType.active.rawValue
    let products = List<Product>()
}

• 여기에 name을 추가하게 되면 기존에 생성된 Customer 객체는 name이 없기 때문에 에러가 발생함
• error 를 확인하면 "Migration is required due to the following errors: Property 'customer.name' has been added 

class AppDelegate: UIResponder, UIApplicationDelegate {
    func applicationDidFinishLaunching(_ application: UIApplication) {
        
    }
}

• 앱이 실행 된 후 초기 작업을 위해 AppDelegate에서 applicationDidFinishLauncing에서 작성

    func applicationDidFinishLaunching(_ application: UIApplication) {
        let configuration = Realm.Configuration(schemaVersion: 2) { migration, oldSchemaVersion in
            migration.enumerateObjects(ofType: Customer.className()) { oldObject, newObject in
                print(oldObject ?? "없음")
                newObject!["name"] = "무명"
            }
        }
        
        Realm.Configuration.defaultConfiguration = configuration
    }

한 줄씩 살펴 보면,

Realm.Configuration(schemaVersion: 2)

• 현재 스키마 버전을 설정해 줄 수 있음

        let configuration = Realm.Configuration(schemaVersion: 2) { migration, oldSchemaVersion in

        }

• migrationBlock에는 migration과 이전 스키마 버전을 전달 받을 수 있음

            migration.enumerateObjects(ofType: Customer.className()) { oldObject, newObject in
                print(oldObject ?? "없음")
                newObject!["name"] = "무명"
            }

• 마이그레이션을 위한 객체의 클레스 이름을 전달하면 블록에서 이전 마이그레이션 전 오브젝트를 얻을 수 있음(기존에 있던 값을 통해 조합하여 새로운 필드의 값을 만들어 주어야 할 때 사용 가능)
• newObject에서 필드이름을 키값으로 하여, 이번 버전에 새로 생성된 필드의 값을 지정해 줄 수 있음

Realm.Configuration.defaultConfiguration = configuration

• 꼭 변경된 configuration객체를 Realm.Configuration의 defaultConfiguration으로 지정해야 함

• RealmStudio에서 name필드가 생성된 것을 확인 할 수 있음

 

출처 : Realm 홈페이지