NSKeyedArchiver 并在目标之间共享自定义类

Question

我的应用使用自定义类作为其数据模型：

class Drug: NSObject, NSCoding {
    // Properties, methods etc...
}

我刚刚创建了一个 Today 扩展，需要从中访问用户的数据，所以我使用 NSCoding 将我的数据保存在应用容器和共享容器中。这些是主应用程序中的保存和加载功能：

func saveDrugs() {
    // Save to app container
    let isSuccessfulSave = NSKeyedArchiver.archiveRootObject(drugs, toFile: Drug.ArchiveURL.path)
    if isSuccessfulSave {
        print("Drugs successfully saved locally")
    } else {
        print("Error saving drugs locally")
    }

    // Save to shared container for extension
    let isSuccessfulSaveToSharedContainer = NSKeyedArchiver.archiveRootObject(drugs, toFile: Drug.SharedArchiveURL.path)
    if isSuccessfulSaveToSharedContainer {
        print("Drugs successfully saved to shared container")
    } else {
        print("Error saving drugs to shared container")
    }
}

func loadDrugs() -> [Drug]? {
    return NSKeyedUnarchiver.unarchiveObject(withFile: Drug.ArchiveURL.path) as? [Drug]
}

我遇到了类命名空间问题，我的 Today 扩展中的 NSKeyedUnarchiver 无法正确解码对象，所以我使用了this answer 并在类定义前添加了@objc：

@objc(Drug)
class Drug: NSObject, NSCoding {
    // Properties, methods etc...
}

这完美地解决了这个问题。但是，这将是我的应用程序的 1.3 版，这似乎破坏了预先存在的数据的取消归档过程（我认为它可能会这样）。

处理这种情况最好的方法是什么，好像我只是做了这个改变，新版本的应用程序会为现有用户崩溃！

我找不到任何其他答案，我不确定NSKeyedArchiver.setClass() 方法是否相关，也不确定在哪里使用它。

我们将不胜感激地接受任何帮助。谢谢。

Answer 1

这正是NSKeyedUnarchiver.setClass(_:forClassName:) 的用例——您可以通过关联当前类的旧名称来向前迁移旧类：

let unarchiver = NSKeyedUnarchiver(...)
unarchiver.setClass(Drug.self, forClassName: "myApp.Drug")
// unarchive as appropriate

或者，您可以提供一个符合 NSKeyedUnarchiverDelegate 的委托并提供一个 unarchiver(_:cannotDecodeObjectOfClassName:originalClasses:)，但这对于这种情况可能有点过头了。

---

请记住，这适用于向前迁移旧数据。如果您有更新版本的应用程序需要将数据发送到旧版本的应用程序，您需要在存档方面做类似的事情 - 继续使用 NSKeyedArchiver.setClassName(_:for:) 使用旧名称对新类进行编码：

let archiver = NSKeyedArchiver(...)
archiver.setClassName("myApp.Drug", for: Drug.self)
// archive as appropriate

如果您遇到此向后兼容性问题，那么很遗憾，只要有旧版本应用的用户，您可能需要继续使用旧名称。