Swift 使用Codable协议解析JSON

前言

在swift4.0后，苹果官方在Foundation框架中添加了Codable协议可用于JSON解析为Model和Model转化为JSON。除了一些三方JSON解析库外，我们又有了新的选择，使用起来也较为方便。

应用

首先定义需要的数据结构，必须遵循Codable协议,因为解析过程中是可能出现没有对应属性的情况的，所以属性需要设置为可选型。另外支持支持自定义键值对，需要定义CodingKeys，并且对所有的属性进行定义，否则会报错

struct Student: Codable {
    var name: String?
    var num: Int?
    var height: Float?
    var pens: [Pen]?
    //自定义键值对, 一旦声明所以的属性都需要定义
    enum CodingKeys: String, CodingKey {
        case name = "name"
        case num = "number"
        case height
        case pens
    }
}

struct Pen: Codable {
    var type: String?
    var price: Float?
}

接下来对解析方法进行简单的封装，这样就不用每次都重复写解析方法了


//json->model
func jsonToModel<T>(_ json: Any, modelType: T.Type) -> T? where T: Codable {
    var jsonDic: Any = json
    //如果传入的是json字符串，需要进行转换
    if type(of: json) == String.self {
        let jsonStr = json as! String
        guard let jsonData = jsonStr.data(using: String.Encoding.utf8, allowLossyConversion: false) else {
            return nil
        }
        guard let jsonObjct = try? JSONSerialization.jsonObject(with: jsonData, options: .mutableContainers) else {
            return nil
        }
        jsonDic = jsonObjct
    }
    if !JSONSerialization.isValidJSONObject(jsonDic) {
          print("json format error")
          return nil;
      }
    let jsonDecoder = JSONDecoder()
    guard let jsonData = try? JSONSerialization.data(withJSONObject: jsonDic, options: []) else { return nil}
    guard let model = try? jsonDecoder.decode(modelType, from: jsonData) else {return nil}
    return model
}

//model->json
func modelToJson<T>(model: T) -> Any? where T: Codable {
    let jsonEncoder = JSONEncoder()
    guard let jsonData = try? jsonEncoder.encode(model) else { return nil}
    guard let json = try? JSONSerialization.jsonObject(with: jsonData, options: .mutableContainers) else {return nil}
    return json
}

接下来进行简单测试

    //json->model
    print("-----------json->model------------------")
    let dic:[String:Any] = ["name":"Jack",
                    "number":123,
                    "height": 175.5,
                    "pens": [["type": "gangbi", "price": 25.0],
                            ["type": "shuibi", "price": 2.0]]
                    ]
    let student1 = jsonToModel(dic, modelType: Student.self)
    print(student1 ?? "parse fail")
    //model->json
    print("-----------model->json------------------")
    let student2: Student = Student(name: "Rose", num: 3, height: 168.5, pens: [Pen(type: "qianbi", price: 1.5)])
    let ret = modelToJson(model: student2)
    print(ret ?? "parse fail")
    //json string -> model
     print("-----------json string -> model------------------")
    let jsonStr = "{\"type\":\"maobi\",\"price\":100.0}"
    let myPen = jsonToModel(jsonStr, modelType: Pen.self)
    print(myPen ?? "parse fail")

打印结果如下：

-----------json->model------------------
Student(name: Optional("Jack"), num: Optional(123), height: Optional(175.5), pens: Optional([SwiftPhone.Pen(type: Optional("gangbi"), price: Optional(25.0)), SwiftPhone.Pen(type: Optional("shuibi"), price: Optional(2.0))]))
-----------model->json------------------
{
    height = "168.5";
    name = Rose;
    number = 3;
    pens =     (
                {
            price = "1.5";
            type = qianbi;
        }
    );
}
-----------json string -> model------------------
Pen(type: Optional("maobi"), price: Optional(100.0))

可以看到JSON和Model间的成功转换，并且Student结构体的num属性映射到了number。

思考

通过原生Codable协议进行JSON和Model的转换优势在哪呢？
不再依赖于第三方库，接口相对更稳定，不会因为版本的升级而导致无法使用的情况。
Codable协议是否会同时对父类进行解析？
因为swift的struct是无法继承的，所以不存在解析父结构的情况。同时，经过验证，Codable协议对class是无效的。所以不存在这一的场景。