swift

Swift Codable协议之原生JSON和Model转换

Swift4.0 原生JSON和Model转换

一：引言

Apple 在 Swift 4.0 的 Foundation 的模块中添加了对 JSON 解析成Model的原生支持Codable协议.虽然也有ObjectMapper 、SwiftyJSON、HandyJSON等解决方案，但相比起来原生的使用方便、快捷，不依赖三方库的更新，相对更加稳定

关于 Codable：

public typealias Codable = Decodable & Encodable

通过查看定义可以看到，Codable 其实是一个组合协议，由 Decodable （解码用于JSON转Model）和 Encodable（编码用于Model转JSON） 两个协议组成：

Swift 中的基本数据类型比如 String、Int、Float 等都已经实现了 Codable 协议，因此如果你的数据类型只包含这些基本数据类型的属性，只需要在类型声明中加上 Codable 协议就可以了，不需要写任何实际实现的代码

二：简单使用

JSON数据：

{
  "class_id" : 2,
  "sub_classes" :  {
    "class_id" : 1,
    title : "\U7279\U5c55",
  },
  title : "\U7279\U5c55",
  type : 2,
}

Model对象：

struct GoodsModel: Codable {
    
    var class_id  : Int?
    var type      : Int?
    var title     : String?
    
    var price : String?
    var list_img : String?
    var wenchuang_id : Int?
    var sub_classes  : [Sub_classes]?
}

struct Sub_classes: Codable {
    var class_id  : Int?
    var title     : String?
}

注意：有些字段有可能会是空值，所以可将不确定是否有值得声明为可选值（？）

JSON转Model：

let jsonDecoder = JSONDecoder()
let jsonData = try? JSONSerialization.data(withJSONObject: jsonDic, options: [])
let model: GoodsModel = try! jsonDecoder.decode(GoodsModel.self, from: jsonData)

Model转JSON：

let jsonEncoder = JSONEncoder()
let jsonData = try? jsonEncoder.encode(modelObject)
let json = try JSONSerialization.jsonObject(with: jsonData, options: .mutableContainers)

三： 自定义键值名

对于一些系统关键字或者key不匹配时需要自定义键值名

JSON数据：

{
  "id" : 2,
  "sub_classes" : {
    "class_id" : 1,
    title = "\U7279\U5c55",
  },
  description : "\U7279\U5c55",
  type = 2
}

Model对象：

struct GoodsModel: Codable {
    
    var class_id  : Int?
    var type      : Int?
    var title     : String?
    
    var price : String?
    var list_img : String?
    var wenchuang_id : Int?
    var sub_classes  : [Sub_classes]?
    
    //自定义键值名
     enum CodingKeys: String, CodingKey {
        case class_id = "id" //关键字替换
        case type
        case title     = "description"
        
        case price
        case list_img
        case wenchuang_id
        case sub_classes
    }
}

struct Sub_classes: Codable {
    var class_id  : Int?
    var title     : String?
}

需要注意的是，即使属性名称与 JSON 中的字段名称一致，如果自定义了 CodingKeys，这些属性也是无法省略的，否则会得到一个 Type 'GoodsModel' does not conform to protocol 'Codable' 的编译错误，这一点还是有点坑的

四： 不确定数据类型解析（是Int或String类型）

声明一个跨类型解析类TStrInt：一个含有int，string的类，可用于解析后台返回类型不确定的字段。即：把int\string解析成TStrInt且解析后TStrInt的int和string都有值

struct TStrInt: Codable {
    var int:Int {
        didSet {
            let stringValue = String(int)
            if  stringValue != string {
                string = stringValue
            }
        }
    }
    
    var string:String {
        didSet {
            if let intValue = Int(string), intValue != int {
                int = intValue
            }
        }
    }
    
    //自定义解码(通过覆盖默认方法实现)
    init(from decoder: Decoder) throws {
        let singleValueContainer = try decoder.singleValueContainer()
        
        if let stringValue = try? singleValueContainer.decode(String.self)
        {
            string = stringValue
            int = Int(stringValue) ?? 0
            
        } else if let intValue = try? singleValueContainer.decode(Int.self)
        {
            int = intValue
            string = String(intValue);
        } else
        {
            int = 0
            string = ""
        }
    }
}

使用方法：

struct GoodsModel: Codable {
    
    var class_id  : TStrInt?
    var type      : TStrInt?
    var title     : String?
    
    var price : String?
    var list_img : String?
    var wenchuang_id : TStrInt?
    var sub_classes  : [Sub_classes]?
    
}

struct Sub_classes: Codable {
    var class_id  : TStrInt?
    var title     : String?
}

调用：
self.model!.class_id!.string //获取字符串类型
self.model!.class_id!.int //获取int类型

本文由 创作，采用 知识共享署名4.0 国际许可协议进行许可。本站文章除注明转载/出处外，均为本站原创或翻译，转载前请务必署名。最后编辑时间为: 2021/05/27 04:09