MJExtension源码分析

96
liangdahong
2017.12.21 00:02 字数 1257

原始方法

  • 实现我们的模型是这样的,只有2个属性
@interface BMUser : NSObject
@property (nonatomic, copy) NSString *name; ///< name
@property (nonatomic, assign) int age;      ///< age
@end
  • 使用最原始的方法把json->Models时,代码如下
// 1.获取json数据
NSString *json = @"{\"name\" : \"idhong\", \"age\" : 15}";
// 2.json->NSDictionary
NSDictionary *jsonDict = [NSJSONSerialization JSONObjectWithData:[json dataUsingEncoding:NSUTF8StringEncoding] options:kNilOptions error:NULL];
// 3.创建user
BMUser *user = [BMUser new];
// 4.赋值
user.name = jsonDict[@"name"];
user.age = [jsonDict[@"age"] intValue];
// 其他属性设置
NSLog(@"");
  • 稍微优化下,使用setValuesForKeysWithDictionary可以简化赋值代码如下。
// 1.获取json数据
NSString *json = @"{\"name\" : \"idhong\", \"age\" : 15}";
// 2.json->NSDictionary
NSDictionary *jsonDict = [NSJSONSerialization JSONObjectWithData:[json dataUsingEncoding:NSUTF8StringEncoding] options:kNilOptions error:NULL];
// 3.创建user
BMUser *user = [BMUser new];
// 4.赋值
[user setValuesForKeysWithDictionary:jsonDict];    

如果属性特别多,而且模型嵌套模型时手写就特别麻烦而且容易出错,其中至少包括如下问题;

  • 1.模型的属性是另一个模型
  • 2.模型的属性是数组(数组中的对象又是模型)
  • 3.以及相互嵌套等。
  • 使用setValuesForKeysWithDictionary无法解决问题,同时手动编码无法想象。

归根结底 json -> Model 主要是以下3步

  • 1.创建模型

  • 2.为模型中的属性赋值

  • 3.返回模型

  • 其中最核心的就是第2步,怎么样动态的为模型赋值,当然是使用Runtime,MJExtension 算是使用率较多的一个库,下面就简单分析下其实现原理吧。

  • 1.使用Runtime动态获取模型的属性(包括继承链的所有属性,MJExtension对模型的属性做了缓存,下次转换时自己使用,空间换时间)

  • 2.又第1步获取到的属性可以解析出各属性的全部信息(包括属性类型,属性修饰符等参考这里 )

  • 3.第2步获取属性后,取到属性名在去NSDictionary)中获出相应的值

  • 4.在第3步取出的值使用KVC设置给Model即可(MJExtension使用KVC赋值,YYModel底层是直接使用objc_msgSend)

  • 5.所以为什么如果模型中有属性是数组,数组中又是模型时,需要我们指定其类型,才可为我们主动将其转换。

怎样自己实现MJExtension

  • 动态获取模型属性
  • 解析属性相关信息
  • 如果是数组类型,因为不知道数组中应该存放具体的类型,所以需提供方法让使用者提供具体的类型
  • 使用KVC赋值
  • 其他扩展信息,包括黑名单,白名单,换属性名,转换结束等等扩展信息。

分析MJExtension

  • 引用一张图

MJExtension 一共21个文件,主要用3个类,5个分类

  • MJExtension.h头文件
  • MJExtensionConst 一些常量,宏,版本控制等
  • MJFoundation主要是提供判断是否为Foundation框架的类
  • MJProperty封装属性对象(objc_property_t内部包括属性名称,属性类型等相关信息)
  • MJPropertyKey 属性的key
  • MJPropertyType 属性类型(类型标识符这里,是否id,是否基本数据类型等)
  • NSString+MJExtension字符串的一些扩展(包括下划线,大小写等处理)
  • NSObject+MJProperty主要提供遍历一个类的属性列表
  • NSObject+MJCoding提供归档功能
  • NSObject+MJClass提供扩展功能,黑名单,白名单,数组中的类型自定义等。

MJExtension源码解读

  • 我们使用最基本的dict->Model方法是:
+ (instancetype)mj_objectWithKeyValues:(id)keyValues;

其实现在NSObject+MJKeyValue.m的203行如下

+ (instancetype)mj_objectWithKeyValues:(id)keyValues
{
    return [self mj_objectWithKeyValues:keyValues context:nil];
}

内部调用了下面的方法

+ (instancetype)mj_objectWithKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
{
    // 获得JSON对象
    keyValues = [keyValues mj_JSONObject];
    MJExtensionAssertError([keyValues isKindOfClass:[NSDictionary class]], nil, [self class], @"keyValues参数不是一个字典");
    
    if ([self isSubclassOfClass:[NSManagedObject class]] && context) {
        NSString *entityName = [NSStringFromClass(self) componentsSeparatedByString:@"."].lastObject;
        return [[NSEntityDescription insertNewObjectForEntityForName:entityName inManagedObjectContext:context] mj_setKeyValues:keyValues context:context];
    }
    return [[[self alloc] init] mj_setKeyValues:keyValues];
}

首先是mj_JSONObject方法,其作用是把NSData或者NSString为NSDictionary类型,因为上面的方法支持NSDictionary,NSString,NSData类型,其具体实现就不在赘述了。

这里先不考虑CoreData及NSManagedObject

然后是创建模型同时调用赋值属性

[[[self alloc] init] mj_setKeyValues:keyValues]

最后调到

- (instancetype)mj_setKeyValues:(id)keyValues context:(NSManagedObjectContext *)context

此方法是整个库的核心代码部分。

- (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;
}

获取模型可以转换和忽略的属性

NSArray *allowedPropertyNames = [clazz mj_totalAllowedPropertyNames];
NSArray *ignoredPropertyNames = [clazz mj_totalIgnoredPropertyNames];

此方法在调用时,这里做了缓存处理,只会访问一次,同时会调到外层的使用者实现的方法中

然后调用

+ (void)mj_enumerateProperties:(MJPropertiesEnumeration)enumeration

遍历所有的属性,此方法同样做了缓存处理,如果某Class遍历过,此库内部会把其数组缓存起来,下次直接遍历即可

Block回调中可以获取到每一个MJProperty(封装的属性)

几步比较常规的操作,在库用用详细的注释

  • 检测是否被忽略
  • 取出属性值
  • 值的过滤(提供了尾部可以对特殊值做处理的功能)

复杂类型处理

实现是对NSArray->NSMutableArray,NSData->NSMutableData,NSDictionary->NSMutableDictionary做可变处理。

因为对复杂类型需继续继续转换。

如果是模型( !type.isFromFoundation && propertyClass )就重复最开始的方法

如果是NSURL 就把NSString转换为NSURL

如果是 字典数组-由继续最开始的方法调用

NSNumber类型

BOOL等类型的转换

最后使用KVC赋值,当然在内部做了是否支持KVC的判断。

// 3.赋值
[property setValue:value forObject:self];

总结

综上所述,MJExtension的底层实现还算常规,动态获取属性 属性的类型判断 必要的缓存 KVC赋值 其他性细节优化和扩展

其他

有时间分析下YYModel,其使用到了CoreFoundationobjc_msgSend

iOS开发