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类型

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,425评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,058评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,186评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,848评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,249评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,554评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,830评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,536评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,239评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,505评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,004评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,346评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,999评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,060评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,821评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,574评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,480评论 2 267

推荐阅读更多精彩内容