美文网首页iOS DeveloperiOS点点滴滴
iOS:runtime应用之-MJExtension框架原理解析

iOS:runtime应用之-MJExtension框架原理解析

作者: GrumpyMelon | 来源:发表于2018-01-08 23:13 被阅读620次

    上篇文介绍了怎样把js代码转为NSDictionary对象(iOS:JS对象转换为Dictionary/NSDictionary对象). 然后使用MJExtension就可以很简单的把NSDictionary转为数据model.本文简单介绍下MJExtension的大致原理和所用到的runtime代码.

    MJExtension使用简介

    MJExtension github地址

    使用很简单,引入MJExtension后调用一行代码即可,由于MJExtension是给NSObject增加了category,因此使用该框架不需要修改数据model的继承关系,无代码入侵.(另一个框架Mantle需要修改model的继承关系并书写转换代码,有兴趣的可以研究下两者的区别,Mantle github地址)

    TestModel *model = [TestModel mj_objectWithKeyValues:dic];
    
    

    核心API简介

    首先介绍下MJExtension中的核心代码,包括其用到的runtime API,

    // ***** 获取父类, 返回Class
    class_getSuperclass(Class _Nullable cls) 
    
    // ***** 获取属性列表, 返回数据类型 objc_property_t * 数组.
    class_copyPropertyList(Class _Nullable cls, unsigned int * _Nullable outCount)
    // 示例:
    unsigned int outCount = 0;
    objc_property_t *properties = class_copyPropertyList(c, &outCount);
    
    
    // ***** 获取属性名,返回char *类型,可转为NSString.
    property_getName(objc_property_t _Nonnull property) 
    // 示例:
    objc_property_t property;
    NSString *name = @(property_getName(property));
    
    
    // ***** 获取property的attribute,返回char *类型,可转为NSString. 用于获取property的类型
    property_getAttributes(objc_property_t _Nonnull property) 
    // 示例:
    objc_property_t property;
    NSString *attrs = @(property_getAttributes(property));
    
    // ***** 使用KVO给数据model的property赋值,value为字典中取出的数据, key为数据模型object的属性名.
    [object setValue:value forKey:key];
    
    

    其实看到这儿大家应该已经大概明白MJExtension的原理了,就是使用runtime获取该类和其所有父类的所有的属性名,并根据属性名在数据字典中获取对应的值,然后通过setValue:forKey设置属性的值.

    核心代码简介

    为了方便阅读,贴上的源码只保留了核心功能代码, 并且补充了一些注释.

    NSObject+MJKeyValue

    主要作用: 遍历该类所有的属性(包括定义在父类中的属性),封装成MJProperty类型返回. 并根据MJProperty中定义的属性名从数据字典中取值(这里要求字典中的key值的名称与属性名相同), 赋值给model的属性.

    - (instancetype)mj_setKeyValues:(id)keyValues context:(NSManagedObjectContext *)context {  
    
        ......
        
        Class clazz = [self class];
        
        //返回所有的属性, 已封装成MJProperty类型.
        //MJProperty中有该属性的属性名,属性类型等信息.
        [clazz mj_enumerateProperties:^(MJProperty *property, BOOL *stop) {
            @try {
                ......          
                    
                // 1.从数据字典keyValues中,根据属性名,取出属性值
                //属性名,即key值封装在MJPropertyKey这个类中.
                id value;
                NSArray *propertyKeyses = [property propertyKeysForClass:clazz];
                for (NSArray *propertyKeys in propertyKeyses) {
                    value = keyValues;
                    for (MJPropertyKey *propertyKey in propertyKeys) {
                    //根据propertyKey中的key值在键值对keyValues中取出对应的值.
                        value = [propertyKey valueInObject:value];
                    }
                    if (value) break;
                }
                
                .....
                
                // 2.赋值
                [property setValue:value forObject:self];
            } @catch (NSException *exception) {
                ......
            }
        }];
        
        return self;
    }
    
    

    NSObject+MJProperty

    主要作用: 获取属性并封装成MJProperty的具体实现.

    + (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
    {
        NSMutableArray *cachedProperties = [self dictForKey:&MJCachedPropertiesKey][NSStringFromClass(self)];
        
        if (cachedProperties == nil) {
            cachedProperties = [NSMutableArray array];
            
            //如果有继承关系,获取所有的父类.
            [self mj_enumerateClasses:^(__unsafe_unretained Class c, BOOL *stop) {
                // 1.使用runtime获得类中的所有的成员变量
                unsigned int outCount = 0;
                objc_property_t *properties = class_copyPropertyList(c, &outCount);
                
                // 2.遍历每一个成员变量
                for (unsigned int i = 0; i<outCount; i++) {
                //根据获取到的objc_property_t初始化并设置MJProperty的属性.
                    MJProperty *property = [MJProperty cachedPropertyWithProperty:properties[i]];
                    
                    ......
                    
                    [cachedProperties addObject:property];
                }
                
                // 3.释放内存
                free(properties);
            }];
            
            ......
        }
        
        return cachedProperties;
    }
    
    

    NSObject+MJClass

    主要作用:遍历所有的父类,用于获取父类的属性.

    + (void)mj_enumerateClasses:(MJClassesEnumeration)enumeration {
        // 1.没有block就直接返回
        if (enumeration == nil) return;
        
        // 2.停止遍历的标记
        BOOL stop = NO;
        
        // 3.当前正在遍历的类
        Class c = self;
        
        // 4.开始遍历每一个类
        while (c && !stop) {
            // 4.1.执行操作
            enumeration(c, &stop);
            
            // 4.2.使用runtime获得父类
            c = class_getSuperclass(c);
            
            //到Foudation基类时跳出循环.
            if ([MJFoundation isClassFromFoundation:c]) break;
        }
    }
    

    其他功能代码简介

    上个章节只简单介绍了MJExtension的核心原理,代码解析删减了好多代码.其实MJExtension里还涉及好多功能代码,包括:

    1. 设置类属性的黑白名单,可以定向解析或忽略某些属性.

    调用方法:

    [TestModel mj_setupAllowedPropertyNames:^NSArray *{
         return [NSArray new];
    }];
    
    [TestModel mj_setupIgnoredCodingPropertyNames:^NSArray *{
         return [NSArray new];
    }];
        
    

    源码解析:
    NSObject+MJKeyValue:

     Class clazz = [self class];
     //获取黑白名单数组.
     NSArray *allowedPropertyNames = [clazz mj_totalAllowedPropertyNames];
     NSArray *ignoredPropertyNames = [clazz mj_totalIgnoredPropertyNames];
        
        //通过封装的方法回调一个通过运行时编写的,用于返回属性列表的方法。
     [clazz mj_enumerateProperties:^(MJProperty *property, BOOL *stop) {
                // 0.检测是否被忽略
          if (allowedPropertyNames.count && ![allowedPropertyNames containsObject:property.name]) return;
          if ([ignoredPropertyNames containsObject:property.name]) return;
            ......
     }];
                
    

    2. 对类属性的缓存,解析一次该类的属性之后,下次不会重复解析.

    NSObject+MJProperty:

    + (NSMutableArray *)properties {
         //获取已缓存的property数组
        NSMutableArray *cachedProperties = [self dictForKey:&MJCachedPropertiesKey][NSStringFromClass(self)];
        
        if (cachedProperties == nil) {
            //未缓存过,初始化数组.
            cachedProperties = [NSMutableArray array];
            
            //解析propertys并添加进cachedProperties数组中.
            ......
            
            //缓存属性数组
            [self dictForKey:&MJCachedPropertiesKey][NSStringFromClass(self)] = cachedProperties;
        }
        
        return cachedProperties;
    }
    
    

    3.动态修改某些值特性的属性值

    在自己定义的数据model中可以通过实现 mj_newValueFromOldValue:property: 方法来替换某些属性的值.

    例如:在TestModel中写以下代码,可以实现给名为testProperty的属性赋值为testValue;

    - (id)mj_newValueFromOldValue:(id)oldValue property:(MJProperty *)property {
        if ([property.name isEqualToString:@"testProperty"]) {
            return @"testValue";
        } else {
            return oldValue;
        }
    }
    
    

    NSObject+MJKeyValue中源码解析

    - (instancetype)mj_setKeyValues:(id)keyValues context:(NSManagedObjectContext *)context {  
    
        ......
            
        //返回所有的属性, 已封装成MJProperty类型.
        //MJProperty中有该属性的属性名,属性类型等信息.
        
        [clazz mj_enumerateProperties:^(MJProperty *property, BOOL *stop) {
            @try {
                ......          
                    
                 //如果model实现了mj_newValueFromOldValue: property方法,则会返回新的值.
                id newValue = [clazz mj_getNewValueFromObject:self oldValue:value property:property];
                if (newValue != value) { // 有过滤后的新值
                    [property setValue:newValue forObject:self];
                    return;
                }
                
                .....
                
            } @catch (NSException *exception) {
                ......
            }
        }];
        
        return self;
    }
    
    

    最后

    MJExtension除了文中提到的这些功能,这个框架还包括数据model转换为字典类型,plist转换为数据model等等众多功能.本文只是针对runtime部分进行了解析,文中若有不正确的地方欢迎指正.

    想细致研究runtime的同学可以去看这篇文章.

    相关文章

      网友评论

        本文标题:iOS:runtime应用之-MJExtension框架原理解析

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