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
//www.greatytc.com/p/9ca7529306b2

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,941评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,397评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,345评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,851评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,868评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,688评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,414评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,319评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,775评论 1 315
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,945评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,096评论 1 350
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,789评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,437评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,993评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,107评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,308评论 3 372
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,037评论 2 355

推荐阅读更多精彩内容