更新保存的 Codable 结构以添加新属性答案

【问题标题】：Updating a saved Codable struct to add a new property更新保存的 Codable 结构以添加新属性
【发布时间】：2020-04-20 19:50:48
【问题描述】：

我的应用使用这样的可编码结构：

public struct UserProfile: Codable {

     var name: String = ""
     var completedGame: Bool = false

     var levelScores: [LevelScore] = []
}

JSONEncoder() 已用于将 UserProfiles 的编码数组保存为用户默认值。

在即将到来的更新中，我想为这个UserProfile 结构添加一个新属性。这在某种程度上可能吗？

或者我是否需要创建一个具有相同属性和一个新属性的新 Codable 结构，然后将所有值复制到新结构中，然后开始使用该新结构代替 UserProfile struct 以前用过吗？

如果我只是向结构添加一个新属性，那么我将无法加载UserProfiles 的先前编码数组，因为该结构将不再具有匹配的属性。当我得到这个代码来加载保存的用户时：

if let savedUsers = UserDefaults.standard.object(forKey: "SavedUsers") as? Data {
       let decoder = JSONDecoder()
       if let loadedUsers = try? decoder.decode([UserProfile].self, from: savedUsers) {

如果UserProfile 在编码和保存时所具有的属性不包含UserProfile 结构的所有当前属性，则loadedUsers 不会解码。

对更新保存的结构属性有什么建议吗？还是我必须走很长的路重新创建，因为我之前没有提前计划要包含这个属性？

感谢您的帮助！

【问题讨论】：

你应该可以添加一个属性，只要它是可选的

标签： ios swift struct properties userdefaults

【解决方案1】：

如 cmets 中所述，您可以将新属性设为可选，然后解码将适用于旧数据。

var newProperty: Int?

如果属性缺失，另一个选项是在解码期间应用默认值。

这可以通过在你的结构中实现init(from:) 来完成

public init(from decoder: Decoder) throws {
    let container = try decoder.container(keyedBy: CodingKeys.self)
    name = try container.decode(String.self, forKey: .name)
    completedGame = try container.decode(Bool.self, forKey: .completedGame)
    do {
        newProperty = try container.decode(Int.self, forKey: .newProperty)
    } catch {
        newProperty = -1
    }
    levelScores = try container.decode([LevelScore].self, forKey: .levelScores)
}

这要求您定义一个CodingKey 枚举

enum CodingKeys: String, CodingKey {
    case name, completedGame, newProperty, levelScores
}

如果您不希望在代码中使用它是可选的，第三个选项是将其包装在计算的非可选属性中，再次使用默认值。这里_newProperty将用于存储的json，但newProperty在代码中使用

private var _newProperty: Int?
var newProperty: Int {
    get {
        _newProperty ?? -1
    }
    set {
        _newProperty = newValue
    }
}

【讨论】：