SwiftUI中如何在App与WidgetBundle目标间共享ModelContainer实例？

问题背景 #

在SwiftUI开发中，尝试通过StorageController管理ModelContainer全局实例，注入到主App和WidgetBundle两个独立目标中，期望共享同一数据库实现数据同步。但日志显示两者生成了不同的default.store文件：

主App的存储路径：

file:///Users/username/Library/Developer/CoreSimulator/Devices/99106351-788D-4605-A5E6-475AD73ED05C/data/Library/Application%20Support/default.store

WidgetBundle的存储路径：

file:///Users/username/Library/Developer/CoreSimulator/Devices/99106351-788D-4605-A5E6-475AD73ED05C/data/Containers/Data/Application/7465C92B-AC5A-4AB0-BA68-2EEB78C16A38/Library/Application%20Support/default.store

原实现代码如下：

// StorageController.swift
@MainActor
public static var globalInstance: StorageController = StorageController()

let modelContainer: ModelContainer
let modelContext: ModelContext

@MainActor
init() {
  do {
    let schema = Schema([
      Item.self,
    ])
    let config = ModelConfiguration(schema: schema, isStoredInMemoryOnly: false)
    modelContainer = try ModelContainer(for: schema, configurations: config)
    modelContext = modelContainer.mainContext
    Logger().info("init modelContainer")

    guard let urlApp = FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask).last else { return }
    let url = urlApp.appendingPathComponent("default.store")
    if FileManager.default.fileExists(atPath: url.path) {
      Logger().info("swiftdata db at \(url.absoluteString)")
    } else {
      Logger().warning("can't find swiftdata db")
    }
  } catch {
    fatalError("Could not initialize ModelContainer")
  }
}

// MyWidgetExtentionBundle.swift
@main
struct MyWidgetExtentionBundle: WidgetBundle {
  @MainActor
  init() {
    Logger().info("MyWidgetExtentionBundle init")
    let sc = StorageController.globalInstance

    AppDependencyManager.shared.add(dependency: sc)
  }

  var body: some Widget {
    MyWidgetExtention()
  }
}

// AppIntentsInWidgetExtentionApp.swift
@main
struct AppIntentsInWidgetExtentionApp: App {
  @State
  private var storageController: StorageController

  init() {
    let sc = StorageController.globalInstance
    storageController = sc
  }

  var body: some Scene {
    WindowGroup {
      VStack {
        Text("Total item cnt:\(storageController.fetchItems().count)")
        Button("Add Item") {
          storageController.addItem(name: "Item-\(UUID().uuidString)")
        }
      }
    }
  }
}

核心原因 #

主App和WidgetExtension属于不同的沙盒容器，默认的applicationSupportDirectory路径不共享，因此各自创建了独立的数据库文件。要实现共享，必须通过App Group配置共享存储容器，并让两者的ModelContainer指向同一文件路径。

正确实现步骤 #

1. 配置App Group #

• 打开Xcode，选中主App目标，进入Signing & Capabilities标签
• 点击+ Capability，添加App Groups
• 创建或选择一个共享组ID（格式如group.com.yourdomain.yourapp），勾选该组
• 重复上述操作，给WidgetExtension目标添加相同的App Group

2. 修改StorageController，指定共享存储路径 #

修改StorageController的初始化方法，将数据库路径指向App Group的共享容器：

@MainActor
public static var globalInstance: StorageController = StorageController()

let modelContainer: ModelContainer
let modelContext: ModelContext

@MainActor
init() {
  do {
    let schema = Schema([Item.self])
    // 获取App Group共享容器URL
    guard let groupContainerURL = FileManager.default.containerURL(
      forSecurityApplicationGroupIdentifier: "group.com.yourdomain.yourapp"
    ) else {
      fatalError("无法获取App Group共享容器路径")
    }
    let storeURL = groupContainerURL.appendingPathComponent("default.store")
    
    // 使用自定义路径初始化ModelConfiguration
    let config = ModelConfiguration(
      schema: schema,
      url: storeURL,
      isStoredInMemoryOnly: false
    )
    
    modelContainer = try ModelContainer(for: schema, configurations: config)
    modelContext = modelContainer.mainContext
    Logger().info("ModelContainer 初始化完成，路径：\(storeURL.absoluteString)")
  } catch {
    fatalError("初始化ModelContainer失败：\(error.localizedDescription)")
  }
}

3. 验证共享效果 #

重新运行主App和Widget，查看日志会发现两者的数据库路径完全一致，此时添加或修改数据后，App和Widget将同步访问同一数据库。

注意事项 #

• 确保主App和WidgetExtension的App Group ID完全一致
• WidgetExtension作为扩展，需要确保其签名配置与主App匹配，有权限访问App Group
• 若之前已有数据，需要考虑迁移原数据库到共享路径（可选，根据业务需求处理）

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