MJExtension 源码浅析

GitHub给个✨

MJExtension 基本上所有的iOS开发都用过,Json <---> Model。
主要的机制是采用了Runtime的反射机制,有兴趣学习Runtime的同学可以看看。

整理思路

如果你想要写一个 Json转Model的第三方,该怎么入手。

已知:

  • 包含key value 的 dictionary
  • model类

那么也就是,我们需要找出model里面的所有的property,然后把dictionary里面的value赋值给对应的property。

伪代码
+ (id)JsonToModel:(NSDictionary *)dictionary {
    TestModel *model = [[TestModel alloc] init];
    for(propertyName in TestModel){
        [model setValue:dictionary[propertyName] forKey: propertyName];
    }
}

说干就干

方法入口

调用:入口方法 mj_objectWithKeyValues最终会调用mj_setKeyValues

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

+ (instancetype)mj_objectWithKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
{
    return [[[self alloc] init] mj_setKeyValues:keyValues];
}

- (instancetype)mj_setKeyValues:(id)keyValues
{
    return [self mj_setKeyValues:keyValues context:nil];
}

核心方法

/**
 核心代码:
 */
- (instancetype)mj_setKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
{
    // 获得JSON对象
    keyValues = [keyValues mj_JSONObject];
    
    Class clazz = [self class];
    
    //通过封装的方法回调一个通过运行时编写的,用于返回属性列表的方法。
    [clazz mj_enumerateProperties:^(MJProperty *property, BOOL *stop) {
        @try {            
            // 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;
            }
            
            ...
            ...
            安全判断代码
            ...
            ...
            
            // 3.赋值
            [property setValue:value forObject:self];
        } @catch (NSException *exception) {

        }
    }];
    
    return self;
}

上面代码做了一定程度的简化,当然其实可以看的出来和前面的伪代码有点类似了。主要的逻辑就是:

  1. 获取Dictionary
  2. 从类里面拿到所有的propertyName
  3. 找到dictionary里面的value赋值给model

反射获取类中的属性

+ (void)mj_enumerateProperties:(MJPropertiesEnumeration)enumeration
{
    // 获得成员变量
    NSArray *cachedProperties = [self properties];
    
    // 遍历成员变量
    BOOL stop = NO;
    for (MJProperty *property in cachedProperties) {
        enumeration(property, &stop);
        if (stop) break;
    }
}

#pragma mark - 公共方法
+ (NSMutableArray *)properties
{
    NSMutableArray *cachedProperties = [NSMutableArray array];
    
    [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<outCount; 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);
    }];
       
    return cachedProperties;
}

通过*objc_property_t properties = class_copyPropertyList(c, &outCount)这个方法获取所有的property,然后mj_enumerateClasses是遍历SuperClass,最后是把拿到的信息封装成一个MJProperty。

PS

其中代码进行了相应的简化,其中有一些Property的缓存,类型的安全判断都暂时忽略,只进行思路的理解。

纸上谈来终觉浅

写了一个Dome,大大简化了MJExtension,目的是为了浅尝Runtime的魅力。基本思路如最上面的伪代码。其中很多安全判断,省略了些许。
这里有一个Property Attribute,苹果文档比较详细参考:文档

Demo 地址:我是Demo

//Demo Class
#import "NSObject+TestExtension.h"
#import <objc/runtime.h>

static NSSet *foundationClasses_;

@implementation NSObject (TestExtension)
+ (instancetype)test_JsonToModelWithDictionary:(NSDictionary *)dict
{
    Class clazz = [self class];
    id model = [[clazz alloc] init];
    
    unsigned int count;
    objc_property_t *propertys = class_copyPropertyList(clazz, &count);
    
    //1. 遍历Class中的Property
    for (int i = 0; i < count; i++) {
        NSString *propertyName = @(property_getName(propertys[i]));
        NSString *propertyAttribute =@(property_getAttributes(propertys[i]));
        
        
        // 2. 获取Value
        id value = [dict objectForKey:propertyName];
        if (!value || [value isKindOfClass:[NSNull class]]) {
            continue;
        }
        
        // 3. 如果是其他类,递归调用
        Class propertyClazz = [self getClassFromAttrs:propertyAttribute];
        if (propertyClazz) {
            value = [propertyClazz test_JsonToModelWithDictionary:value];
        }
        
        [model setValue:value forKey:propertyName];
        
    }
    
    return model;
}

+ (Class)getClassFromAttrs:(NSString *)attrs
{
    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)];
    }
    
    if(code.length > 3 && [code hasPrefix:@"@\""])
    {
        // 去掉@"和",截取中间的类型名称
        code = [code substringWithRange:NSMakeRange(2, code.length - 3)];
        Class clazz = NSClassFromString(code);
        if (![self isClassFromFoundation:clazz]) {
            return clazz;
        }
    }
    
    return nil;
}

+ (BOOL)isClassFromFoundation:(Class)c
{
    if (foundationClasses_ == nil) {
        foundationClasses_ = [NSSet setWithObjects:
                              [NSURL class],
                              [NSDate class],
                              [NSValue class],
                              [NSData class],
                              [NSError class],
                              [NSArray class],
                              [NSDictionary class],
                              [NSString class],
                              [NSAttributedString class], nil];
    }
    
    if (c == [NSObject class]) return YES;
    
    __block BOOL result = NO;
    [foundationClasses_ enumerateObjectsUsingBlock:^(Class foundationClass, BOOL *stop) {
        if ([c isSubclassOfClass:foundationClass]) {
            result = YES;
            *stop = YES;
        }
    }];
    return result;
}


@end

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容