KakaJSON源码浅析(一)

作者: eeybee | 来源:发表于2020-11-11 16:11 被阅读0次

    目前github上比较常见的Swift版本JSON解析库有:

    • ObjectMapper

      底层实现主要是通过运算符重载机制,需要手动对每一个属性写映射关系,比较繁琐。

      struct Temperature: Mappable {
          var celsius: Double?
          var fahrenheit: Double?
      
          init?(map: Map) {
      
          }
      
          mutating func mapping(map: Map) {
              celsius   <- map["celsius"]
              fahrenheit    <- map["fahrenheit"]
          }
      }
      
    • SwiftyJSON

      每次取值都需要通过下标,也比较繁琐并且容易出错,底层实现主要是通过JSONSerialization相关api转成字典。

      // Getting a string from a JSON Dictionary
      let name = json["name"].stringValue
      
    • HandyJSON(推荐使用)

      阿里推出的库,刚开始的版本使用了反射机制Mirror类,苹果并不鼓励使用,有性能方面的问题,后面也弃用了,引入了reflection这个库的源码并做了改动,用来实现类属性解析的功能。

      struct BasicTypes: HandyJSON {
          var int: Int = 2
          var doubleOptional: Double?
          var stringImplicitlyUnwrapped: String!
      }
      
      let jsonString = "{\"doubleOptional\":1.1,\"stringImplicitlyUnwrapped\":\"hello\",\"int\":1}"
      if let object = BasicTypes.deserialize(from: jsonString) {
          // …
      }
      
    • KakaJSON(推荐使用)

    后面出来的MJ开源的一个库,充分运用了Swift协议、运算符重载、指针、metadata等技术,支持多种数据格式,比较完善;建议有时间可以仔细看看底层源码的实现,源码到处都是协议。

    struct Cat: Convertible {
        var name: String = ""
        var weight: Double = 0.0
    }
    
    // json can also be NSDictionary, NSMutableDictionary
    let json: [String: Any] = [
        "name": "Miaomiao",
        "weight": 6.66
    ]
    
    let cat1 = json.kj.model(Cat.self)
    
    1、代码结构
    image-20201109184222955.png

    这个代码结构,可以帮助我们大概的理解下各个主要代码模块是干啥的,对于有需要了解核心模块实现原理就可着重看看这块。

    2、JSON解析出Model具体的流程

    我们这里为了能够快速调试出解析流程,model里面暂时只定义一个存储属性,多个属性或者其它model类型是类似的原理。

    import KakaJSON
    struct KKModel: Convertible {
        //var args: Any?
        //var headers: [String: Any]?
        //var origin: String?
        var url: String?
    }
    
    // 这里value是Alamofire返回的json数据
    if let model = (value as? [String: Any])?.kj.model(KKModel.self) {
        print("解析model成功", model)
    }
    

    通过调试后可以得到如下的解析流程图:

    image-20201110162040595.png

    分析下这里赋值操作的核心代码

    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)
            
            for property in properties {
                // key filter
                let key = mt.modelKey(from: property.name,
                                      kj_modelKey(from: property)) 
                
                guard let newValue = kj_modelValue(
                    from: json.kj_value(for: key),
                    property)~! else { continue }
                
                let propertyType = property.dataType
                
                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的继承关系图:

    image-20201110170358458.png

    我们定义的model要么是类class要么是结构体struct,它们都继承ModelType,所以这里判断model的类型是ClassType或者StructType,如果定义的model不是这2种Type,提示错误信息并return。

    从Type继承图关系可以看到还有很多其它Type类型,如元组、CFArray这种类型等,主要应用于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))
    

    底层方法调用流程图:

    image-20201111143119277.png

    b)、

    // 将json值转换为用户自定义model里面实现kj_modelValue方法的值,如果用户没有实现kj_modelValue,那么直接返回jsonValue
    guard let newValue = kj_modelValue(
                    from: json.kj_value(for: key),
                    property)~! else { continue }
    

    底层方法调用流程图:

    image-20201111145409606.png

    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),我们分析下底层这里是如何实现的:

    为了能更直观的展示调用过程,我们这里还是用流程图:

    image-20201111151712792.png

    看完这里你是不是会有一个疑问,就是如果类型不匹配怎么办,即应该有类型失败的一个判断,比如我们定义的存储属性是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://github.com/alibaba/HandyJSON

    相关文章

      网友评论

        本文标题:KakaJSON源码浅析(一)

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