为什么分阶段迁移不适用于我的应用程序？

Question

我在 WWDC23、CoreData 文档和其他与分阶段迁移相关的帖子中提到了“Core Data 的新增功能”。

我通过 MyAppDataModel 添加了三个新模型版本，使用哈希修饰符进行版本控制。

（因为它导致任何版本都有相同版本校验和的错误->“当前模型引用和下一个模型引用不能相等”）

V2>： 我在 MyAppDataModel 中将 dateInTime 属性添加到 Book Entity 作为 LightweightMigration。

V3>： 我想将 dateInTime 属性设置为 Date 类型值，这是通过将 date 属性从 String 类型更改为 Date 类型来实现的。 然后想将日期属性设置为nil。

据我所知，一旦 NSStageMigrationManager 设置为 persistenceStoreDescription 的选项，并且只需调用 permanentContainer.loadPersistentStore，分阶段迁移就会起作用。 但我的分阶段迁移不起作用...

我想知道我的代码是否有问题。 如有机会，如果您需要更多有关我的情况的信息，请告诉我！

        guard let packageURL = Bundle.main.url(forResource: "MyAppDataModel", withExtension: ".momd") else {
            fatalError("Failed to find file matched with name")
        }
        let v1ModelURL = packageURL.appending(component: "MyDataModel.mom")
        let v2ModelURL = packageURL.appending(component: "MyDataModel 2.mom")
        let v3ModelURL = packageURL.appending(component: "MyDataModel 3.mom")
        
        guard let v1Model = NSManagedObjectModel(contentsOf: v1ModelURL),
              let v2Model = NSManagedObjectModel(contentsOf: v2ModelURL),
              let v3Model = NSManagedObjectModel(contentsOf: v3ModelURL) else {
            fatalError("Failed to find model related to the URL")
        }
        
        let v1ModelReference = NSManagedObjectModelReference(model: v1Model, versionChecksum: v1Model.versionChecksum)
        let v2ModelReference = NSManagedObjectModelReference(model: v2Model, versionChecksum: v2Model.versionChecksum)
        let v3ModelReference = NSManagedObjectModelReference(model: v3Model, versionChecksum: v3Model.versionChecksum)
        
        let v1ToV2 = NSCustomMigrationStage(migratingFrom: v1ModelReference, to: v2ModelReference)
        // OR let v1ToV2 = NSLightweightMigrationStage([v1Model.versionChecksum])
        v1ToV2.label = "V1 to V2: Add dateInTime attribute"
        let v2ToV3 = NSCustomMigrationStage(migratingFrom: v2ModelReference, to: v3ModelReference)
        customStage.label = "V2 to V3: Change date attribute type for all entities"

        customStage.willMigrateHandler = { migrationManager, currentStage in
            guard let container = migrationManager.container else {
                fatalError("Failed to otionalize container")
            }
            
            let context = container.newBackgroundContext()
            context.performAndWait {
                let fetchRequest = NSFetchRequest<NSManagedObject>(entityName: "Book")
                fetchRequest.predicate = NSPredicate(format: "date != nil")
                
                do {
                    var fetchedResults: [NSManagedObject]
                    fetchedResults = try context.fetch(fetchRequest)
                    
                    for book in fetchedResults {
                        guard let dateWithStringType = book.value(forKey: "date") as? String else {
                            fatalError("Failed to Cast as String")
                        }
                        let formatter = DateFormatter()
                        formatter.dateFormat = "yyyy.MM.dd E"
                        guard let dateWithDateType = formatter.date(from: dateWithStringType) else {
                            fatalError("Failed to parse as Date")
                        }
                        book.setValue(dateWithDateType, forKey: "dateInTime")
                        book.setValue(nil, forKey: "date")
                        
                    }
                    try context.save()
                } catch {
                    fatalError("Failed to Fetch Or Save: \(error.localizedDescription)")
                }
            }
        }
        
        let migrationManager = NSStagedMigrationManager([v1ToV2, v2ToV3])
        let persistentContainer = NSPersistentContainer(name: "MyAppDataModel")
        
        guard let storeDescription = persistentContainer.persistentStoreDescriptions.first else {
            fatalError("Failed to get a first desciption")
        }
        storeDescription.setOption(migrationManager, forKey: NSPersistentStoreStagedMigrationManagerOptionKey)
        
        persistentContainer.loadPersistentStores { description, error in
            if let error = error {
                fatalError("Failed to load persistent store: \(error.localizedDescription)")
            }
        }

Answer 1

您的设置看起来正确，但经过几次查看后，我可以看到一些可能是罪魁祸首的地方，或者添加日志记录以帮助调试情况的地方。

首先，我想指出您所做的非常正确的事情--

let v1ToV2 = NSCustomMigrationStage(migratingFrom: v1ModelReference, to: v2ModelReference)
// OR let v1ToV2 = NSLightweightMigrationStage([v1Model.versionChecksum])
v1ToV2.label = "V1 to V2: Add dateInTime attribute"

在我的测试中，我发现

NSLightweightMigrationStage

令人困惑和沮丧。没有

NSCustomMigrationStage(migratingFrom:to:)

或

willMigrateHandler

的

didMigrateHandler

与轻量级迁移阶段相同，但您可以明确声明“From”和“To”版本。

NSLightweightMigrationStage

的 init 函数没有很好的文档来告诉我们它是如何工作的，所以我完全避免使用它。

NSCustomMigrationStage

进行轻量级和自定义迁移，所以我想说坚持下去。

现在，到一些可能导致迁移失败的原因的地方：

1 - 获取请求：

fetchRequest.predicate = NSPredicate(format: "date != nil")

我一开始没有注意到这一点，但

NSPredicate

格式的工作方式可能会让你感到困惑。试试这个：

fetchRequest.predicate = NSPredicate(format: "%K != nil", #keyPath(Book.date))

2 - NSPersistentStoreDescription 设置

这可能不是问题所在，但仔细检查一下也没什么坏处。

// you already have this:
storeDescription.setOption(migrationManager, forKey: NSPersistentStoreStagedMigrationManagerOptionKey)
// but you could try adding these:
storeDescription.shouldMigrateStoreAutomatically = true
storeDescription.shouldInferMappingModelAutomatically = true

我认为默认情况下这些额外选项是

true

，但我喜欢明确添加它们以防万一。我认为它们对于分阶段迁移的发生是必要的。

3 - 添加大量日志记录！

无论问题的原因是什么，找出问题所在的一个好方法是进行更多的登录，以查看发生了什么和没有发生什么。

首先，我会在

willMigrateHandler

的最开头放置至少一个日志语句，以确保它正在执行。

fatalError

语句可以很好地确保所需变量存在，但您还想确保调用整个函数。

其次，在执行获取请求后放置一些日志语句以查看是否返回任何结果。获取请求可能获得零结果，这肯定会导致您注意到的行为（什么也没有发生！）。

第三，在

for

循环结束时，也许只需在其中放一个日志即可查看这本书是什么以及日期设置为多少。

这就是我现在所拥有的一切。我的钱在

NSPredicate

上，但我不确定。在更改谓词之前值得尝试日志记录语句，看看是否可以找到问题实际发生的位置。

祝你好运！

PS：小效率指针，同样 - 将

DateFormatter

移到

for

循环之外，这样你就不会为每本书创建一个新的，或者使用 FormatStyle。为每本书创建一个新的

DateFormatter

是一项昂贵且不必要的操作。