如何将现有SwiftData迁移至App Group并保留原有数据？

问题根源 #

SwiftData默认将数据存储在应用私有沙盒的容器中，当配置App Group实现数据共享后，新的SwiftData会切换到App Group的共享容器路径，自然无法读取旧沙盒里的历史数据。

迁移步骤 #

1. 保证数据模型完全一致 #

先确认新的SwiftData模型和旧版本完全匹配——实体名称、属性、关系一个都不能改，否则迁移时会直接出现模型不匹配的错误。

2. 启动时检测并迁移旧数据 #

在App启动阶段，先检查旧沙盒里的SwiftData存储文件是否存在，若存在则将其复制到App Group的共享容器中，之后再初始化SwiftData栈。

核心代码实现

首先获取旧存储路径和新的共享容器路径：

import SwiftData

// 获取旧私有沙盒中的SwiftData存储路径
private func oldStoreURL() -> URL? {
    let appSupportDir = FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask).first!
    // 替换为你实际的SwiftData容器名称（默认与模型容器初始化名称一致）
    let oldStorePath = appSupportDir.appending(path: "com.apple.CoreData.Stack.NSPersistentContainer/ModelContainer.sqlite")
    return FileManager.default.fileExists(atPath: oldStorePath.path()) ? oldStorePath : nil
}

// 获取App Group共享容器的存储路径
private func newGroupStoreURL() -> URL {
    let groupID = "group.your.app.bundle.id" // 替换为你的App Group ID
    let groupContainer = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: groupID)!
    let appSupportDir = groupContainer.appending(path: "Application Support")
    // 确保目录存在，避免创建文件时出错
    try? FileManager.default.createDirectory(at: appSupportDir, withIntermediateDirectories: true)
    return appSupportDir.appending(path: "ModelContainer.sqlite")
}

然后在App初始化时执行迁移检查：

@main
struct YourApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .modelContainer(for: YourModel.self) {
            migrateOldDataIfNeeded()
        }
    }
    
    private func migrateOldDataIfNeeded() {
        guard let oldSQLiteURL = oldStoreURL(),
              let newSQLiteURL = newGroupStoreURL().asURL(),
              !FileManager.default.fileExists(atPath: newSQLiteURL.path()) else {
            // 旧数据不存在或新数据已存在，直接跳过迁移
            return
        }
        
        // 必须同步复制WAL和SHM辅助文件，否则数据会不完整
        let oldWalURL = oldSQLiteURL.deletingLastPathComponent().appending(path: "ModelContainer.sqlite-wal")
        let oldShmURL = oldSQLiteURL.deletingLastPathComponent().appending(path: "ModelContainer.sqlite-shm")
        let newWalURL = newSQLiteURL.deletingLastPathComponent().appending(path: "ModelContainer.sqlite-wal")
        let newShmURL = newSQLiteURL.deletingLastPathComponent().appending(path: "ModelContainer.sqlite-shm")
        
        do {
            // 复制主数据库文件
            try FileManager.default.copyItem(at: oldSQLiteURL, to: newSQLiteURL)
            // 复制WAL文件（如果存在）
            if FileManager.default.fileExists(atPath: oldWalURL.path()) {
                try FileManager.default.copyItem(at: oldWalURL, to: newWalURL)
            }
            // 复制SHM文件（如果存在）
            if FileManager.default.fileExists(atPath: oldShmURL.path()) {
                try FileManager.default.copyItem(at: oldShmURL, to: newShmURL)
            }
            print("旧数据迁移成功")
        } catch {
            print("迁移失败: \(error.localizedDescription)")
        }
    }
}

3. 配置SwiftData使用App Group路径 #

初始化ModelContainer时，明确指定共享容器的存储路径，避免使用默认的私有沙盒路径：

func makeModelContainer() throws -> ModelContainer {
    let schema = Schema([YourModel.self])
    let storeURL = newGroupStoreURL()
    let config = ModelConfiguration(schema: schema, url: storeURL)
    return try ModelContainer(for: schema, configurations: config)
}

注意事项 #

• 迁移操作仅需执行一次，务必判断新路径是否已有数据，避免重复复制导致数据冲突。
• 测试时需模拟用户更新场景：先安装旧版本存储数据，再安装新版本，确认数据正常迁移。
• 若存在模型版本变更，需先完成模型版本迁移，再执行文件复制操作，否则会导致数据损坏。

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