MJExtension源码解读

MJExtension

A fast, convenient and nonintrusive conversion framework between JSON and model.

转换速度快、使用简单方便的字典转模型框架

//User.h
@interface User : NSObject

@property (nonatomic, copy)NSString *name;
@property (nonatomic, copy)NSString *icon;
@property (nonatomic, assign)unsigned int age;
@property (nonatomic, copy)NSString *height;
@property (nonatomic, strong)NSNumber *money;

@end

字典转模型：

//ViewController.m
NSDictionary *dict = @{
                           @"name" : @"Jack",
                           @"icon" : @"lufy.png",
                           @"age" : @20,
                           @"height" : @"1.55",
                           @"money" : @100.9
                           };

    // JSON -> User
    User *user = [User mj_objectWithKeyValues:dict];

    NSLog(@"name=%@, icon=%@, age=%u, height=%@, money=%@", user.name, user.icon, user.age, user.height, user.money);

打印结果：

 name=Jack, icon=lufy.png, age=20, height=1.55, money=100.9

通过一句简单的代码，就把字典数据转化为了模型数据，非常方便简洁。

复杂一点的应用

很多时候json转模型都不是这样简单。有时候会出现模型中嵌套模型或者模型中的属性名和json数据中的key不一致的情况。

下面看一下一个Student类的模型：

//Student.h
@interface Student : NSObject

@property (nonatomic, copy)NSString *ID;
@property (nonatomic, copy)NSString *desc;
@property (nonatomic, copy)NSString *nowName;
@property (nonatomic, copy)NSString *oldName;
@property (nonatomic, copy)NSString *nameChangedTime;
@property (nonatomic, strong)Bag *bag;

@end

我们看到Student模型中嵌套着Bag这个模型：

//Bag.h
@interface Bag : NSObject

@property (nonatomic, copy)NSString *name;
@property ( nonatomic, assign)double *price;

@end

然后我们再看一下json数据：

NSDictionary *dict = @{
                           @"id" : @"20",
                           @"description" : @"kids",
                           @"name" : @{
                                   @"newName" : @"lufy",
                                   @"oldName" : @"kitty",
                                   @"info" : @[
                                           @"test-data",
                                           @{
                                               @"nameChangedTime" : @"2013-08"
                                               }
                                           ]
                                   },
                           @"other" : @{
                                   @"bag" : @{
                                           @"name" : @"a red bag",
                                           @"price" : @100.7
                                           }
                                   }
                           };

可以看到字典数据中是id，而模型中是ID，同样也有desc和description。模型中有newName和oldName这些属性，而字典中这些属性在name字段下面。bag属性也是一样的道理，那么怎么办呢？

我们只需要实现MJExtension中的 + (NSDictionary *)mj_replacedKeyFromPropertyName 方法，在Student.m中 #import 然后实现 + (NSDictionary *)mj_replacedKeyFromPropertyName 方法：

//Student.m
+ (NSDictionary *)mj_replacedKeyFromPropertyName
{
    return @{
             @"ID" : @"id",
             @"desc" : @"description",
             @"oldName" : @"name.oldName",
             @"nowName" : @"name.newName",
             @"nameChangedTime" : @"name.info[1].nameChangedTime",
             @"bag" : @"other.bag"
             };
}

这个方法的作用就是在给模型赋值的时候，把右边字段的值赋给模型中左边字段的属性。

转化一下试试：

// JSON -> Student
    Student *stu = [Student mj_objectWithKeyValues:dict];

    // Printing
    NSLog(@"ID=%@, desc=%@, oldName=%@, nowName=%@, nameChangedTime=%@",
          stu.ID, stu.desc, stu.oldName, stu.nowName, stu.nameChangedTime);
    // ID=20, desc=kids, oldName=kitty, nowName=lufy, nameChangedTime=2013-08

    NSLog(@"bagName=%@, bagPrice=%d", stu.bag.name, stu.bag.price);
    // bagName=a red bag, bagPrice=100.700000

这个地方需要关注一个地方就是模型中的nameChangedTime这个属性，在字典中去取值的时候是取 name.info[1].nameChangedTime 这个字段的值，这个在后面我们讲核心源码的时候会用到。后面讲源码也会以上面这个为例子来讲，这样比较好理解。

unsigned int count;
    objc_property_t *propertyList = class_copyPropertyList([Student class], &count);
    for (int i = 0; i < count; i++) {
        objc_property_t property = propertyList[i];
        const char *propertyName = property_getName(property);
        const char *attris = property_getAttributes(property);
        NSLog(@"%s %s", propertyName, attris);
    }

    free(propertyList);

打印结果：

ID T@"NSString",C,N,V_ID
desc T@"NSString",C,N,V_desc
nowName T@"NSString",C,N,V_nowName
oldName T@"NSString",C,N,V_oldName
nameChangedTime T@"NSString",C,N,V_nameChangedTime
bag T@"Bag",&,N,V_bag

通过char类型的attris字符串我们可以看到，它中间有一个串是表示它是属于哪一个类的，比如NSString，Bag。

通过遍历类的属性，我们得到了objc_property_t类型的属性对象，然后使用这个objc_property_t对象来创建一个对应的MJProperty对象，我们看看MJ大神是怎么做的：

#pragma mark - 缓存
+ (instancetype)cachedPropertyWithProperty:(objc_property_t)property
{
    MJExtensionSemaphoreCreate
    MJExtensionSemaphoreWait
    MJProperty *propertyObj = objc_getAssociatedObject(self, property);
    if (propertyObj == nil) {
        propertyObj = [[self alloc] init];
        propertyObj.property = property;
        objc_setAssociatedObject(self, property, propertyObj, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    }
    MJExtensionSemaphoreSignal
    return propertyObj;
}

首先MJ大神通过objc_property_t对象这个key去缓存中取，如果缓存中取不到，那么就根据objc_property_t来创建一个MJProperty对象，并且把这个MJProperty对象通过property这个key与MJProperty类对象关联起来。那么下次如果再从缓存中取同一个objc_property_t对应的MJProperty对象就能取到了，就不用再创建了。这也是MJ大神使用缓存的一个地方。

上面代码块中 propertyObj.property = property; 这行代码触发了MJProperty对象的set方法：

MJProperty有一个type属性，这个属性是MJPropertyType类的，就是表示MJProperty对象的property属性是属于什么类型的。

另外每一个MJProperty对象还持有着两个字典，一个是 propertyKeysDict ，一个是 objectClassInArrayDict 。

_type = [MJPropertyType cachedTypeWithCode:code];

核心源码分析

我们就从 复杂一点的应用 这个例子去看一下MJExtension的核心源码。

沿着 + (instancetype)mj_objectWithKeyValues:(id)keyValues 这个方法一直往下查找就能找到其核心代码：

- (instancetype)mj_setKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
{
    // 获得JSON对象
    keyValues = [keyValues mj_JSONObject];

    MJExtensionAssertError([keyValues isKindOfClass:[NSDictionary class]], self, [self class], @"keyValues参数不是一个字典");

    Class clazz = [self class];
    NSArray *allowedPropertyNames = [clazz mj_totalAllowedPropertyNames];
    NSArray *ignoredPropertyNames = [clazz mj_totalIgnoredPropertyNames];

    //通过封装的方法回调一个通过运行时编写的，用于返回属性列表的方法。
    [clazz mj_enumerateProperties:^(MJProperty *property, BOOL *stop) {
        @try {
            // 0.检测是否被忽略
            if (allowedPropertyNames.count && ![allowedPropertyNames containsObject:property.name]) return;
            if ([ignoredPropertyNames containsObject:property.name]) return;

            // 1.取出属性值
            id value;
            NSArray *propertyKeyses = [property propertyKeysForClass:clazz];
            for (NSArray *propertyKeys in propertyKeyses) {
                value = keyValues;
                for (MJPropertyKey *propertyKey in propertyKeys) {
                    value = [propertyKey valueInObject:value];
                }
                if (value) break;
            }

            // 值的过滤
            id newValue = [clazz mj_getNewValueFromObject:self oldValue:value property:property];
            if (newValue != value) { // 有过滤后的新值
                [property setValue:newValue forObject:self];
                return;
            }

            // 如果没有值，就直接返回
            if (!value || value == [NSNull null]) return;

            // 2.复杂处理
            MJPropertyType *type = property.type;
            Class propertyClass = type.typeClass;
            Class objectClass = [property objectClassInArrayForClass:[self class]];//模型数组中对象的类

            // 不可变 -> 可变处理
            if (propertyClass == [NSMutableArray class] && [value isKindOfClass:[NSArray class]]) {
                value = [NSMutableArray arrayWithArray:value];
            } else if (propertyClass == [NSMutableDictionary class] && [value isKindOfClass:[NSDictionary class]]) {
                value = [NSMutableDictionary dictionaryWithDictionary:value];
            } else if (propertyClass == [NSMutableString class] && [value isKindOfClass:[NSString class]]) {
                value = [NSMutableString stringWithString:value];
            } else if (propertyClass == [NSMutableData class] && [value isKindOfClass:[NSData class]]) {
                value = [NSMutableData dataWithData:value];
            }

            if (!type.isFromFoundation && propertyClass) { // 模型属性
                value = [propertyClass mj_objectWithKeyValues:value context:context];
            } else if (objectClass) {
                if (objectClass == [NSURL class] && [value isKindOfClass:[NSArray class]]) {
                    // string array -> url array
                    NSMutableArray *urlArray = [NSMutableArray array];
                    for (NSString *string in value) {
                        if (![string isKindOfClass:[NSString class]]) continue;
                        [urlArray addObject:string.mj_url];
                    }
                    value = urlArray;
                } else { // 字典数组-->模型数组
                    value = [objectClass mj_objectArrayWithKeyValuesArray:value context:context];
                }
            } else {
                if (propertyClass == [NSString class]) {
                    if ([value isKindOfClass:[NSNumber class]]) {
                        // NSNumber -> NSString
                        value = [value description];
                    } else if ([value isKindOfClass:[NSURL class]]) {
                        // NSURL -> NSString
                        value = [value absoluteString];
                    }
                } else if ([value isKindOfClass:[NSString class]]) {
                    if (propertyClass == [NSURL class]) {
                        // NSString -> NSURL
                        // 字符串转码
                        value = [value mj_url];
                    } else if (type.isNumberType) {
                        NSString *oldValue = value;

                        // NSString -> NSNumber
                        if (type.typeClass == [NSDecimalNumber class]) {
                            value = [NSDecimalNumber decimalNumberWithString:oldValue];
                        } else {
                            value = [numberFormatter_ numberFromString:oldValue];
                        }

                        // 如果是BOOL
                        if (type.isBoolType) {
                            // 字符串转BOOL（字符串没有charValue方法）
                            // 系统会调用字符串的charValue转为BOOL类型
                            NSString *lower = [oldValue lowercaseString];
                            if ([lower isEqualToString:@"yes"] || [lower isEqualToString:@"true"]) {
                                value = @YES;
                            } else if ([lower isEqualToString:@"no"] || [lower isEqualToString:@"false"]) {
                                value = @NO;
                            }
                        }
                    }
                }

                // value和property类型不匹配
                if (propertyClass && ![value isKindOfClass:propertyClass]) {
                    value = nil;
                }
            }

            // 3.赋值
            [property setValue:value forObject:self];
        } @catch (NSException *exception) {
            MJExtensionBuildError([self class], exception.reason);
            MJExtensionLog(@"%@", exception);
        }
    }];

    // 转换完毕
    if ([self respondsToSelector:@selector(mj_keyValuesDidFinishConvertingToObject)]) {
        [self mj_keyValuesDidFinishConvertingToObject];
    }
    return self;
}

这一部分代码很长，我们一部分一部分来看：

1.将json数据转化为foundation类型：

// 获得JSON对象
    keyValues = [keyValues mj_JSONObject];

    MJExtensionAssertError([keyValues isKindOfClass:[NSDictionary class]], self, [self class], @"keyValues参数不是一个字典");

    Class clazz = [self class];
    NSArray *allowedPropertyNames = [clazz mj_totalAllowedPropertyNames];
    NSArray *ignoredPropertyNames = [clazz mj_totalIgnoredPropertyNames];

allowedPropertyNames是允许进行字典和模型转换的属性名数组，ignoredPropertyNames是不允许进行字典和模型转换额属性名数组，这两个数组一般都是自己在模型类的.m文件中去设置的。

2.遍历整个类的属性：

+ (void)mj_enumerateProperties:(MJPropertiesEnumeration)enumeration
{
    // 获得成员变量
    NSArray *cachedProperties = [self properties];

    // 遍历成员变量
    BOOL stop = NO;
    for (MJProperty *property in cachedProperties) {
        enumeration(property, &stop);
        if (stop) break;
    }
}

再看一下 + (NSMutableArray *)properties 方法，其核心部分如下：

[self mj_enumerateClasses:^(__unsafe_unretained Class c, BOOL *stop) {
                // 1.获得所有的成员变量
   unsigned int outCount = 0;
   objc_property_t *properties = class_copyPropertyList(c, &outCount);

     // 2.遍历每一个成员变量
     for (unsigned int i = 0; i

  
 
   
          MJProperty *property = [MJProperty cachedPropertyWithProperty:properties[i]];
 
   
         
 
   // 过滤掉Foundation框架类里面的属性
 
   
         
 
   if ([MJFoundation isClassFromFoundation:property.srcClass]) 
 
   continue;
 
   
          property.srcClass = c;
 
   
          [property setOriginKey:[
 
   self propertyKey:property.name] forClass:
 
   self];
 
   
          [property setObjectClassInArray:[
 
   self propertyObjectClassInArray:property.name] forClass:
 
   self];
 
   
          [cachedProperties addObject:property];
 
   
       }
 
   

 
   
             
 
   // 3.释放内存
 
   
      free(properties);
 
   
    }];
 
   


  

首先通过 + (void)mj_enumerateClasses:(MJClassesEnumeration)enumeration 这个方法去遍历当前模型类及其父类，当追溯到Foundation类型的类时就停止遍历。

MJProperty *property = [MJProperty cachedPropertyWithProperty:properties[i]];

+ (instancetype)cachedPropertyWithProperty:(objc_property_t)property
{
    MJExtensionSemaphoreCreate
    MJExtensionSemaphoreWait
    MJProperty *propertyObj = objc_getAssociatedObject(self, property);
    if (propertyObj == nil) {
        propertyObj = [[self alloc] init];
        propertyObj.property = property;
        objc_setAssociatedObject(self, property, propertyObj, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    }
    MJExtensionSemaphoreSignal
    return propertyObj;
}

- (void)setProperty:(objc_property_t)property
{
    _property = property;

    MJExtensionAssertParamNotNil(property);

    // 1.属性名
    _name = @(property_getName(property));

    // 2.成员类型
    NSString *attrs = @(property_getAttributes(property));
    NSUInteger dotLoc = [attrs rangeOfString:@","].location;
    NSString *code = nil;
    NSUInteger loc = 1;
    if (dotLoc == NSNotFound) { // 没有,
        code = [attrs substringFromIndex:loc];
    } else {
        code = [attrs substringWithRange:NSMakeRange(loc, dotLoc - loc)];
    }
    _type = [MJPropertyType cachedTypeWithCode:code];
}

下面两行代码非常重要：

[property setOriginKey:[self propertyKey:property.name] forClass:self];
[property setObjectClassInArray:[self propertyObjectClassInArray:property.name] forClass:self];

对于第一行代码：

+ (id)propertyKey:(NSString *)propertyName 这个方法是获取模型的属性名在字典中对应的key，什么意思呢？还是拿第二个例子来说，它有一个nameChangedTime属性，由于我们在模型类中实现了 + (NSDictionary *)mj_replacedKeyFromPropertyName 这个方法，且这个方法中与nameChangedTime相对应的是 name.info[1].nameChangedTime ，所以 + (id)propertyKey:(NSString *)propertyName 返回的就是 name.info[1].nameChangedTime 这个字符串。

对于 - (void)setOriginKey:(id)originKey forClass:(Class)c 方法，这个方法会把 name.info[1].nameChangedTime 这个字符串拆解成一段一段，并封装成一个个MJPropertyKey对象，组成数组，赋值给MJProperty的propertyKeysDict这个字典：

对于第二行代码

如果模型中有数组类型的属性，并且数组中的元素也是模型类，那么就需要在模型类中实现 mj_objectClassInArray 方法，就像下面这样：

模型类中有一个数组类型的属性statuses，数组中的元素类型是模型，模型类是Status；另一个数组类型的属性是ads，数组中的元素类型是模型，模型类是Ad。

+ (NSDictionary *)mj_objectClassInArray
{
    return @{
             @"statuses" : @"Status",
             @"ads" : @"Ad"
             };
}

这时如果在 + (Class)propertyObjectClassInArray:(NSString *)propertyName 方法中传入statuses属性，那么返回的就是Status类。

然后 - (void)setObjectClassInArray:(Class)objectClass forClass:(Class)c 方法将这个Status类对象赋值给MJProperty对象的 objectClassInArrayDict 字典。

if (allowedPropertyNames.count && ![allowedPropertyNames containsObject:property.name]) return;
if ([ignoredPropertyNames containsObject:property.name]) return;

然后从每个属性的propertyKeysDict字典中取出propertyKeys数组，根据propertyKeys数组来取值：

id value;
NSArray *propertyKeyses = [property propertyKeysForClass:clazz];
for (NSArray *propertyKeys in propertyKeyses) {
      value = keyValues;
      for (MJPropertyKey *propertyKey in propertyKeys) {
           value = [propertyKey valueInObject:value];
     }
     if (value) break;
}

我们看一下 - (id)valueInObject:(id)object 这个方法是怎么操作的：

如果属性的类型是可变的类型，而取出的value是不可变的类型，那么就要把不可变类型变换为可变的类型：

MJPropertyType *type = property.type;
Class propertyClass = type.typeClass;
Class objectClass = [property objectClassInArrayForClass:[self class]];//模型数组中对象的类

 // 不可变 -> 可变处理
if (propertyClass == [NSMutableArray class] && [value isKindOfClass:[NSArray class]]) {
      value = [NSMutableArray arrayWithArray:value];
 } else if (propertyClass == [NSMutableDictionary class] && [value isKindOfClass:[NSDictionary class]]) {
       value = [NSMutableDictionary dictionaryWithDictionary:value];
} else if (propertyClass == [NSMutableString class] && [value isKindOfClass:[NSString class]]) {
       value = [NSMutableString stringWithString:value];
} else if (propertyClass == [NSMutableData class] && [value isKindOfClass:[NSData class]]) {
       value = [NSMutableData dataWithData:value];
            }

上面就是完成了对属性的第一步赋值，但是这还不够，如果这个属性是模型类型，那么还要对这个模型再进行一次字典转模型操作。如果这个属性是数组类型且数组元素是模型类型，那么还要进行字典数组转模型数组的操作。或者属性是NSURL类型，value是NSString类型，这样也要进行一下转换:

这样整个模型赋值的过程也就完成了。

MJExtension中的一部分缓存操作

MJExtension中进行了大量的缓存操作来优化性能，下面讲几个比较重要的缓存，理解了这些缓存也有助于更深入的理解整个框架。

MJProperty *propertyObj = objc_getAssociatedObject(self, property);
    if (propertyObj == nil) {
        propertyObj = [[self alloc] init];
        propertyObj.property = property;
        objc_setAssociatedObject(self, property, propertyObj, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    }