从YYModel源码分析JSON解析原理

发表于 3年以前 | 总阅读数：279 次

YYModel是我们常用的一个解析JSON数据的高性能的框架，但是很多时候我们只停留在了使用层面，并没有对底层的原理进行深入的了解，所以笔者将对YYModel的源码进行细致的解读，带领大家共同学习通过Runtime实现JSON解析的过程。

首先，YYModel的性能作者给出过一个图表，由此可以看出，YYModel是一个高性能的轻量级Model生成工具。

YYModel的使用方法网上有很多介绍就不多介绍了，接下来让我们一起来看看YYModel的源码吧，据说这是ibireme大神用了两个周末写出来的…………

YYModel主要包括五个文件，接下来将逐一分析

YYModel.h
NSObject+YYModel.h
NSObject+YYModel.m
YYClassInfo.h
YYClassInfo.m

YYModel.h

其中YYModel.h主要是一些头文件，


#if __has_include(<YYModel/YYModel.h>)
FOUNDATION_EXPORT double YYModelVersionNumber;
FOUNDATION_EXPORT const unsigned char YYModelVersionString[];
#import <YYModel/NSObject+YYModel.h>
#import <YYModel/YYClassInfo.h>
#else
#import "NSObject+YYModel.h"
#import "YYClassInfo.h"
#endif

__has_include是个内置函数用来判断头文件是否存在，也就是从当前项目路径导入头文件，或者直接到系统中配置的头文件路径去找到头文件导入。
FOUNDATION_EXPORT是定义常量的意思，那么可以看到YYModelVersionNumber和YYModelVersionString就是存版本号的

YYClassInfo.m

接下来看下YYClassInfo.m，这个类主要是定义YYClassInfo类，其中包括了一个方法YYEncodingGetType和4个类

YYClassIvarInfo
YYClassMethodInfo
YYClassPropertyInfo
YYClassInfo

根据runtime的知识我们来看

YYEncodingGetType自定义了实例变量Ivar的类型，返回的是YYEncodingType
YYClassIvarInfo定义了实例变量的类，定义了实例变量的Ivar类型的结构体，名称，偏移量，类型编码及类型编码对应的YYEncodingType类型
YYClassMethodInfo是方法类包括：Method方法，方法名称，sel，imp，typeEncoding是方法的type encoding类型有参数类型和returnTypeEncoding返回值类型，还有个数组argumentTypeEncodings存放每个参数的类型
YYClassPropertyInfo是属性信息的类：包括属性名称，类型，编码类型实例变量名称，类，存放协议的数据，还有getter和setter方法
最后是主要的YYClassInfo类信息，前面三个类是定义的是这个YYClassInfo类的实例变量信息，方法信息和属性信息，除此之外还有类信息，父类，元类（metaCls），是否为元类，类的名称等

注意元类就是一个类对象的类，可以参考浅谈 Objective-C 中的元类 (meta-class)

NSObject+YYModel.m

定义了一些类型解析方法、_YYModelPropertyMeta类、_YYModelMeta和三个分类

static force_inline NSNumber *YYNSNumberCreateFromID(__unsafe_unretained id value)//将任意id类型的数据解析为NSNumber，主要是将NSString类型的数据转成UTF8编码后将其转换为NSNumber
static force_inline NSDate *YYNSDateFromString(__unsafe_unretained NSString *string)//NSString类型的日期解析成NSDate类型

_YYModelPropertyMeta是YYmodel属性的元类，其中包括属性的名称、类型、是否是C语言类型数值isCNumber、属性的类型cls及getter和setter方法等
_YYModelMeta是YYmodel的元类，包括YYClassInfo类信息、字典类型的mapper也是key值和属性值映射关系、_allPropertyMetas所有属性元类数组、_keyPathPropertyMetas装有有映射关系的属性元类数组、_multiKeysPropertyMetas多个key值映射的属性元类数组（有的属性可能会映射多个key值）和_keyMappedCount映射的数量

定义这两个元类是因为当你向一个类发送一条消息的时候，运行时会在类的元类的方法列表中查找这条消息是否存在，也就是可以调用我们在元类中定义的方法。

创建`_YYModelMeta`这个元类的时候都做了些什么呢：

首先创建YYClassInfo类的基本信息
然后遍历YYClassInfo类信息的所有属性创建所有属性的属性元类meta（_YYModelPropertyMeta *meta）
创建映射关系，根据定义的modelCustomPropertyMapper，对映射customMapper中的每个属性名取到属性元类，设置属性元的映射值（propertyMeta->_mappedToKey）和映射KeyPath（propertyMeta->_mappedToKeyPath）

三个分类分别是`NSObject`，`NSArray`和`NSDictionary`的分类，其中实现了三种数据类型转换成model的方法，接下来我们看下这三个分类：

NSObject (YYModel)

这是个NSObject的分类，其中实现了data和model之间相互转换的方法（yy_modelWithJSON）

//JSON转model
+ (instancetype)yy_modelWithJSON:(id)json {
    NSDictionary *dic = [self _yy_dictionaryWithJSON:json];
    return [self yy_modelWithDictionary:dic];
}

从yy_modelWithJSON方法中我们可以看出，核心的代码就是_yy_dictionaryWithJSON和yy_modelWithDictionary方法，那么接下来我们看这两个方法:

//JSON转字典
+ (NSDictionary *)_yy_dictionaryWithJSON:(id)json {
    //首先对JSON进行非空判断
    if (!json || json == (id)kCFNull) return nil;
    NSDictionary *dic = nil;
    NSData *jsonData = nil;
    //判断JSON的类型(三种类型NSDictionary，NSString和NSData)
    if ([json isKindOfClass:[NSDictionary class]]) {
        dic = json;
    } else if ([json isKindOfClass:[NSString class]]) {
        //对NSString类型的数据进行UTF8编码
        jsonData = [(NSString *)json dataUsingEncoding : NSUTF8StringEncoding];
    } else if ([json isKindOfClass:[NSData class]]) {
        jsonData = json;
    }
    if (jsonData) {
        //将jsonData转为字典
        dic = [NSJSONSerialization JSONObjectWithData:jsonData options:kNilOptions error:NULL];
        if (![dic isKindOfClass:[NSDictionary class]]) dic = nil;
    }
    return dic;
}

从代码可以看出_yy_dictionaryWithJSON流程是：

首先对JSON进行非空判断
判断JSON的类型，对NSString类型的数据进行UTF8编码
对NSStirng和NSData类型的数据使用苹果自带的NSJSONSerialization将JSON串转化为字典

NSJSONSerialization可以将JSON数据转换为Foundation对象（一般都是NSDictionary和NSArray）和Foundation对象转换为JSON数据

//字典转model
+ (instancetype)yy_modelWithDictionary:(NSDictionary *)dictionary {
    //首先对字典进行非空判断
    if (!dictionary || dictionary == (id)kCFNull) return nil;
    if (![dictionary isKindOfClass:[NSDictionary class]]) return nil;
    //创建_YYModelMeta对象
    Class cls = [self class];
    _YYModelMeta *modelMeta = [_YYModelMeta metaWithClass:cls];
    //如果有自定义的modelCustomPropertyMapper映射关系则返回这种类型的cls
    if (modelMeta->_hasCustomClassFromDictionary) {
        cls = [cls modelCustomClassForDictionary:dictionary] ?: cls;
    }
    //创建YYmodel并调用yy_modelSetWithDictionary初始化模型
    NSObject *one = [cls new];
    if ([one yy_modelSetWithDictionary:dictionary]) return one;
    return nil;
}

从代码可以看出yy_modelWithDictionary字典转model流程是：

首先对字典进行非空判断
创建_YYModelMeta对象，如果有自定义的modelCustomPropertyMapper映射关系则返回这种类型的cls
根据cls创建YYmodel
调用yy_modelSetWithDictionary初始化模型

yy_modelSetWithDictionary是关键方法，源码如下：

- (BOOL)yy_modelSetWithDictionary:(NSDictionary *)dic {
    // 判断类型非空
    if (!dic || dic == (id)kCFNull) return NO;
    if (![dic isKindOfClass:[NSDictionary class]]) return NO;

    // 创建Modelmeta对象
    _YYModelMeta *modelMeta = [_YYModelMeta metaWithClass:object_getClass(self)];
    // 如果有定义映射关系则继续
    if (modelMeta->_keyMappedCount == 0) return NO;
    // YYModel协议方法
    if (modelMeta->_hasCustomWillTransformFromDictionary) {
        dic = [((id<YYModel>)self) modelCustomWillTransformFromDictionary:dic];
        if (![dic isKindOfClass:[NSDictionary class]]) return NO;
    }
    // 创建结构体，ModelSetContext是定义的一个结构体，包含模型元_YYModelMeta，模型实例id (self)和待处理字典NSDictionary
    ModelSetContext context = {0};
    context.modelMeta = (__bridge void *)(modelMeta);
    context.model = (__bridge void *)(self);
    context.dictionary = (__bridge void *)(dic);

    // 模型元值数量应大于等于字典数量关系，FDictionaryGetCount((CFDictionaryRef)dic)返回字典值的数量
    if (modelMeta->_keyMappedCount >= CFDictionaryGetCount((CFDictionaryRef)dic)) {

        // 对字典中的每个值调用ModelSetWithDictionaryFunction方法
        CFDictionaryApplyFunction((CFDictionaryRef)dic, ModelSetWithDictionaryFunction, &context);

        // 如果存在映射keyPath属性元数组，对数组中的每个keypath都执行ModelSetWithPropertyMetaArrayFunction
        if (modelMeta->_keyPathPropertyMetas) {
            CFArrayApplyFunction((CFArrayRef)modelMeta->_keyPathPropertyMetas,
                                 CFRangeMake(0, CFArrayGetCount((CFArrayRef)modelMeta->_keyPathPropertyMetas)),
                                 ModelSetWithPropertyMetaArrayFunction,
                                 &context);
        }
        // 如果存在key值映射的属性元类数组，对数组中的每个keypath都执行ModelSetWithPropertyMetaArrayFunction
        if (modelMeta->_multiKeysPropertyMetas) {
            CFArrayApplyFunction((CFArrayRef)modelMeta->_multiKeysPropertyMetas,
                                 CFRangeMake(0, CFArrayGetCount((CFArrayRef)modelMeta->_multiKeysPropertyMetas)),
                                 ModelSetWithPropertyMetaArrayFunction,
                                 &context);
        }

    } else {
        // 每个keypath都执行ModelSetWithPropertyMetaArrayFunction
        CFArrayApplyFunction((CFArrayRef)modelMeta->_allPropertyMetas,
                             CFRangeMake(0, modelMeta->_keyMappedCount),
                             ModelSetWithPropertyMetaArrayFunction,
                             &context);
    }
    if (modelMeta->_hasCustomTransformFromDictionary) {
        return [((id<YYModel>)self) modelCustomTransformFromDictionary:dic];
    }
    return YES;
}

ModelSetWithDictionaryFunction和ModelSetWithPropertyMetaArrayFunction的核心方法都是ModelSetValueForProperty，代码如下：

static void ModelSetWithDictionaryFunction(const void *_key, const void *_value, void *_context) {
    ModelSetContext *context = _context;
    //模型元
    __unsafe_unretained _YYModelMeta *meta = (__bridge _YYModelMeta *)(context->modelMeta);
    //属性元赋值，根据mapper中的key值对应的value
    __unsafe_unretained _YYModelPropertyMeta *propertyMeta = [meta->_mapper objectForKey:(__bridge id)(_key)];
    __unsafe_unretained id model = (__bridge id)(context->model);
    while (propertyMeta) {
        if (propertyMeta->_setter) {
        //ModelSetValueForProperty转换
            ModelSetValueForProperty(model, (__bridge __unsafe_unretained id)_value, propertyMeta);
        }
        propertyMeta = propertyMeta->_next;
    };
}

ModelSetValueForProperty通过runtime的函数objc_msgSend给meta的setter函数传递相应的value值，这个函数里包括很多种类型的处理，都是通过objc_msgSend方法发消息进行赋值

其中id objc_msgSend(id self, SEL op, ...)这是一个参数个数可变的函数，能够接收两个或者两个以上的参数，第一个参数代表接受者第二个参数是区分方法的ID，后续参数就是消息中的那些参数，其顺序不变。

static void ModelSetValueForProperty(__unsafe_unretained id model,
                                     __unsafe_unretained id value,
                                     __unsafe_unretained _YYModelPropertyMeta *meta) {
    if (meta->_isCNumber) {
        NSNumber *num = YYNSNumberCreateFromID(value);
        ModelSetNumberToProperty(model, num, meta);
        if (num != nil) [num class]; // hold the number
    } else if (meta->_nsType) {
        if (value == (id)kCFNull) {
            ((void (*)(id, SEL, id))(void *) objc_msgSend)((id)model, meta->_setter, (id)nil);
        } else {
            switch (meta->_nsType) {
                case YYEncodingTypeNSString:
                case YYEncodingTypeNSMutableString: {
                    if ([value isKindOfClass:[NSString class]]) {
                        if (meta->_nsType == YYEncodingTypeNSString) {
                            ((void (*)(id, SEL, id))(void *) objc_msgSend)((id)model, meta->_setter, value);
                        } else {
                            ((void (*)(id, SEL, id))(void *) objc_msgSend)((id)model, meta->_setter, ((NSString *)value).mutableCopy);
                        }
                    }
                    ......

从代码可以看出ModelSetValueForProperty实现的逻辑：

元类型isCNumber是C语言类型, nsType和其他类型来区分处理
isCNumber此时调用方法ModelSetNumberToPorperty，该方法也是通过objc_msgSend发消息，将NSNumber值传给model的属性元的setter函数
nsType是YYEncodingNSType枚举类型，枚举YYEncodingNSType所有的类型，对不同的类型进行处理
最后是处理其他情况

NSArray (YYModel)

NSArray分类

//JSON转modelArray
+ (NSArray *)yy_modelArrayWithClass:(Class)cls json:(id)json;
//数组转modelArray
+ (NSArray *)yy_modelArrayWithClass:(Class)cls array:(NSArray *)arr ;

@implementation NSArray (YYModel)

+ (NSArray *)yy_modelArrayWithClass:(Class)cls json:(id)json {
    if (!json) return nil;
    NSArray *arr = nil;
    NSData *jsonData = nil;
    if ([json isKindOfClass:[NSArray class]]) {
        arr = json;
    } else if ([json isKindOfClass:[NSString class]]) {
        jsonData = [(NSString *)json dataUsingEncoding : NSUTF8StringEncoding];
    } else if ([json isKindOfClass:[NSData class]]) {
        jsonData = json;
    }
    if (jsonData) {
        //调用NSJSONSerialization将JSON数据转换为NSArray对象
        arr = [NSJSONSerialization JSONObjectWithData:jsonData options:kNilOptions error:NULL];
        if (![arr isKindOfClass:[NSArray class]]) arr = nil;
    }
    return [self yy_modelArrayWithClass:cls array:arr];
}

+ (NSArray *)yy_modelArrayWithClass:(Class)cls array:(NSArray *)arr {
    if (!cls || !arr) return nil;
    NSMutableArray *result = [NSMutableArray new];
    for (NSDictionary *dic in arr) {
        if (![dic isKindOfClass:[NSDictionary class]]) continue;
        NSObject *obj = [cls yy_modelWithDictionary:dic];
        if (obj) [result addObject:obj];
    }
    return result;
}

由如上代码可看出，对NSArray，NSString和NSData类型的数据循环调用yy_modelWithDictionary方法，实现数组对model的转换

NSDictionary (YYModel)

NSDictionary分类

//JSON转model
+ (NSDictionary *)yy_modelDictionaryWithClass:(Class)cls json:(id)json;
//字典转model
+ (NSDictionary *)yy_modelDictionaryWithClass:(Class)cls dictionary:(NSDictionary *)dic;

原理同数组转换

如上所述整体转换过程就是json转成字典，根据属性和key值的映射关系mapper创建YYModel，然后通过objc_msgSend发消息，将key对应的value值传给model的属性元的setter函数,最终实现JSON数据的解析。由于笔者能力有限，如果有理解不正确的地方欢迎各位指正。