Swift5 原生JSON对象转Model & 简易封装

JSON对象转Model其实是一个编解码的过程,Swift原生提供Codable协议负责编解码的工作,遵循协议的对象可以使用JSONEncoder进行编码,使用JSONDecoder进行解码。

概述:
JSONSerialization:用于Foundation类型与Data的转换
JSONDecoder:解码Data->Model类型
JSONEncoder:编码Model类型->Data
Codable协议:解码协议Decodable & 编码协议Encodable 的别名

原理:
1.通过JSONSerialization可以把字典/数组对象序列化成Data
2.使用JSONDecoder把Data解码成相应的Model类型,Model需遵循Codable协议。

DEMO下载地址

演示 playground

class Student:NSObject,Codable{
    var name: String?
    var age: Int?
}

let jsonObject:[String:Any] = ["name":"xiaohua","age":23]

let data = try JSONSerialization.data(withJSONObject: jsonObject, options: [])
let student:Student = try JSONDecoder().decode(Student.self, from: data)

print(student.name ?? "")  

打印结果:
"xiaohua"

Codable使用起来很简约👆

简易封装

每次使用时都写一次编解码的过程效率不高,所以这里把序列化解码的代码封装到一个类方法里,用范型<T>来指代要转换成的Model类型

演示 DFJsonKit.swift

static func jsonToModel<T:Codable>(withJSONObject obj:Any?,modelType:T.Type)->T?

·转换失败返回nil
·转换成功返回对应的model

static func jsonToModel<T:Codable>(withJSONObject obj:Any?,modelType:T.Type)->T?{
    /*
     jsonObject->data->model
     */
    
    guard let obj = obj else {
        return nil
    }
    do{
        let jsonData = try JSONSerialization.data(withJSONObject: obj as Any, options:[])
        let model = try JSONDecoder().decode(modelType, from: jsonData)
        return model
    }catch{
        print(error)
        return nil
    }
}

用的时候传入JSON对象(字典/数组)和Model类型:

let student = DFJsonKit.jsonToModel(withJSONObject: jsonObject, modelType: Student.self)
print(student?.name ?? "")

打印结果:
"xiaohua"

这样使用的时候方便很多

Data、jsonObject、model和string之间的转换关系

wkWebView与web端交互的时候,偶尔会遇到上传json字符串或者接收一个json字符串转换成model的情况,这时可以根据图上的转化关系,把相应的model转成string传给web端,或者把web端的string转成model

参考JSONObjectmodel的封装方式,把Data,jsonObject,model,string之间的相互转换都封装到一起,用起来就方便许多👇
DEMO下载地址

延伸

苹果提供了一个CodingKeys枚举来支持一些自定义的实现

1.只转换Model中的部分字段:
这里只想要age,把age单独加到CodingKeys枚举中

class Student:NSObject,Codable{
    var name: String?
    var age: Int?
    
    enum CodingKeys:String, CodingKey {
        case age
    }
}

let jsonObject:[String:Any] = ["nickName":"xiaohua","age":23]

let student = DFJsonKit.jsonToModel(withJSONObject: jsonObject, modelType: Student.self)
print(student?.name ?? "没有转换所以没有")
print(student?.age ?? 0)

打印结果:
"没有转换所以没有"
"23"

2.数据源中的Key与Model中Key字段不同:
数据源中姓名字段是nickName,Model中是name。在CodingKeys枚举中把nickName赋值给name,让Codable处理的时候使用nickName字段

class Student:NSObject,Codable{
    var name: String?
    var age: Int?
    
    enum CodingKeys:String, CodingKey {
        case name = "nickName"
        case age
    }
}

let jsonObject:[String:Any] = ["nickName":"xiaohua","age":23]

let student = DFJsonKit.jsonToModel(withJSONObject: jsonObject, modelType: Student.self)
print(student?.name ?? "")
print(student?.age ?? 0)

打印结果:
"xiaohua"
"23"

3.如果数据源是model数组:

Demo 一组数据源

let jsonObject = [["name":"xiaohua","age":23],["name":"xiaoming","age":22]]
let studentArray = DFJsonKit.jsonToModel(withJSONObject: jsonObject, modelType: Array<Student>.self)

studentArray?.forEach({ (student) in
    print(student.name ?? "")
    print(student.age ?? 0)
})

打印结果:
"xiaohua"
"23"
"xiaoming"
"22"

4.服务端使用蛇形命名方式而客户端使用的是驼峰:
Swift 4.1 中的 Codable 改进

DEMO下载地址

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

推荐阅读更多精彩内容

  • Demonstrates approaches for encoding and decoding differe...
    ngugg阅读 523评论 0 0
  • 我想要一颗种子, 因我刚好有一片泥土, 需要我来把它耕种, 我不在乎的, 它会是哪一种作物的籽, 粮食或是鲜花, ...
    暮色柒光年外阅读 349评论 1 5
  • 蓦然回首一个星期。每个晚上都不能按时按点回家吃饭,要么是开会,要么是饭局,要么是加班——如同今天。 参加慕课,我,...
    窈静姝阅读 219评论 1 2
  • 三两繁星 于初秋深夜 万家灯火 于此时寂灭 晨雾栖息 于青青草地 三人微醺 于广阔天际 一睡不起 于风兮风兮 ​​​
    晨风霁月阅读 106评论 0 0
  • "舅舅,你精神不太好,别太操劳了,注意身体!”顾玉涵没有回答舅舅的话,看着舅舅疲惫的神态,她有些心疼的说。 顾玉涵...
    花气袭知昼阅读 123评论 0 2