NSUserDefaults:以可读格式存储仅具有属性列表兼容类型的结构/类

时间:2019-01-27 16:12:42

标签: swift nsuserdefaults plist codable

假设根据以下代码将字典存储在UserDefaults中:

UserDefaults.standard.set(["name": "A preset", "value": 1], forKey: "preset")

运行此命令所产生的plist是:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>preset</key>
    <dict>
        <key>name</key>
        <string>A preset</string>
        <key>value</key>
        <integer>1</integer>
    </dict>
</dict>
</plist>

现在,考虑此数据应由以下结构表示:

struct Preset: Codable {
    var name: String
    var value: Int
}

我想调用以下代码并获得与上述相同的结果(数据使用完全相同的布局存储在plist中):

UserDefaults.standard.set(Preset(name: "A preset", value: 1), forKey: "preset")

不幸的是,这会导致错误:

Attempt to set a non-property-list object
TableViewToUserDefaults.Preset(name: "A preset", value: 1)
as an NSUserDefaults/CFPreferences value for key preset

在保持相同的plist布局的情况下(如果可以的话)如何实现? (即一种适用于由可在plist中编码的属性组成的任何结构的代码,而无需硬编码该结构的属性,例如namevalue

3 个答案:

答案 0 :(得分:1)

您可以采用一种面向协议的方式来解决您的问题。

protocol UserDefaultStorable: Codable {
  // where we store the item
  var key: String { get }
  // use to actually load/store
  func store(in userDefaults: UserDefaults) throws
  init(from userDefaults: UserDefaults) throws
}

enum LoadError: Error {
  case fail
}

// Default implementations
extension UserDefaultStorable {
  var key: String { return "key" }
  func store(in userDefaults: UserDefaults) throws {
    userDefaults.set(try JSONEncoder().encode(self), forKey: key)
  }
  init(from userDefaults: UserDefaults) throws {
    guard let data = userDefaults.data(forKey: key) else { throw LoadError.fail }
    self = try JSONDecoder().decode(Self.self, from: data)
  }
}

然后只要使任何Codable类型都符合UserDefaultStorable。这种方法非常有用,因为假设您有另一个结构:

struct User: Codable {
  let name: String
  let id: Int
}

您无需只在UserDefaults上定义单独的功能,而只需使用以下代码:

extension User: UserDefaultStorable {}

答案 1 :(得分:0)

以下对UserDefaults的扩展解决了该问题,由于时间不足,我没有对其进行概括,但可能是这样的:

extension UserDefaults {
    func set(_ preset: Preset, forKey key: String) {
        set(["name": preset.name, "value": preset.value], forKey: key)
    }
}

这也可以在数组上工作:

extension UserDefaults {
    func set(_ presets: [Preset], forKey key: String) {
        let result = presets.map { ["name":$0.name, "value":$0.value] }
        set(result, forKey: key)
    }
}

问题是UserDefaults.standard.set(:forKey:)时,我的目标实际上是使其与可可绑定结合使用,以与NSArrayController一起使用。我决定按如下方式将NSArrayController子类化(请参见Hamish对my other question的评论,这是使这种通用名称丢失的最后一个难题):

extension Encodable {
    fileprivate func encode(to container: inout SingleValueEncodingContainer) throws {
        try container.encode(self)
    }
}

struct AnyEncodable: Encodable {
    var value: Encodable
    init(_ value: Encodable) {
        self.value = value
    }
    func encode(to encoder: Encoder) throws {
        var container = encoder.singleValueContainer()
        try value.encode(to: &container)
    }
}

class NSEncodableArrayController: NSArrayController {
    override func addObject(_ object: Any) {
        let data = try! PropertyListEncoder().encode(AnyEncodable(object as! Encodable))
        let any = try! PropertyListSerialization.propertyList(from: data, options: [], format: nil)

        super.addObject(any)
    }
}

答案 2 :(得分:0)

一种解决方案是在Struct上编写一个将其转换为字典的函数。

struct Preset {
     var name: String
     var value: Int

     func toDictionary() -> [String:Any] {
         return ["name": self.name, "value": self.value]
     }
}

然后,要将其保存到UserDefaults,只需执行以下操作:

let p = Preset(name: "A preset", value: 1)
UserDefaults.standard.set(p.toDictionary(), forKey: "preset")

希望有帮助!