在 Swift 中访问共享容器中的自定义对象

Access custom object in shared container in Swift

我正在制作一个自定义键盘,我想在容器应用程序中构建一个资产(特别是一个 trie 字典),然后在键盘扩展通过共享容器启动时访问它。为此,我从这个相当基本的 class:

开始
class Person: NSObject, NSCoding {
    let name: String
    let age: Int
    init(name: String, age: Int) {
        self.name = name
        self.age = age
    }
    required init(coder decoder: NSCoder) {
        self.name = decoder.decodeObject(forKey: "name") as? String ?? ""
        self.age = decoder.decodeInteger(forKey: "age")
    }

    func encode(with coder: NSCoder) {
        coder.encode(name, forKey: "name")
        coder.encode(age, forKey: "age")
    }
}

太棒了。我已经设置了我的共享容器,并且在容器应用程序 ViewController 的 viewDidLoad 函数中我加载了共享容器(一些测试变量和自定义对象):

    let shared = UserDefaults(suiteName: "group.test_keyboard")
    shared!.set("test", forKey:"key_string")
    shared!.set(false, forKey:"key_boolean")
    shared!.set(34, forKey:"key_int")

    let newPerson = Person(name: "Joe", age: 10)
    let encodedData = NSKeyedArchiver.archivedData(withRootObject: newPerson)
    shared!.set(encodedData, forKey: "people")

为了测试它,我将以下代码添加到 viewWillAppear:

    let shared = UserDefaults(suiteName: "group.test_keyboard")
    let test_string = shared?.string(forKey: "key_string")

    if(test_string != nil){
        print("string-\(test_string!)")
    }
    else{
        print("nil")
    }

    // retrieving a value for a key
    if let data = shared?.data(forKey: "people"){
        let test_person = NSKeyedUnarchiver.unarchiveObject(with: data) as? Person
        print("-\(test_person!.name)")  // Joe

        let data_size = String(data.count)
        print("-\(data_size)")

    } else {
        print("There is an issue")
    }

一切正常。但是当我进入键盘 ViewController 并尝试访问内容时,检索简单的字符串工作正常:

    let shared = UserDefaults(suiteName: "group.test_keyboard")
    shared?.synchronize()
    let test_string = shared?.string(forKey: "key_string")

    if(test_string != nil){
        (textDocumentProxy as UIKeyInput).insertText(test_string!)
    }
    else{
        (textDocumentProxy as UIKeyInput).insertText("nil")
    }

但是如果我尝试访问自定义对象 Person,那么:

    if let data = shared?.data(forKey: "people") {
        (textDocumentProxy as UIKeyInput).insertText("found")

        (textDocumentProxy as UIKeyInput).insertText(String(data.count))

        let myPeople = NSKeyedUnarchiver.unarchiveObject(with: data) as? Person

    }

我遇到以下错误响应时崩溃:

2017-05-10 14:34:46.938253-0700 test_keyboard[3196:857207] viewServiceDidTerminateWithError:: Error Domain=_UIViewServiceInterfaceErrorDomain Code=3 "(null)" UserInfo={Message=Service Connection Interrupted}

数据在那里,如果我做一个简单的 data.count 检查两边它的大小相同 (269)。如果我注释掉 NSKeyedUnarchiver 行,就没有问题,所以我确定这就是问题所在。到底发生了什么导致它在容器应用程序中正常工作时在键盘扩展程序中崩溃?

很有可能是运行在不同模块中的问题。您的应用程序是与扩展不同的模块,完全限定的 class 名称包含模块名称。在应用程序中它类似于 AppName.Person,但在扩展程序中它类似于 KeyboardExt.PersonNSCoding 无法匹配,所以它 barfs。

有几个解决方法。一种是创建一个应用程序和扩展程序都使用的框架,并将共享 class 放在那里。那么带有模块的名称将始终类似于“FrameworkName.Person”,一切都会起作用。

另一种是专门告诉(un)archive 进程为class 使用什么名称。然后它会写入您指定的名称并将其匹配到适当的 class。在写入任何数据之前,做一些类似

的事情
NSKeyedArchiver.setClassName("Person", for: Person.self)

然后在读取任何数据之前,做相反的事情:

NSKeyedUnarchiver.setClass(Person.self, forClassName: "Person")