美文网首页
KakaJSON 底层实现分析

KakaJSON 底层实现分析

作者: 精神薇 | 来源:发表于2022-08-31 21:22 被阅读0次

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
https://www.jianshu.com/p/9ca7529306b2

相关文章

网友评论

      本文标题:KakaJSON 底层实现分析

      本文链接:https://www.haomeiwen.com/subject/ywidnrtx.html