早早就說好要分享一下HandyJSON的實現(xiàn)思路了，今天總算有點時間，這里就記錄一下吧。

背景

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

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

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

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

Swift中存在的限制

無論是Java或者Objective-C中的JSON反序列化庫，通常都是，在運行時獲取Model的字段名集合，遍歷該集合，拿Key去JSON中取值并完成賦值。這些步驟，Java依賴反射機制可以實現(xiàn)，Objective-C通過class_copyPropertyList方法加上KVC機制，也能輕松實現(xiàn)。而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，不能直接賦值
}

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

如何繞過限制

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

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

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

具體實現(xiàn)

Swift中，一個類實例的內(nèi)存布局是有規(guī)律的：

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

這方面尚未從官方的資料找到參考，上述規(guī)律一些是從網(wǎng)上其他大神的總結(jié)中收集，一些從Clang的一些說明文檔中挖掘，加上自己的反復驗證得到。

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

1. 獲取它的起始指針，移動到有效起點；
2. 通過Mirror獲取每一個字段的字段名和字段類型；
3. 根據(jù)字段名在JSON中取值，轉(zhuǎn)換為和字段一樣的類型，通過指針寫入；
4. 根據(jù)本字段類型的占位大小和下一個字段類型計算下一個字段的對齊起點；
5. 移動指針，繼續(xù)處理；

操作步驟

獲取類實例的起始指針

Swift中，獲取struct實例起始指針和獲取class實例起始指針的方法是不一樣的，和語言版本也相關(guān)。在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<T>.size。這兩者都沒辦法直接用，因為：

1. 對于每個屬性，我們目前只持有它的起始指針，而不是它的實例，第一個接口用不上；
2. 對于每個屬性，我們是在運行時中獲取到它的類型，已經(jīng)沒辦法再實例化出泛型類型MemoryLayout<T>來計算size。所以，我引入了HandyJSON類，在擴展中實現(xiàn)函數(shù)：

protocol HandyJSON {
}

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

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

內(nèi)存對齊的影響

類實例的屬性并不是直接按照各自占位大小依次往下排列的，不然事情就簡單了。和C/C++一樣，Swift中實例內(nèi)存布局也考慮了內(nèi)存對齊。翻閱了Swift的docs和LLVM的一些資料，MemoryLayout提供了一個接口：MemoryLayout<T>.alignment，對齊的規(guī)則為，每個字段的起始地址必須為alignment值的整數(shù)倍。細節(jié)的出處我一下子找不到了。那么，HandyJSON中計算下一個字段起始地址的函數(shù)為：

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

其他情況

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

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泛型實參類型，然后構(gòu)造出該類型的一個數(shù)組，完成賦值就可以了。

結(jié)語

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

參考

• The Swift Reflection API and what you can do with it
• Getting to Know Enums, Structs and Classes in Swift
• Behind Swift Object
• Unsafe Swift: For Fun & Profit
• Becoming less afraid of unsafe mutable pointers in Swift
• Swift對C指針實現(xiàn)淺析
• Swift 中的指針使用
• Advanced & Practical Enum usage in Swift
• SwiftJSON
• ObjectMapper