如何正确合并Swift Package内的Core Data模型与主应用模型

我有一个独立Swift Package，内部自带Core Data模型，可在Package内部正常访问。目前我希望在主应用中访问、修改该Package内的Core Data数据。

参考相关技术方案，我尝试将两个模型合并为一个，但多次尝试均未成功，我使用的合并代码如下：

let bundle1 = Bundle(for: EntityFromPackage.self)
let bundle2 = Bundle(for: EntityFromApp.self)

let model = NSManagedObjectModel.mergedModel(from: [bundle1, bundle2])!
container = PersistentContainer(name: "Database", managedObjectModel: model)

执行后确实生成了Database.sqlite文件，但文件中仅包含主应用Core Data对应的表，没有Package内模型对应的表。

我当前初始化Package内Core Data栈的代码如下：

let modelURL = Bundle.module.url(forResource:"Package", withExtension: "momd")
let model = NSManagedObjectModel(contentsOf: modelURL!)
container = NSPersistentContainer(name: "Package", managedObjectModel: model!)

之后我在应用初始化阶段调用了PackagePersistenceController.shared。

但当我在主应用中使用FetchRequest查询数据时，会收到如下报错：

"The fetch request's entity xxx 'Entity' appears to be from a different NSManagedObjectModel than this context's"

我不清楚上述第一段合并模型的代码存在什么问题导致合并失败，希望得到解决方案。

你的问题由两个核心错误导致，按以下步骤修复即可：

• 合并模型时不要依赖NSManagedObjectModel.mergedModel(from:)的自动扫描逻辑
  该方法只会扫描传入bundle根目录下的mom/momd文件，Swift Package的资源通常存放在bundle的嵌套子目录中，自动扫描无法识别到Package内的模型文件，这就是你合并后只有主App表的直接原因。
• 不要同时维护两套独立的Core Data栈
  你既在主App侧初始化了基于合并模型的Database持久化容器，又在Package内初始化了独立的Package持久化容器，两个容器使用的NSManagedObjectModel实例完全独立，实体校验信息不匹配，跨容器查询必然触发模型不匹配的报错。

具体修复步骤 #

1. 删除Package内独立创建持久化容器的逻辑，不要在Package侧单独初始化Core Data栈，全App只保留一套持久化容器。
2. 手动加载两个模块的Core Data模型后再合并，避免自动扫描漏加载资源。
   首先在Swift Package侧暴露公开的模型获取方法，避免主App侧找不到Package的Bundle路径：

   // 放在Package内的公开代码文件中
   public extension NSManagedObjectModel {
       static let packageModel: NSManagedObjectModel = {
           guard let modelURL = Bundle.module.url(forResource: "Package", withExtension: "momd"),
                 let model = NSManagedObjectModel(contentsOf: modelURL) else {
               fatalError("Failed to load Package Core Data model")
           }
           return model
       }()
   }
   

   然后在主App侧加载主App自身的模型，和Package的模型手动合并后初始化唯一的持久化容器：

   // 主App侧Core Data栈初始化代码
   // 1. 加载主App的Core Data模型，替换"AppModel"为你主App的xcdatamodeld文件名
   guard let appModelURL = Bundle.main.url(forResource: "AppModel", withExtension: "momd"),
         let appModel = NSManagedObjectModel(contentsOf: appModelURL) else {
       fatalError("Failed to load App Core Data model")
   }
   
   // 2. 手动合并两个模型
   let mergedModel = NSManagedObjectModel(byMerging: [appModel, .packageModel])
   
   // 3. 用合并后的模型初始化唯一的持久化容器
   let container = NSPersistentContainer(name: "Database", managedObjectModel: mergedModel)
   container.loadPersistentStores(completionHandler: { (storeDescription, error) in
       if let error = error as NSError? {
           fatalError("Core Data store load failed: \(error), \(error.userInfo)")
       }
   })
   

3. 卸载手机/模拟器上的旧App，清除之前生成的不兼容的sqlite文件，重新运行即可。

注意事项 #

• 全App所有Core Data读写操作、FetchRequest都必须使用这一个基于合并模型创建的容器的viewContext/backgroundContext，不能再使用Package内之前单独创建的容器实例。
• 如果后续需要做Core Data轻量迁移，直接在合并模型的基础上配置迁移选项即可，不需要单独处理Package侧的模型。

内容的提问来源于stack exchange，提问作者Astro