Swift: 實(shí)現(xiàn)JSON轉(zhuǎn)Model - HandyJSON

很多時候丘逸,我們從服務(wù)端請求下的數(shù)據(jù)都是Json格式,我們需要拿這些數(shù)據(jù)顯示到我們的UI界面掀宋。
因此深纲,我們的做法基本都會先將json轉(zhuǎn)為方便使用的數(shù)據(jù)模型,或者也可以直接轉(zhuǎn)字典解決劲妙。

在OC中湃鹊,我們有很多優(yōu)秀的第三方庫幫助我們實(shí)現(xiàn),比如MJExtension镣奋、JSONModel等币呵,這些庫基本都是利用runtime實(shí)現(xiàn)讀取屬性名并利用kvc重新賦值屬性。

在Swift中侨颈,由于runtime的局限余赢,比較出名的有SwiftyJSON芯义、ObjectMapper等。

其中:
1没佑、SwiftyJSON本質(zhì)上仍然是根據(jù)JSON結(jié)構(gòu)去取值毕贼,使用起來順手、清晰蛤奢;但這種做法沒能妥善解決上述的幾個問題鬼癣,因?yàn)樗皇菣C(jī)遇model的,我們使用的時候啤贩,依然必須制定key去獲取value待秃,這在一定程度上不是很友好。

2痹屹、ObjectMapper實(shí)現(xiàn)了JSON直接轉(zhuǎn)Model的功能章郁,不過使用起來,代碼量會多一點(diǎn)志衍,因?yàn)槲覀儽仨氉裱璏appable協(xié)議暖庄,制定json內(nèi)的每一個key和model屬性的對應(yīng)關(guān)系。

比如:構(gòu)造的class必須滿足這三個紅框的內(nèi)容楼肪,這對于使用習(xí)慣了直接定義
Model屬性的同學(xué)來說培廓,可能會有點(diǎn)不習(xí)慣。

511196-20170705160409206-632892453.png

那么春叫,今天的主角 HandyJSON就出現(xiàn)了肩钠,這個庫是阿里一位大神推出的,能夠做到JSON轉(zhuǎn)Model一步到位暂殖,而且使用起來价匠,非常簡潔方便。
關(guān)于HandyJSON原理:
摘自網(wǎng)上一段說明如下:
HandyJSON另辟蹊徑呛每,采用Swift反射+內(nèi)存賦值的方式來構(gòu)造Model實(shí)例踩窖,保持原汁原味的Swift類定義。

// 假設(shè)這是服務(wù)端返回的統(tǒng)一定義的response格式
class BaseResponse<T: HandyJSON>: HandyJSON {
    var code: Int? // 服務(wù)端返回碼
    var data: T? // 具體的data的格式和業(yè)務(wù)相關(guān)莉给,故用泛型定義

    public required init() {}
}

// 假設(shè)這是某一個業(yè)務(wù)具體的數(shù)據(jù)格式定義
struct SampleData: HandyJSON {
    var id: Int?
}

let sample = SampleData(id: 2)
let resp = BaseResponse<SampleData>()
resp.code = 200
resp.data = sample

let jsonString = resp.toJSONString()! // 從對象實(shí)例轉(zhuǎn)換到JSON字符串
print(jsonString) // print: {"code":200,"data":{"id":2}}

if let mappedObject = JSONDeserializer<BaseResponse<SampleData>>.deserializeFrom(json: jsonString) { // 從字符串轉(zhuǎn)換為對象實(shí)例
    print(mappedObject.data?.id)
}

關(guān)于HandyJSON 如何集成使用:

GitHub下載鏈接: https://github.com/alibaba/HandyJSON

1毙石、pod引入

pod 'HandyJSON'

2、使用時颓遏,先頭部import

import HandyJSON

正文:

1徐矩、HandyJSON支持 JSON直接轉(zhuǎn)Model,定義class時叁幢,有兩點(diǎn)注意:

  • 必須遵循HandyJSON協(xié)議

  • 需要實(shí)現(xiàn)空的initializer (當(dāng)然Struct結(jié)構(gòu)體 可以不需要init()滤灯,下文有說明)

class BasicTypes: HandyJSON {
    var int: Int = 2
    var doubleOptional: Double?
    var stringImplicitlyUnwrapped: String!

    required init() {}
}

let jsonString = "{\"doubleOptional\":1.1,\"stringImplicitlyUnwrapped\":\"hello\",\"int\":1}"
if let object = BasicTypes.deserialize(from: jsonString) {
    // …
}

這是最簡單的模型,只有三個屬性,對于復(fù)雜的嵌套結(jié)構(gòu)鳞骤,一樣這樣處理實(shí)現(xiàn)窒百,參考下文。

2豫尽、HandyJSON還支持Struct篙梢,使用方式與Class基本一致

struct BasicTypes: HandyJSON {
    var int: Int = 2
    var doubleOptional: Double?
    var stringImplicitlyUnwrapped: String!
}

let jsonString = "{\"doubleOptional\":1.1,\"stringImplicitlyUnwrapped\":\"hello\",\"int\":1}"
if let object = BasicTypes.deserialize(from: jsonString) {
    // …
}

這里注意一下,雖然Struct自己已經(jīng)幫助構(gòu)造了init初始化美旧,但如果我們需要重載init渤滞,構(gòu)造我們自己的初始化,還是需要寫一下的榴嗅。

3妄呕、HandyJSON支持枚舉,只需要enum構(gòu)造時服從HandyJSONEnum協(xié)議即可嗽测。

enum AnimalType: String, HandyJSONEnum {
    case Cat = "cat"
    case Dog = "dog"
    case Bird = "bird"
}

struct Animal: HandyJSON {
    var name: String?
    var type: AnimalType?
}

let jsonString = "{\"type\":\"cat\",\"name\":\"Tom\"}"
if let animal = Animal.deserialize(from: jsonString) {
    print(animal.type?.rawValue)
}

4绪励、此外唠粥,HandyJSON還支持一些非基礎(chǔ)類型疏魏、復(fù)雜類型,包括嵌套結(jié)構(gòu)晤愧,如可選蠢护、隱式解包可選、集合等

class BasicTypes: HandyJSON {
    var bool: Bool = true
    var intOptional: Int?
    var doubleImplicitlyUnwrapped: Double!
    var anyObjectOptional: Any?

    var arrayInt: Array<Int> = []
    var arrayStringOptional: Array<String>?
    var setInt: Set<Int>?
    var dictAnyObject: Dictionary<String, Any> = [:]

    var nsNumber = 2
    var nsString: NSString?

    required init() {}
}

let object = BasicTypes()
object.intOptional = 1
object.doubleImplicitlyUnwrapped = 1.1
object.anyObjectOptional = "StringValue"
object.arrayInt = [1, 2]
object.arrayStringOptional = ["a", "b"]
object.setInt = [1, 2]
object.dictAnyObject = ["key1": 1, "key2": "stringValue"]
object.nsNumber = 2
object.nsString = "nsStringValue"

let jsonString = object.toJSONString()!

if let object = JSONDeserializer<BasicTypes>.deserializeFrom(json: jsonString) {
    // ...
}

5养涮、HandyJSON支持指定從哪個具體路徑開始解析,反序列化到Model眉抬。
這個比較常用贯吓,因?yàn)檎G闆r下,接口一般都會返回包括錯誤碼蜀变,錯誤消息悄谐,正式請求數(shù)據(jù)等,但我們一般只需要把正式數(shù)據(jù)轉(zhuǎn)換成Model即可库北。

我們可以這樣實(shí)現(xiàn):

class Cat: HandyJSON {
    var id: Int64!
    var name: String!

    required init() {}
}

let jsonString = "{\"code\":200,\"msg\":\"success\",\"data\":{\"cat\":{\"id\":12345,\"name\":\"Kitty\"}}}"

if let cat = JSONDeserializer<Cat>.deserializeFrom(json: jsonString, designatedPath: "data.cat") {
    print(cat.name)
}

其中爬舰,直接通過 designatedPath 定位到我們需要的節(jié)點(diǎn)處。

6寒瓦、handyJSON支持有繼承關(guān)系的Model類情屹,就是說及時某個類沒有實(shí)現(xiàn)HandyJSON協(xié)議,只要父類有實(shí)現(xiàn)杂腰,依然可以轉(zhuǎn)化model垃你。

class Animal: HandyJSON {
    var id: Int?
    var color: String?

    required init() {}
}


class Cat: Animal {
    var name: String?

    required init() {}
}

let jsonString = "{\"id\":12345,\"color\":\"black\",\"name\":\"cat\"}"

if let cat = JSONDeserializer<Cat>.deserializeFrom(json: jsonString) {
    print(cat)
}

7、上面都是基本在說JSON轉(zhuǎn)模型,那么反過來實(shí)現(xiàn)呢惜颇?
HandyJSON還支持對象轉(zhuǎn)字典皆刺、對象轉(zhuǎn)模型。

class BasicTypes: HandyJSON {
    var int: Int = 2
    var doubleOptional: Double?
    var stringImplicitlyUnwrapped: String!

    required init() {}
}

let object = BasicTypes()
object.int = 1
object.doubleOptional = 1.1
object.stringImplicitlyUnwrapped = “hello"

print(object.toJSON()!) // 序列化到字典
print(object.toJSONString()!) // 序列化到JSON字符串
print(object.toJSONString(prettyPrint: true)!) // 序列化為格式化后的JSON字符串

官方Demo:https://github.com/alibaba/HandyJSON
HandyJSON在swift4.0以上版本無法編譯的問題

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末凌摄,一起剝皮案震驚了整個濱河市羡蛾,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌锨亏,老刑警劉巖痴怨,帶你破解...
    沈念sama閱讀 206,482評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異屯伞,居然都是意外死亡腿箩,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,377評論 2 382
  • 文/潘曉璐 我一進(jìn)店門劣摇,熙熙樓的掌柜王于貴愁眉苦臉地迎上來珠移,“玉大人,你說我怎么就攤上這事末融【澹” “怎么了?”我有些...
    開封第一講書人閱讀 152,762評論 0 342
  • 文/不壞的土叔 我叫張陵勾习,是天一觀的道長浓瞪。 經(jīng)常有香客問我,道長巧婶,這世上最難降的妖魔是什么乾颁? 我笑而不...
    開封第一講書人閱讀 55,273評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮艺栈,結(jié)果婚禮上英岭,老公的妹妹穿的比我還像新娘。我一直安慰自己湿右,他們只是感情好诅妹,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,289評論 5 373
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著毅人,像睡著了一般吭狡。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上丈莺,一...
    開封第一講書人閱讀 49,046評論 1 285
  • 那天划煮,我揣著相機(jī)與錄音,去河邊找鬼场刑。 笑死般此,一個胖子當(dāng)著我的面吹牛蚪战,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播铐懊,決...
    沈念sama閱讀 38,351評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼邀桑,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了科乎?” 一聲冷哼從身側(cè)響起壁畸,我...
    開封第一講書人閱讀 36,988評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎茅茂,沒想到半個月后捏萍,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,476評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡空闲,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,948評論 2 324
  • 正文 我和宋清朗相戀三年令杈,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片碴倾。...
    茶點(diǎn)故事閱讀 38,064評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡逗噩,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出跌榔,到底是詐尸還是另有隱情异雁,我是刑警寧澤,帶...
    沈念sama閱讀 33,712評論 4 323
  • 正文 年R本政府宣布僧须,位于F島的核電站纲刀,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏担平。R本人自食惡果不足惜示绊,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,261評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望暂论。 院中可真熱鬧耻台,春花似錦、人聲如沸空另。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,264評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽扼菠。三九已至,卻和暖如春坝咐,著一層夾襖步出監(jiān)牢的瞬間循榆,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,486評論 1 262
  • 我被黑心中介騙來泰國打工墨坚, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留秧饮,地道東北人映挂。 一個月前我還...
    沈念sama閱讀 45,511評論 2 354
  • 正文 我出身青樓,卻偏偏與公主長得像盗尸,于是被迫代替她去往敵國和親柑船。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,802評論 2 345

推薦閱讀更多精彩內(nèi)容