KakaJSON 底層實現分析

1.代碼結構

2.JSON解析出Model具體的流程

下面是官方demo的例子,我們拿此例子解析

import KakaJSON
struct Repo: Convertible {
      var name: String?
      var url: URL?
}
let json = [
            "name": "KakaJSON",
            "url": "https://github.com/kakaopensource/KakaJSON"
]
let repo = json.kj.model(Repo.self)
print(repo)
流程
1)調用json字典的kj屬性
public extension KJGenericCompatible {
    static var kj: KJGeneric<Self, T>.Type {
        get { return KJGeneric<Self, T>.self }
        set {}
    }
    var kj: KJGeneric<Self, T> {
        get { return KJGeneric(self) }
        set {}
    }
}
2)Base是一個字典,調用model方法
public extension KJGeneric where Base == [String: T] {
    /// JSONObject -> Model
    func model<M: Convertible>(_ type: M.Type) -> M {
        return model(type: type) as! M
    }
    
    /// JSONObject -> Model
    func model(type: Convertible.Type) -> Convertible {
        return base.kj_fastModel(type)
    }
}
3)調用Base的kj_fastModel方法
extension Dictionary where Key == String {
    func kj_fastModel(_ type: Convertible.Type) -> Convertible {
        var model: Convertible
        if let ns = type as? NSObject.Type {
            model = ns.newConvertible()
        } else {
            model = type.init()
        }
        model.kj_convert(from: self)
        return model
     }
........
}
4)賦值操作核心代碼
mutating func kj_convert(from json: [String: Any]) {
        guard let mt = Metadata.type(self) as? ModelType else {
            Logger.warnning("Not a class or struct instance.")
            return
        }
        guard let properties = mt.properties else {
            Logger.warnning("Don't have any property.")
            return
        }
        
        // get data address
        let model = _ptr()
        
        kj_willConvertToModel(from: json)
        
        // enumerate properties
        for property in properties {
            // key filter
            let key = mt.modelKey(from: property.name,
                                  kj_modelKey(from: property))
            
            // value filter
            guard let newValue = kj_modelValue(
                from: json.kj_value(for: key),
                property)~! else { continue }
            
            let propertyType = property.dataType
            // if they are the same type, set value directly
            if Swift.type(of: newValue) == propertyType {
                property.set(newValue, for: model)
                continue
            }
            
            // Model Type have priority
            // it can return subclass object to match superclass type
            if let modelType = kj_modelType(from: newValue, property),
                let value = _modelTypeValue(newValue, modelType, propertyType) {
                property.set(value, for: model)
                continue
            }
            
            // try to convert newValue to propertyType
            guard let value = Values.value(newValue,
                                           propertyType,
                                           property.get(from: model)) else {
                property.set(newValue, for: model)
                continue
            }
            
            property.set(value, for: model)
        }
        
        kj_didConvertToModel(from: json)
    }

幾個代碼點需要著重分析理解下

1)guard let mt = Metadata.type(self) as? ModelType

Metadata.type(self)是獲取當前model的類型BaseType

首先我們看下各種Type的繼承關系圖:

我們定義的model要么是類class要么是結構體struct,它們都繼承ModelType,所以這里判斷model的類型是ClassType或者StructType,如果定義的model不是這2種Type,提示錯誤信息并return。

從Type繼承圖關系可以看到還有很多其它Type類型,如元組這種類型等,主要應用于model定義的存儲屬性,所以這里要區分開,不要搞混了。

2)let model = _ptr()

這里的model是當前定義的模型實例地址即指針,是UnsafeMutableRawPointer類型,后面在進行set賦值的時候會通過運算符重載將其轉換為UnsafeMutablePointer<T>指針類型。

3)for property in properties {}

遍歷定義的存儲屬性,對每一個存儲屬性進行賦值
具體分析下里面的賦值代碼:

a)、

// 這里是獲取key,返回的key是一個字符串或者數組
let key = mt.modelKey(from: property.name,kj_modelKey(from: property))

底層方法調用流程圖:


b)、

// 將json值轉換為用戶自定義model里面實現kj_modelValue方法的值,如果用戶沒有實現kj_modelValue,那么直接返回jsonValue
guard let newValue = kj_modelValue(
                from: json.kj_value(for: key),
                property)~! else { continue }

底層方法調用流程圖:


c)、

// 如果它們類型相同直接賦值,比如Any.Type和String.Type是不相等的,比如用戶類型寫錯了或者也沒有實現kj_modelValue方法,類型無法匹配
if Swift.type(of: newValue) == propertyType {
    // 會把指針model傳入會被轉換為UnsafeMutablePointer<T>類型進行賦值操作
    property.set(newValue, for: model)
    continue
}

核心賦值操作都是調用property.set(newValue, for: model),我們分析下底層這里是如何實現的:

為了能更直觀的展示調用過程,我們這里還是用流程圖:


看完這里你是不是會有一個疑問,就是如果類型不匹配怎么辦,即應該有類型失敗的一個判斷,比如我們定義的存儲屬性是String,但是json返回的是一個Array數組?看流程圖的最后一步,as?就是類型轉換的一個判斷,如果類型不匹配是不會通過指針寫入內存的。
d)、

// 如果上面都還沒有賦值成功,那么就進行類型轉換
guard let value = Values.value(newValue,
                               propertyType,
                               property.get(from: model)) else {
    // 類型轉換失敗,用newValue直接進行賦值,如果失敗交給as?去處理
    property.set(newValue, for: model)
    continue
}

e)、

kj_willConvertToModel(from: json)
kj_didConvertToModel(from: json)

當有需要監聽轉換過程,可實現這2個方法

至此整個JSON解析過程我們就分析完了

很多時候我們在看一些第三方庫源碼的時候有時候會云里霧里的,這個時候可再去看看作者在github上面介紹的這個庫的功能點,你就能豁然開朗,因為我們平時在項目中用的時候并不是所有功能點都能用到,看實際需求。

參考文獻:

https://github.com/kakaopensource/KakaJSON
http://www.lxweimin.com/p/9ca7529306b2

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,546評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,570評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 176,505評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,017評論 1 313
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,786評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,219評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,287評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,438評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,971評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,796評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,995評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,540評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,230評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,918評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,697評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374

推薦閱讀更多精彩內容