美文网首页
技术提升之----MJExtension原理解读

技术提升之----MJExtension原理解读

作者: 快乐的小马农 | 来源:发表于2021-03-31 15:37 被阅读0次

    一. MJExtension概述
    MJExtension是是一个非常易用且功能强大的第三方Model和JSON相互转化的一个第三方库。

    二. 基本原理
    第一步:获取NSObject中的所有属性

          unsigned int propertyCount = 0;
          ///通过运行时获取当前类的属性
          objc_property_t *propertys = class_copyPropertyList([self class], &propertyCount);
          
          //把属性放到数组中
          for (int i = 0; i < propertyCount; i ++) {
          ///取出第一个属性
          objc_property_t property = propertys[i];
          //得到属性对应的名称
          NSString *name = @(property_getName(property));
          
          NSLog(@"name:%@", name);
          }
    

    第二步:在Foundation object(数组、字典等)以name 为key,寻找到对应的value值,然后将对应值填充入相应的Model当中

        - (void)setValue:(id)value forObject:(id)object
        {
            if (self.type.KVCDisabled || value == nil) return;
            [object setValue:value forKey:self.name];
        }
    

    三.MJExtension详细原理

    MJExtension内部结构

    MJExtensionConst类: 类中定义了一些字符串常量,分别表示property的属性类型,具体的类型字符串是存放在MJProperty的属性MJPropertyType中的code属性下的。不同类型的属性由不同的encode字符串表示,读者可以自己@encode(int) @encode(float) @encode(NSString)打印出一些常用类型属性的encode值来加深理解。

    MJPropertyType类: 用于记录MJProperty的一些相关的特性,例如要转换的对象的类型,是否是Foundation object类型对象等等,主要包括:

    • (instancetype)cachedTypeWithCode:(NSString *)code用于查找缓存的type类型。
      BOOL idType BOOL numberType BOOL boolType等一堆代表要转换value对象具体类型的属性。
      Class typeClass表明value对象的类型。
      NSString *code,用来写入Property的encode值。
      BOOL fromFoundation,用来表示要转换的 对象是否是NSDictionaryNSArrayNSSet等基本的Foundation object类型,简单来说就是如果要转换的对象是NSObject的子类且不是NSManagedObject类就返回NO。

    MJExtension核心代码分析
    MJExtension的设计非常巧妙,涉及的方法也非常多,我们从这个核心方法入手一步一步解析

    - (instancetype)mj_setKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
    
        //将JSON转换为Foundation object对象(NSDictionary, NSArray等)
        keyValues = [keyValues mj_JSONObject];
        
        //设置黑名单和白名单
        NSArray *allowedPropertyNames = [clazzmj_totalAllowedPropertyNames];
        NSArray *ignoredPropertyNames = [clazz mj_totalIgnoredPropertyNames];
        
        //声称了所有的MJProperty属性并进行遍历输出
         [clazz mj_enumerateProperties:^(MJProperty *property, BOOL *stop) {
         //遍历所有的MJProperty对象,设置到Model的对应的属性当中
         }
    

    现在我们探究一下,每一个MJProperty对象是怎么生成的,结合我上面的MJExtension内部结构图,大家可能理解起来比较容易。 在NSObject+MJProperty类中,+ (NSMutableArray *)properties这个方法是专门负责生成所有的MJProperty对象的。

        //首先从缓存中读取存储的MJProperty数组
        NSMutableArray *cachedProperties = [self dictForKey:&MJCachedPropertiesKey][NSStringFromClass(self)];
    

    继续探究+ (NSMutableArray *)properties方法, 如果没有缓存,就遍历所有的非Foundation object基本类型的对象,取出objc_property_t数组,包装成MJProperty数组。

        unsigned int outCount = 0;
        objc_property_t *properties = class_copyPropertyList(c, &outCount);
        for (unsigned int i = 0; i<outCount; i++) {
                //包装properties
                MJProperty *property = [MJProperty cachedPropertyWithProperty:properties[i]];
                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];
        }
    

    继续看如何包装objc_property_t property,先从缓存中读取MJProperty。

        //这里需要注意property指针指向的内存地址每次都是不变的,所以可以这样动态关联
        MJProperty *propertyObj = objc_getAssociatedObject(self, property);
    

    如果没有缓存就把property包装成一个MJProperty,

    - (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的name和attrs中的encode属性通过截取字符串来获得属性的类型。 下面来看一下MJProperty的type属性是如何设置的,

    #pragma mark - 公共方法
    - (void)setCode:(NSString *)code
    {
        _code = code;
        
        MJExtensionAssertParamNotNil(code);
        
        if ([code isEqualToString:MJPropertyTypeId]) {
            _idType = YES;
        } else if (code.length == 0) {
            _KVCDisabled = YES;
        } else if (code.length > 3 && [code hasPrefix:@"@\""]) {
            // 去掉@"和",截取中间的类型名称
            _code = [code substringWithRange:NSMakeRange(2, code.length - 3)];
            _typeClass = NSClassFromString(_code);
            _fromFoundation = [MJFoundation isClassFromFoundation:_typeClass];
            _numberType = [_typeClass isSubclassOfClass:[NSNumber class]];
            
        } else if ([code isEqualToString:MJPropertyTypeSEL] ||
                   [code isEqualToString:MJPropertyTypeIvar] ||
                   [code isEqualToString:MJPropertyTypeMethod]) {
            _KVCDisabled = YES;
        }
        
        // 是否为数字类型
        NSString *lowerCode = _code.lowercaseString;
        NSArray *numberTypes = @[MJPropertyTypeInt, MJPropertyTypeShort, MJPropertyTypeBOOL1, MJPropertyTypeBOOL2, MJPropertyTypeFloat, MJPropertyTypeDouble, MJPropertyTypeLong, MJPropertyTypeLongLong, MJPropertyTypeChar];
        if ([numberTypes containsObject:lowerCode]) {
            _numberType = YES;
            
            if ([lowerCode isEqualToString:MJPropertyTypeBOOL1]
                || [lowerCode isEqualToString:MJPropertyTypeBOOL2]) {
                _boolType = YES;
            }
        }
    }
    

    以上代码判断了property属性的具体类型
    到这里,MJProperty的包装就基本说完了。
    紧接着,取出keyValues中对应的值,

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

    处理value值,

        // 值的过滤
        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;
    

    最后是根据MJProperty的type中的typeClass,将不可扩展的集合转换成可变集合,方便后续的操作。对特定的值进行处理,如果是模型属性就继续进行递归转化,

        if (!type.isFromFoundation && propertyClass) { // 模型属性
            value = [propertyClass mj_objectWithKeyValues:value context:context];
        }
    

    如果是数组,就遍历数组,如果数组中还是数组就继续递归,如果不是调用+[mj_objectWithKeyValues:context]转化成对应的Model元素放入数组,

        for (NSDictionary *keyValues in keyValuesArray) {
            if ([keyValues isKindOfClass:[NSArray class]]){
                [modelArray addObject:[self mj_objectArrayWithKeyValuesArray:keyValues context:context]];
            } else {
                id model = [self mj_objectWithKeyValues:keyValues context:context];
                if (model) [modelArray addObject:model];
            }
        }
    

    最后一步,将经过处理的value值代入Model当中,

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

    说到这里,关于MJExtension原理就介绍的差不多了,感谢大家阅读!

    相关文章

      网友评论

          本文标题:技术提升之----MJExtension原理解读

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