|
| 1 | +--- |
| 2 | +title: Core Data를 활용한 Data Migration |
| 3 | +description: Core Data에서 데이터 모델 변경 시 활용할 수 있는 마이그레이션 방법에 대해 알아봅니다. |
| 4 | +author: bbdyno |
| 5 | +date: 2025-02-24 21:52:00 +0900 |
| 6 | +categories: [Development, iOS] |
| 7 | +tags: [CoreData, datamigration, ios, Swift, 개발, 데이터마이그레이션, 마이그레이션, 코어데이터] |
| 8 | +pin: true |
| 9 | +math: true |
| 10 | +mermaid: true |
| 11 | +--- |
| 12 | +Core Data에서는 경량 마이그레이션(Lightweight Migration)과 무거운 마이그레이션(Heavyweight Migration)을 지원하며, 복잡한 마이그레이션을 위해 매핑 모델(Mapping Model)을 활용할 수도 있습니다. |
| 13 | + |
| 14 | +## 1. Core Data 마이그레이션 개요 |
| 15 | +데이터 모델이 변경되면 기존 데이터를 새로운 데이터 모델에 맞게 변환해야 합니다. Core Data는 이를 자동으로 처리할 수 있도록 다양한 마이그레이션 전략을 제공합니다. |
| 16 | + |
| 17 | +### 마이그레이션이 필요한 상황 |
| 18 | +- 엔터티(Entity) 이름 변경 |
| 19 | +- 속성(Attribute) 추가/삭제 |
| 20 | +- 관계(Relationship) 변경 |
| 21 | +- 데이터 변환이 필요한 경우 |
| 22 | + |
| 23 | +## 2. 경량 마이그레이션 (Lightweight Migration) |
| 24 | +경량 마이그레이션은 Core Data가 자동으로 수행하는 방식으로, 비교적 단순한 변경 사항이 있을 때 사용됩니다. |
| 25 | + |
| 26 | +### 지원하는 변경 사항 |
| 27 | +- 속성 추가 및 삭제 |
| 28 | +- 속성의 기본값 변경 |
| 29 | +- 관계 추가 및 삭제 |
| 30 | +- 엔터티 추가 |
| 31 | + |
| 32 | +### 설정 방법 |
| 33 | +#### 1) 새로운 데이터 모델 버전 생성 |
| 34 | +Xcode에서 `.xcdatamodeld` 파일을 열고 **Editor > Add Model Version**을 선택하여 새로운 모델 버전을 추가합니다. |
| 35 | + |
| 36 | +#### 2) 코드에서 자동 마이그레이션 활성화 |
| 37 | + |
| 38 | +```swift |
| 39 | +let container = NSPersistentContainer(name: "MyApp") |
| 40 | +if let description = container.persistentStoreDescriptions.first { |
| 41 | + description.shouldMigrateStoreAutomatically = true |
| 42 | + description.shouldInferMappingModelAutomatically = true |
| 43 | +} |
| 44 | + |
| 45 | +container.loadPersistentStores { (storeDescription, error) in |
| 46 | + if let error = error { |
| 47 | + fatalError("Unresolved error \(error)") |
| 48 | + } |
| 49 | +} |
| 50 | +``` |
| 51 | + |
| 52 | +이렇게 설정하면 Core Data가 변경 사항을 자동으로 감지하고 데이터를 마이그레이션합니다. |
| 53 | + |
| 54 | +## 3. 무거운 마이그레이션 (Heavyweight Migration) |
| 55 | +경량 마이그레이션이 불가능한 경우 수동 마이그레이션을 수행해야 합니다. 예를 들어 다음과 같은 변경 사항이 있는 경우 무거운 마이그레이션이 필요합니다. |
| 56 | + |
| 57 | +### 무거운 마이그레이션이 필요한 경우 |
| 58 | +- 속성 타입 변경 |
| 59 | +- 엔터티 이름 변경 |
| 60 | +- 복잡한 데이터 변환 |
| 61 | + |
| 62 | +### 수동 마이그레이션 과정 |
| 63 | + |
| 64 | +#### 1) 매핑 모델(Mapping Model) 생성 |
| 65 | +**File > New > Data Model Mapping Model**을 선택하여 `.xcmappingmodel` 파일을 생성합니다. |
| 66 | + |
| 67 | +#### 2) 매핑 규칙 정의 |
| 68 | +매핑 모델에서 소스 모델과 타겟 모델을 설정하고 속성 변환 규칙을 추가합니다. |
| 69 | + |
| 70 | +#### 3) 마이그레이션 코드 작성 |
| 71 | + |
| 72 | +```swift |
| 73 | +let sourceURL = URL(fileURLWithPath: "sourcePath") |
| 74 | +let destinationURL = URL(fileURLWithPath: "destinationPath") |
| 75 | + |
| 76 | +if let mappingModel = NSMappingModel(from: nil, forSourceModel: sourceModel, destinationModel: destinationModel) { |
| 77 | + let migrationManager = NSMigrationManager(sourceModel: sourceModel, destinationModel: destinationModel) |
| 78 | + |
| 79 | + do { |
| 80 | + try migrationManager.migrateStore( |
| 81 | + from: sourceURL, |
| 82 | + sourceType: NSSQLiteStoreType, |
| 83 | + options: nil, |
| 84 | + with: mappingModel, |
| 85 | + toDestinationURL: destinationURL, |
| 86 | + destinationType: NSSQLiteStoreType, |
| 87 | + destinationOptions: nil |
| 88 | + ) |
| 89 | + } catch { |
| 90 | + print("Migration failed: \(error)") |
| 91 | + } |
| 92 | +} |
| 93 | +``` |
| 94 | + |
| 95 | +## 4. 데이터 마이그레이션 시 발생할 수 있는 문제와 해결 방법 |
| 96 | + |
| 97 | +### 마이그레이션 실패 원인 및 해결 방법 |
| 98 | + |
| 99 | +| 실패 원인 | 해결 방법 | |
| 100 | +|-----------|----------| |
| 101 | +| 모델 변경 감지 실패 | `shouldInferMappingModelAutomatically = true` 설정 | |
| 102 | +| SQLite 파일 손상 | 기존 스토어 삭제 후 새로 생성 또는 백업 후 복원 | |
| 103 | +| 매핑 모델 오류 | `.xcmappingmodel` 수정 및 매핑 규칙 재정의 | |
| 104 | + |
| 105 | +## 5. 예제 프로젝트 |
| 106 | + |
| 107 | +### 경량 마이그레이션 예제 |
| 108 | +데이터 모델이 다음과 같이 변경되었다고 가정합니다. |
| 109 | + |
| 110 | +#### 변경 전: |
| 111 | +```swift |
| 112 | +class User: NSManagedObject { |
| 113 | + @NSManaged var name: String |
| 114 | +} |
| 115 | +``` |
| 116 | + |
| 117 | +#### 변경 후: |
| 118 | +```swift |
| 119 | +class User: NSManagedObject { |
| 120 | + @NSManaged var name: String |
| 121 | + @NSManaged var age: Int16 |
| 122 | +} |
| 123 | +``` |
| 124 | + |
| 125 | +위처럼 속성을 추가하는 변경은 경량 마이그레이션으로 처리할 수 있습니다. Xcode에서 자동으로 마이그레이션을 활성화하면 됩니다. |
| 126 | + |
| 127 | +### 무거운 마이그레이션 예제 |
| 128 | +만약 `name` 속성의 타입이 `String`에서 `Data`로 변경되었다면 무거운 마이그레이션이 필요합니다. |
| 129 | + |
| 130 | +이 경우 매핑 모델을 사용하여 변환해야 합니다. |
| 131 | + |
| 132 | +#### 변환 로직 구현: |
| 133 | +```swift |
| 134 | +class NameToDataTransformer: ValueTransformer { |
| 135 | + override func transformedValue(_ value: Any?) -> Any? { |
| 136 | + guard let string = value as? String else { return nil } |
| 137 | + return string.data(using: .utf8) |
| 138 | + } |
| 139 | +} |
| 140 | +``` |
| 141 | + |
| 142 | +이제 `NSMigrationManager`를 사용하여 직접 마이그레이션을 실행할 수 있습니다. |
| 143 | + |
| 144 | +## 마무리 |
| 145 | +Core Data 마이그레이션은 데이터 모델이 변경될 때 필수적으로 고려해야 하는 요소입니다. 경량 마이그레이션은 자동으로 수행되지만, 복잡한 변경이 있는 경우 무거운 마이그레이션을 수행해야 합니다. 특히 매핑 모델을 활용하면 보다 세밀한 마이그레이션이 가능합니다. |
| 146 | + |
| 147 | +데이터 모델 변경이 필요할 경우 미리 마이그레이션 전략을 수립하여 원활한 데이터 이전을 보장하는 것이 중요합니다. |
0 commit comments