背景:
很多時(shí)候,我們從服務(wù)端請(qǐng)求下的數(shù)據(jù)都是Json格式,我們需要拿這些數(shù)據(jù)顯示到我們的UI界面。
因此,我們的做法基本都會(huì)先將json轉(zhuǎn)為方便使用的數(shù)據(jù)模型,或者也可以直接轉(zhuǎn)字典解決。
在OC中,我們有很多優(yōu)秀的第三方庫(kù)幫助我們實(shí)現(xiàn),比如MJExtension、JSONModel等,這些庫(kù)基本都是利用runtime實(shí)現(xiàn)讀取屬性名并利用kvc重新賦值屬性。
在Swift中,由于runtime的局限,比較出名的有SwiftyJSON、ObjectMapper等。
其中:
1、SwiftyJSON本質(zhì)上仍然是根據(jù)JSON結(jié)構(gòu)去取值,使用起來(lái)順手、清晰;
但這種做法沒(méi)能妥善解決上述的幾個(gè)問(wèn)題,因?yàn)樗皇菣C(jī)遇model的,我們使用的時(shí)候,依然必須制定key去獲取value,這在一定程度上不是很友好。
2、ObjectMapper實(shí)現(xiàn)了JSON直接轉(zhuǎn)Model的功能,不過(guò)使用起來(lái),代碼量會(huì)多一點(diǎn),因?yàn)槲覀儽仨氉裱璏appable協(xié)議,制定json內(nèi)的每一個(gè)key和model屬性的對(duì)應(yīng)關(guān)系。
比如:構(gòu)造的class必須滿(mǎn)足這三個(gè)紅框的內(nèi)容,這對(duì)于使用習(xí)慣了直接定義Model屬性的同學(xué)來(lái)說(shuō),可能會(huì)有點(diǎn)不習(xí)慣。
那么,今天的主角 HandyJSON就出現(xiàn)了,這個(gè)庫(kù)是阿里一位大神推出的,能夠做到JSON轉(zhuǎn)Model一步到位,而且使用起來(lái),非常簡(jiǎn)潔方便。
關(guān)于HandyJSON原理:
摘自網(wǎng)上一段說(shuō)明如下:
HandyJSON另辟蹊徑,采用Swift反射+內(nèi)存賦值的方式來(lái)構(gòu)造Model實(shí)例,保持原汁原味的Swift類(lèi)定義。
// 假設(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è)這是某一個(gè)業(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()! // 從對(duì)象實(shí)例轉(zhuǎn)換到JSON字符串
print(jsonString) // print: {"code":200,"data":{"id":2}}
if let mappedObject = JSONDeserializer<BaseResponse<SampleData>>.deserializeFrom(json: jsonString) { // 從字符串轉(zhuǎn)換為對(duì)象實(shí)例
print(mappedObject.data?.id)
}
關(guān)于HandyJSON 如何集成使用:
GitHub下載鏈接: https://github.com/alibaba/HandyJSON
1、pod引入
pod 'HandyJSON'
2、使用時(shí),先頭部import
import HandyJSON
正文:
1、HandyJSON支持 JSON直接轉(zhuǎn)Model,定義class時(shí),有兩點(diǎn)注意:
- 必須遵循HandyJSON協(xié)議
- 需要實(shí)現(xiàn)空的initializer (當(dāng)然Struct結(jié)構(gòu)體 可以不需要init(),下文有說(shuō)明)
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) {
// …
}
這是最簡(jiǎn)單的模型,只有三個(gè)屬性,對(duì)于復(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)造我們自己的初始化,還是需要寫(xiě)一下的。
3、HandyJSON支持枚舉,只需要enum構(gòu)造時(shí)服從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ǔ)類(lèi)型、復(fù)雜類(lèi)型,包括嵌套結(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支持指定從哪個(gè)具體路徑開(kāi)始解析,反序列化到Model。
這個(gè)比較常用,因?yàn)檎G闆r下,接口一般都會(huì)返回包括錯(cuò)誤碼,錯(cuò)誤消息,正式請(qǐng)求數(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)
}
其中,直接通過(guò) designatedPath 定位到我們需要的節(jié)點(diǎn)處。
6、handyJSON支持有繼承關(guān)系的Model類(lèi),就是說(shuō)及時(shí)某個(gè)類(lèi)沒(méi)有實(shí)現(xiàn)HandyJSON協(xié)議,只要父類(lèi)有實(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、上面都是基本在說(shuō)JSON轉(zhuǎn)模型,那么反過(guò)來(lái)實(shí)現(xiàn)呢?
HandyJSON還支持對(duì)象轉(zhuǎn)字典、對(duì)象轉(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,可以這樣:
1、下載官方Demo:https://github.com/alibaba/HandyJSON
2、下載我的測(cè)試Demo:https://github.com/TangledHusky/TestSwift
以上所述是小編給大家介紹的Swift實(shí)現(xiàn)JSON轉(zhuǎn)Model的方法及HandyJSON使用講解,希望對(duì)大家有所幫助,如果大家有任何疑問(wèn)請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)html5模板網(wǎng)網(wǎng)站的支持!