背景

JSON是移動端開發常用的應用層數據交換協議。最常見的場景便是，客戶端向服務端發起網絡請求，服務端返回JSON文本，然后客戶端解析這個JSON文本，再把對應數據展現到頁面上。

但在編程的時候，處理JSON是一件麻煩事。在不引入任何輪子的情況下，我們通常需要先把JSON轉為Dictionary，然后還要記住每個數據對應的Key，用這個Key在Dictionary中取出對應的Value來使用。這個過程我們會犯各種錯誤：

• Key拼寫錯了;
• 路徑寫錯了;
• 類型搞錯了;
• 沒拿到值懵逼了;
• 某一天和服務端約定的某個字段變更了，沒能更新所有用到它的地方;
• ...

為了解決這些問題，很多處理JSON的開源庫應運而生。在Swift中，這些開源庫主要朝著兩個方向努力：

• 保持JSON語義，直接解析JSON，但通過封裝使調用方式更優雅、更安全;
• 預定義Model類，將JSON反序列化為類實例，再使用這些實例;

對于1，使用最廣、評價***的庫非 SwiftyJSON 莫屬，它很能代表這個方向的核心。它本質上仍然是根據JSON結構去取值，使用起來順手、清晰。但也正因如此，這種做法沒能妥善解決上述的幾個問題，因為Key、路徑、類型仍然需要開發者去指定;

對于2，我個人覺得這是更合理的方式。由于Model類的存在，JSON的解析和使用都受到了定義的約束，只要客戶端和服務端約定好了這個Model類，客戶端定義后，在業務中使用數據時就可以享受到語法檢查、屬性預覽、屬性補全等好處，而且一旦數據定義變更，編譯器會強制所有用到的地方都改過來才能編譯通過，非常安全。這個方向上，開源庫們做的工作，主要就是把JSON文本反序列化到Model類上了。這一類JSON庫有 ObjectMapper、JSONNeverDie、HandyJSON 等。而 HandyJSON 是其中使用最舒服的一個庫，本文將介紹用 HandyJSON 來進行Model和JSON間的互相轉換。

項目地址：https://github.com/alibaba/handyjson

為什么用HandyJSON

在Swift中把JSON反序列化到Model類，在HandyJSON出現以前，主要使用兩種方式：

• 讓Model類繼承自NSObject，然后class_copyPropertyList()方法獲取屬性名作為Key，從JSON中取得Value，再通過Objective-C runtime支持的KVC機制為類屬性賦值;如JSONNeverDie;
• 支持純Swift類，但要求開發者實現Mapping函數，使用重載的運算符進行賦值，如ObjectMapper;

這兩者都有顯而易見的缺點。前者要求Model繼承自NSObject，非常不優雅，且直接否定了用struct來定義Model的方式;后者的Mapping函數要求開發者自定義，在其中指明每個屬性對應的JSON字段名，代碼侵入大，且仍然容易發生拼寫錯誤、維護困難等問題。

而HandyJSON另辟蹊徑，采用Swift反射+內存賦值的方式來構造Model實例，規避了上述兩個方案遇到的問題。

把JSON轉換為Model

簡單類型

某個Model類想支持通過HandyJSON來反序列化，只需要在定義時，實現HandyJSON協議，這個協議只要求實現一個空的init()函數。

比如我們和服務端約定了一個Animal數據，里面有name/id/num字段，那么我們這樣定義Animal類：

class Animal: HandyJSON { 
    var name: String? 
    var id: String? 
    var num: Int? 
 
    required init() {} 
} 

然后假設我們從服務端拿到這樣一個JSON文本： 

let jsonString = "{\"name\":\"cat\",\"id\":\"12345\",\"num\":180}" 

引入HandyJSON以后，我們就可以這樣來做反序列化了：

if let animal = JSONDeserializer<Animal>.deserializeFrom(json: jsonString) { 
    print(animal.name) 
    print(animal.id) 
    print(animal.num) 
} 

簡單吧~

支持Struct

如果Model的定義是struct，由于Swift中struct提供了默認構造函數，所以就不需要再實現空的init()函數了。但需要注意，如果你為strcut指定了別的構造函數，那么就需要保留一個空的實現。

struct Animal: HandyJSON { 
    var name: String? 
    var id: String? 
    var num: Int? 
} 
 
let jsonString = "{\"name\":\"cat\",\"id\":\"12345\",\"num\":180}" 
 
if let animal = JSONDeserializer<Animal>.deserializeFrom(json: jsonString) { 
    print(animal) 
} 

比較復雜的類型

HandyJSON支持在類定義里使用各種形式的基本屬性，包括可選(?)，隱式解包可選(!)，數組(Array)，字典(Dictionary)，Objective-C基本類型(NSString、NSNumber)，各種類型的嵌套([Int]?、[String]?、[Int]!、...)等等。比如下面這個看起來比較復雜的類型：

class Cat: HandyJSON { 
    var id: Int64! 
    var name: String! 
    var friend: [String]? 
    var weight: Double? 
    var alive: Bool = true 
    var color: NSString? 
 
    required init() {} 
} 

一樣輕松轉換：

let jsonString = "{\"id\":1234567,\"name\":\"Kitty\",\"friend\":[\"Tom\",\"Jack\",\"Lily\",\"Black\"],\"weight\":15.34,\"alive\":false,\"color\":\"white\"}" 
 
if let cat = JSONDeserializer<Cat>.deserializeFrom(json: jsonString) { 
    print(cat.xxx) 
} 

嵌套的Model類

如果Model類中的某個屬性是另一個自定義的Model類，那么只要那個Model類也實現了HandyJSON協議，就一樣可以轉換:

class Component: HandyJSON { 
    var aInt: Int? 
    var aString: String? 
 
    required init() {} 
} 
 
class Composition: HandyJSON { 
    var aInt: Int? 
    var comp1: Component? 
    var comp2: Component? 
 
    required init() {} 
} 
 
let jsonString = "{\"num\":12345,\"comp1\":{\"aInt\":1,\"aString\":\"aaaaa\"},\"comp2\":{\"aInt\":2,\"aString\":\"bbbbb\"}}" 
 
if let composition = JSONDeserializer<Composition>.deserializeFrom(json: jsonString) { 
    print(composition) 
} 

指定反序列化JSON中某個節點

有時候服務端返回給我們的JSON文本包含了大量的狀態信息，和Model無關，比如statusCode，debugMessage等，或者有用的數據是在某個節點以下，那么我們可以指定反序列化哪個節點:

class Cat: HandyJSON { 
    var id: Int64! 
    var name: String! 
 
    required init() {} 
} 
 
 
// 服務端返回了這個JSON，我們想解析的只有data里的cat 
let jsonString = "{\"code\":200,\"msg\":\"success\",\"data\":{\"cat\":{\"id\":12345,\"name\":\"Kitty\"}}}" 
 
// 那么，我們指定解析 "data.cat"，通過點來表達路徑 
if let cat = JSONDeserializer<Cat>.deserializeFrom(json: jsonString, designatedPath: "data.cat") { 
    print(cat.name) 
} 

有繼承關系的Model類

如果某個Model類繼承自另一個Model類，只需要這個父Model類實現HandyJSON協議就可以：

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) 
} 

自定義解析方式

HandyJSON還提供了一個擴展能力，就是允許自行定義Model類某個字段的解析Key、解析方式。我們經常會有這樣的需求：

• 某個Model中，我們不想使用和服務端約定的key作為屬性名，想自己定一個;
• 有些類型如enum、tuple是無法直接從JSON中解析出來的，但我們在Model類中有這樣的屬性;

HandyJSON協議提供了一個可選的mapping()函數，我們可以在其中指定某個字段用什么Key、或者用什么方法從JSON中解析出它的值。如我們有一個Model類和一個服務端返回的JSON串：

class Cat: HandyJSON { 
    var id: Int64! 
    var name: String! 
    var parent: (String, String)? 
 
    required init() {} 
} 
 
let jsonString = "{\"cat_id\":12345,\"name\":\"Kitty\",\"parent\":\"Tom/Lily\"}" 

可以看到，Cat類的id屬性和JSON文本中的Key是對應不上的;而對于parent這個屬性來說，它是一個元組，做不到從JSON中的"Tom/Lily"解析出來。所以我們要定義一個Mapping函數來做這兩個支持：

class Cat: HandyJSON { 
    var id: Int64! 
    var name: String! 
    var parent: (String, String)? 
 
    required init() {} 
 
    func mapping(mapper: HelpingMapper) { 
        // 指定 id 字段用 "cat_id" 去解析 
        mapper.specify(property: &id, name: "cat_id") 
 
        // 指定 parent 字段用這個方法去解析 
        mapper.specify(property: &parent) { (rawString) -> (String, String) in 
            let parentNames = rawString.characters.split{$0 == "/"}.map(String.init) 
            return (parentNames[0], parentNames[1]) 
        } 
    } 
} 

就這樣，HandyJSON***地幫我們進行了JSON到Model類的轉換。如此方便，這也是將其命名為Handy的由來。

把Model轉換為JSON文本

HandyJSON還提供了把Model類序列化為JSON文本的能力，簡直無情。

基本類型

如果只需要進行序列化，那么在定義Model類時，不需要做任何特殊的改動。任何一個類的實例，直接調用HandyJSON的序列化方法去序列化，就能得到JSON字符串了。

class Animal { 
    var name: String? 
    var height: Int? 
 
    init(name: String, height: Int) { 
        self.name = name 
        self.height = height 
    } 
} 
 
let cat = Animal(name: "cat", height: 30) 
 
// 序列化為簡單JSON文本 
if let jsonStr = JSONSerializer.serialize(model: cat).toJSON() { 
    print("simple json string: ", jsonStr) 
} 
 
// 序列化為格式化的JSON文本 
if let prettifyJSON = JSONSerializer.serialize(model: cat).toPrettifyJSON() { 
    print("prettify json string: ", prettifyJSON) 
} 
 
// 序列化為簡單字典 
if let dict = JSONSerializer.serialize(model: cat).toSimpleDictionary() { 
    print("dictionary: ", dict) 
} 

復雜類型

即使Model類中有別的Model類啥的，都一樣支持。

enum Gender { 
    case Male 
    case Female 
} 
 
struct Subject { 
    var id: Int64? 
    var name: String? 
 
    init(id: Int64, name: String) { 
        self.id = id 
        self.name = name 
    } 
} 
 
class Student { 
    var name: String? 
    var gender: Gender? 
    var subjects: [Subject]? 
} 
 
let student = Student() 
student.name = "Jack" 
student.gender = .Female 
student.subjects = [Subject(id: 1, name: "math"), Subject(id: 2, name: "English"), Subject(id: 3, name: "Philosophy")] 
 
if let jsonStr = JSONSerializer.serialize(model: student).toJSON() { 
    print("simple json string: ", jsonStr) 
} 
if let prettifyJSON = JSONSerializer.serialize(model: student).toPrettifyJSON() { 
    print("prettify json string: ", prettifyJSON) 
} 
if let dict = JSONSerializer.serialize(model: student).toSimpleDictionary() { 
    print("dictionary: ", dict) 
} 

總結

有了HandyJSON的支持，現在我們可以開心地在Swift中使用JSON了。這個庫支持了Swift 2.2+， Swift 3.0+。如果大家有什么需求或者建議，可以去 https://github.com/alibaba/handyjson 提issue.

為何開發HandyJSON

我所在iOS團隊是從去年11月份切Swift的。我們服務端和客戶端數據交互格式一直用的是JSON，而當時Swift中處理JSON名氣比較大的庫貌似只有SwiftyJSON，工程切到Swift后，我們也用了這個庫。用上之后，需求是滿足了，但是對一些復雜的Model，代碼寫得看起來非常糟糕，因為每次取值都需要 json["akey"]["bkey"]["ckey"].value 形式，寫的時候對著文檔沒覺得啥問題，但過后在脫離文檔的情況下，通篇都是字符串表達的key，很難從代碼中感覺出Model結構。所以我們都會把一段sample數據寫在注釋里。但仍然比較凌亂，另外key寫錯了debug起來也費勁，一個大小寫問題有時候debug半天。

于是我們進化了一下，先寫好Model，然后Model類中寫convert函數，也用上了KVC遍歷key賦值。寫起來舒服多了，但還是麻煩，而且要求每一個類都繼承自NSObject。不久后，我們認識了ObjectMapper庫，二話不說，就換了上去。世界頓時干凈多了。

但還是感覺差了一點，因為ObjectMapper需要自己指明映射關系。通常JSON中key和Model中字段名都是一致的，每次都要額外寫一坨東西，總覺得多余，字段有改動的時候也費勁。新來剛接觸Swift的同事，也表示不太舒服，因為他們之前使用的JSON反序列化庫，無論Java中還是Objective-C中，都是自然使用Model字段名去取值的。

所以就想著研究一下，Swift中能不能做到這種效果。

HandyJSON的設計思路

Swift中存在的限制

無論是Java或者Objective-C中的JSON反序列化庫，通常都是，在運行時獲取Model的字段名集合，遍歷該集合，拿Key去JSON中取值并完成賦值。這些步驟，Java依賴反射機制可以實現，Objective-C通過class_copyPropertyList方法加上KVC機制，也能輕松實現。而Swift會卡在***一步：無法賦值。

Swift的反射是只讀的，就是說，我們能在運行時獲取一個Model實例的所有字段、字段值，但卻無法給它賦值。事實上，我們拿到的value是原值的一個只讀拷貝，即使獲取到這個拷貝的地址寫入新值，也是無效的。

class Animal { 
    var name: String? 
} 
 
Mirror(reflecting: Animal()).children.forEach { (child) in 
    print(child.label ?? "", child.value) // working correctly 
    child.value = "cat" // error，不能直接賦值 
} 

而且迄今，蘋果官網文檔上對實現反射機制的Mirror類仍然是這么描述： Mirrors are used by playgrounds and the debugger，態度非常含糊，似乎不太鼓勵，但生產中很多類庫都用上了。只能說，蘋果不會輕易撤下這個能力，但期待它對這個能力做出改進(比如支持運行時賦值)，是希望渺茫的。

如何繞過限制

最簡單的方式，就是在Swift中定義Model時繼承NSObject，讓這個Model的實例存在于objc運行時中，上述的class_copyPropertyList方法和KVC就能用上了。目前看見的Swift中不需要指明映射關系的JSON庫，都是這種方式。

然后就是以ObjectMapper為代表的庫，通過運算符重載，在指定映射關系時完成賦值。走這一類實現的庫也非常多了。

但我想做到的是，既支持運行在Swift運行時的純Swift類，又不需要顯示指定每一個字段的映射關系。那么，不能走反射賦值，那就直接寫入內存吧。

具體實現

Swift中，一個類實例的內存布局是有規律的：

• 32位機器上，類前面有4+8個字節存儲meta信息，64位機器上，有8+8個字節;
• 內存中，字段從前往后有序排列;
• 如果該類繼承自某一個類，那么父類的字段在前;
• Optional會增加一個字節來存儲.None/.Some信息;
• 每個字段需要考慮內存對齊;

這方面基本沒有官方的資料參考，上述規律一些是從網上其他大神的總結中收集，一些從Clang的一些說明文檔中挖掘，還有一些是自己在playground里試出來的。開始心里沒什么底，但把HandyJSON實現出來使用這么久了，還沒出過狀況，可以認為是靠譜的。

有法子計算內存布局，剩下的事情就比較簡單了。對一個實例:

• 獲取它的起始指針，移動到有效起點;
• 通過Mirror獲取每一個字段的字段名和字段類型;
• 根據字段名在JSON中取值，轉換為和字段一樣的類型，通過指針寫入;
• 根據本字段類型的占位大小和下一個字段類型計算下一個字段的對齊起點;
• 移動指針，繼續處理;

獲取類實例的起始指針

Swift中，獲取struct實例起始指針和獲取class實例起始指針的方法是不一樣的，和語言版本也相關。在Swift3中：

// 獲取struct實例起始指針 
mutating func headPointerOfStruct() -> UnsafeMutablePointer<Byte> { 
 
    return withUnsafeMutablePointer(to: &self) { 
        return UnsafeMutableRawPointer($0).bindMemory(to: Byte.self, capacity: MemoryLayout<Self>.stride) 
    } 
} 
 
// 獲取class實例起始指針 
mutating func headPointerOfClass() -> UnsafeMutablePointer<Byte> { 
 
    let opaquePointer = Unmanaged.passUnretained(self as AnyObject).toOpaque() 
    let mutableTypedPointer = opaquePointer.bindMemory(to: Byte.self, capacity: MemoryLayout<Self>.stride) 
    return UnsafeMutablePointer<Byte>(mutableTypedPointer) 
} 

通過Mirror獲取字段名、類型

Mirror(reflecting: Animal()).children.forEach { (child) in 
    print(child.label ?? "") // 獲取字段名 
    print(type(of: child.value)) // 獲取字段類型 
} 

計算Model的每個屬性字段占位大小

Swift3暴露了兩個接口用于計算類型占位大小：MemoryLayout.size(ofValue: T)和MemoryLayout.size。這兩者都沒辦法直接用，因為：

• 對于每個屬性，我們目前只持有它的起始指針，而不是它的實例，***個接口用不上;
• 對于每個屬性，我們是在運行時中獲取到它的類型，已經沒辦法再實例化出泛型類型MemoryLayout<T>來計算size。所以，我引入了HandyJSON類，在擴展中實現函數：

protocol HandyJSON { 
} 
 
extension HandyJSON { 
    static func size() -> Int { 
        return MemoryLayout<Self>.size 
    } 
} 

于是，對于每一個實現HandyJSON協議的Model類T，直接調用 T.size() 就能獲取到T的size了。

內存對齊的影響

類實例的屬性并不是直接按照各自占位大小依次往下排列的，不然事情就簡單了。和C/C++一樣，Swift中實例內存布局也考慮了內存對齊。翻閱了Swift的docs和LLVM的一些資料，MemoryLayout提供了一個接口：MemoryLayout.alignment，對齊的規則為，每個字段的起始地址必須為alignment值的整數倍。細節的出處我已經忘記。當時進行了一些復雜類型的測試后，認定它符合事實。所以HandyJSON中計算下一個字段起始地址的函數為：

// Returns the offset to the next integer that is greater than 
// or equal to Value and is a multiple of Align. Align must be 
// non-zero. 
static func offsetToAlignment(value: Int, align: Int) -> Int { 
    let m = value % align 
    return m == 0 ? 0 : (align - m) 
} 

其他情況

基本類型按照上述方法處理就可以了，還有可選類型、數組類型、字典類型，通過遍歷、遞歸解析等方式，處理方法也類似。如數組：

extension Array: ArrayTypeProtocol { 
    static func getWrappedType() -> Any.Type { 
        return Element.self 
    } 
 
    static func castArrayType(arr: [Any]) -> Array<Element> { 
        return arr.map({ (p) -> Element in 
            return p as! Element 
        }) 
    } 
} 

獲取到Array泛型實參類型，然后構造出該類型的一個數組，完成賦值就可以了。

結語

主要流程就是這樣了，也比較簡單，剩下處理繼承、組合等情況，只是實現問題，就不再贅述了。總覺得自己對Swift指針這一套設施理解還不是很到位，也許有更好的用法，比如說，完全不需要空的init()函數就可以初始化出一個類的實例。有同學在這方面有更深入理解，有什么意見或者建議的，歡迎交流~

參考

• https://appventure.me/2015/10/24/swift-reflection-api-what-you-can-do/
• https://www.raywenderlich.com/119881/enums-structs-and-classes-in-swift
• http://vizlabxt.github.io/blog/2014/12/23/Swift-Memory/
• https://realm.io/news/russ-bishop-unsafe-swift/
• http://sketchytech.blogspot.jp/2014/10/becoming-less-afraid-of-unsafe-mutable.html
• http://southpeak.github.io/blog/2014/07/06/ios-swift-cpointer-2/
• https://onevcat.com/2015/01/swift-pointer/
• https://appventure.me/2015/10/17/advanced-practical-enum-examples/
• https://github.com/Hearst-DD/ObjectMapper