swift 使用Codable协议实现模型与json互转

在写项目开发中，编辑创建情况下提交数据的时候无可避免的会出现模型转换成对应的字典样式提交数据，在swift里面利用Codable协议可以很轻松的解决这个原本需要人为去一行一行代码来转化的问题。

Codable协议介绍

/// A type that can convert itself into and out of an external representation.
///
/// `Codable` is a type alias for the `Encodable` and `Decodable` protocols.
/// When you use `Codable` as a type or a generic constraint, it matches
/// any type that conforms to both protocols.


public typealias Codable = Decodable & Encodable

Codable协议是一个组合协议，包含Decodable协议（json转模型的协议）与Encodable协议（模型转json的协议），这协议struct，class，protocol，都可以使用。

简单使用

json数据字符串准备：

/// json数据
        let jsonString = """
        {
        "name":"张三",
        "ages":"23",
        "height":"170",
        "carsArray" :
            [{
            "color":"蓝色",
            "size":"180*100"
            },
            {
            "color":"红色",
            "size":"200*100"
            }]
        }
        """

数据模型代码：

/// 人的模型
struct PeopleStruct:Codable {
    var name : String
    var age :String
    var height : String
    var carsArray:[PeopleCarStruct]
    
    /// 设置不一致字段（自定义字段，模型中有的字段即使不更改这里也都要写上）
    enum CodingKeys: String,CodingKey {
        case name
        case age = "ages"
        case height
        case carsArray
    }
}
/// 人拥有的车模型
struct PeopleCarStruct:Codable {
    var color:String
    var size:String
}

json转模型代码方法设置：

/*
 * 解析json数据
 * 参数jsonStr：传入json字符串
 * 返回值： 返回结构体PeopleStruct的对象
 */
func getDecoderData(jsonStr:String) -> PeopleStruct? {
    if let jsonData = jsonStr.data(using: .utf8) {
        do {
            let dataStruct = try JSONDecoder().decode(PeopleStruct.self, from: jsonData)
            return dataStruct
        } catch {
            debugPrint("error == \(error)")
        }
    }
    return nil
}

该方法的调用及输出结果展示：

let dataModel = getDecoderData(jsonStr: jsonString)
debugPrint(dataModel!)
// debugPrint输出结果
Test123456.PeopleStruct(name: "张三", age: "23", height: "170", carsArray: [Test123456.PeopleCarStruct(color: "蓝色", size: "180*100"), Test123456.PeopleCarStruct(color: "红色", size: "200*100")])

模型转json代码方法设置

/*
 * 模型转json
 * 参数dataModel：数据模型对象
 * 返回值：返回json字符串
 */
func getJsonData(dataModel:PeopleStruct) -> String? {
    do {
        let encoder = JSONEncoder()
//        if #available(iOS 13.0, *) {
//            /// 设置json格式
//            encoder.outputFormatting = .withoutEscapingSlashes
//        } else {
//            encoder.outputFormatting = .prettyPrinted
//        }
        let data = try encoder.encode(dataModel)
        if let str = String(data: data, encoding: .utf8) {
            return str
        }
    } catch {
        debugPrint("error == \(error)")
    }
    return nil
}

模型转json方法调用及结果输出

/// 序列化模型转化json测试
if let peopleStruct = dataModel {
    let json = getJsonData(dataModel: peopleStruct) ?? ""
    debugPrint(json)
}
/// debugPrint 输出结果
"{\"ages\":\"23\",\"name\":\"张三\",\"height\":\"170\",\"carsArray\":[{\"color\":\"蓝色\",\"size\":\"180*100\"},{\"color\":\"红色\",\"size\":\"200*100\"}]}"

附言

如果需要单独使用Decodable或者Encodable协议，也是可以的，这两个协议不必成对出现，模型只要实现对应使用的协议即可，不是必须实现Codable协议。