Swift中修改模型结构后JSON解码兼容的更优方案探讨

问题背景 #

需要将EncodingOption参数从OutputOptions结构体迁移至EditingOptions类，配置层级结构如下：

AppConfig {
    profile: ProfileSetting
}

ProfileSetting {
    editSetting: EditingOptions
    outputSetting: OutputOptions
}

原有数据结构 #

class EditingOptions: NSObject, Codable {
    // 其他参数
}

struct OutputOptions: Codable {
    var barcodeEncoding: EncodingOption = .utf8 // 待迁移参数，带默认值且未对外发布
    // 其他参数
}

修改后的数据结构 #

class EditingOptions: NSObject, Codable {
    var encodingOption: EncodingOption // 迁移后的参数
    // 其他参数
}

struct OutputOptions: Codable {
    // 其他参数（已移除barcodeEncoding）
}

遇到的问题 #

修改后解码旧配置文件时触发keyNotFound错误，错误信息如下：

keyNotFound(CodingKeys(stringValue: "encodingOption", intValue: nil), 
Swift.DecodingError.Context(codingPath: [
CodingKeys(stringValue: "profileManage", intValue: nil), CodingKeys(stringValue: "deviceName",
 intValue: nil), CodingKeys(stringValue: "profiles", intValue: nil), 
_JSONKey(stringValue: "Index 0", intValue: 0), 
CodingKeys(stringValue: "outputOptions", intValue: nil)
],
 debugDescription: "No value associated with key CodingKeys(stringValue: \"encodingOption\", intValue: nil) (\"encodingOption\").", underlyingError: nil))

ChatGPT给出的方案是给ProfileSetting添加自定义解码方法：

required init(from decoder: Decoder) throws {
    let container = try decoder.container(keyedBy: CodingKeys.self)

    // 其他参数解码
    
    if let editingOptions = try? container.decode(EditingOptions.self, forKey: .editingOptions) {
        self.editingOptions = editingOptions
    } else {
        self.editingOptions = EditingOptions()
    }
}

该方案虽解决了解码错误，但未处理旧配置中barcodeEncoding的数据迁移，无法保证配置连续性。

正确解决方案 #

问题核心分析 #

错误根源有两点：一是新EditingOptions的encodingOption无默认值，旧配置中不存在该字段导致解码失败；二是旧配置中barcodeEncoding的配置数据需要迁移到新字段，否则会丢失原有设置。ChatGPT的方案仅解决了解码失败问题，未完成数据迁移，属于不完整的兼容方案。

分步实现 #

1. 给EditingOptions的encodingOption添加默认值

先从根源避免字段缺失导致的解码失败：

class EditingOptions: NSObject, Codable {
    var encodingOption: EncodingOption = .utf8 // 匹配原参数默认值
    // 其他参数
}

2. 给ProfileSetting实现自定义解码，处理数据迁移

在ProfileSetting的解码逻辑中，完成旧配置数据的迁移：

class ProfileSetting: NSObject, Codable {
    var editingOptions: EditingOptions
    var outputOptions: OutputOptions

    enum CodingKeys: String, CodingKey {
        case editingOptions, outputOptions
    }

    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        
        // 初始化或解码EditingOptions
        let editingOpts: EditingOptions
        if let tempOpts = try? container.decode(EditingOptions.self, forKey: .editingOptions) {
            editingOpts = tempOpts
        } else {
            editingOpts = EditingOptions()
        }
        
        // 从旧配置的OutputOptions中读取barcodeEncoding，迁移到新字段
        if let oldOutputOpts = try? container.decode(OutputOptions.self, forKey: .outputOptions) {
            editingOpts.encodingOption = oldOutputOpts.barcodeEncoding
        }
        
        self.editingOptions = editingOpts
        
        // 解码OutputOptions，保留其他参数
        self.outputOptions = try container.decodeIfPresent(OutputOptions.self, forKey: .outputOptions) ?? OutputOptions()
    }

    // 实现编码方法，确保新配置正确写入
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(editingOptions, forKey: .editingOptions)
        try container.encode(outputOptions, forKey: .outputOptions)
    }
}

方案说明 #

• 给encodingOption添加默认值，确保无该字段时也能正常解码，彻底解决keyNotFound错误
• 在ProfileSetting的解码逻辑中主动迁移旧配置数据，保证用户原有设置不丢失
• 保留OutputOptions的解码逻辑，避免其他参数受迁移影响

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