教你使用runtime写一个简单的字典转模型的工具类

一.自动生成属性的分类

模型属性，通常需要跟字典中的key一一对应。从服务器得到的数据太杂？数据太多？写成plist文件后一个个对照填写属性，太繁琐？那么我么可以尝试写一个分类来自动打印出所有属性。
    •    需求：能不能根据一个字典，自动生成对应的属性。
    •    解决：提供一个分类，专门根据字典生成对应的属性字符串。

#import <Foundation/Foundation.h>

@interface NSDictionary (PropertyCode)

// 生成属性代码
- (void)createPropetyCode;
@end

@implementation NSDictionary (PropertyCode)
// 私有API:真实存在,但是苹果没有暴露出来,不给你用
// isKindOfClass:判断下是否是当前类或者子类
// 自动生成属性代码
- (void)createPropetyCode
{
    NSMutableString *codes = [NSMutableString string];
    // 遍历字典
    [self enumerateKeysAndObjectsUsingBlock:^(id  _Nonnull key, id  _Nonnull value, BOOL * _Nonnull stop) {
        NSString *code = nil;
        
        if ([value isKindOfClass:[NSString class]]) {// 注：NSString *笔者喜欢用strong，若想使用copy可修改字符串
          code = [NSString stringWithFormat:@"@property (nonatomic, strong) NSString *%@;",key];
        } else if ([value isKindOfClass:NSClassFromString(@"__NSCFBoolean")]){
            code = [NSString stringWithFormat:@"@property (nonatomic, assign) BOOL %@;",key];
        } else if ([value isKindOfClass:[NSNumber class]]) {
             code = [NSString stringWithFormat:@"@property (nonatomic, assign) NSInteger %@;",key];
        } else if ([value isKindOfClass:[NSArray class]]) {
            code = [NSString stringWithFormat:@"@property (nonatomic, strong) NSArray *%@;",key];
        } else if ([value isKindOfClass:[NSDictionary class]]) {
            code = [NSString stringWithFormat:@"@property (nonatomic, strong) NSDictionary *%@;",key];
        }
        
        // 拼接字符串
        [codes appendFormat:@"\n%@\n",code];

    }];
    
    NSLog(@"%@",codes);
}
@end

外界使用：

#import "ViewController.h"
#import "Status.h"
#import "NSDictionary+PropertyCode.h"
/*
    plist:
    字典
    字典转模型
 */

@interface ViewController ()

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    
    // 解析Plist
    // 获取文件全路径
    NSString *fileName = [[NSBundle mainBundle] pathForResource:@"status.plist" ofType:nil];
    // 获取字典
    NSDictionary *dict = [NSDictionary dictionaryWithContentsOfFile:fileName];
    
    // 设计模型-定义属性
    // 自动生成属性代码
    [dict createPropetyCode];
}
@end

status.plist

控制台打印信息：

2016-04-15 10:43:34.959 Runtime(自动生成属性)[38837:1398902]
@property (nonatomic, assign) BOOL aaa;

@property (nonatomic, assign) NSInteger reposts_count;

@property (nonatomic, copy) NSString *source;

@property (nonatomic, strong) NSArray *pic_urls;

@property (nonatomic, copy) NSString *created_at;

@property (nonatomic, assign) NSInteger attitudes_count;

@property (nonatomic, copy) NSString *idstr;

@property (nonatomic, copy) NSString *text;

@property (nonatomic, assign) NSInteger comments_count;

@property (nonatomic, strong) NSDictionary *user;

二.字典转模型KVC实现

KVC必须要保证:模型中属性名要跟字典中key一一对应。

需求:开发中,通常后台会给你很多数据,但是并不是每个数据都有用,这些没有用的数据,需不需要保存到模型中？

使用KVC把字典转成模型：

#import <Foundation/Foundation.h>

@interface Status : NSObject

// 字典中有多少key,模型就有多少个属性

// 自动生成属性 -> 依赖字典

@property (nonatomic, assign) BOOL aaa;

@property (nonatomic, strong) NSString *source;

@property (nonatomic, assign) NSInteger reposts_count;

@property (nonatomic, strong) NSArray *pic_urls;

@property (nonatomic, strong) NSString *created_at;

@property (nonatomic, assign) NSInteger attitudes_count;

@property (nonatomic, strong) NSString *idstr;

@property (nonatomic, strong) NSString *text;

@property (nonatomic, assign) NSInteger comments_count;

@property (nonatomic, strong) NSDictionary *user;

// 定义属性 -> 设计模型
+ (instancetype)statusWithDict:(NSDictionary *)dict;
@end

@implementation Status
+ (instancetype)statusWithDict:(NSDictionary *)dict{
    // 创建模型
    Status *s = [[self alloc] init];
    
    // 字典value转模型属性保存
    [s setValuesForKeysWithDictionary:dict];

    return s;
}
@end

KVC的底层实现：

setValuesForKeysWithDictionary:遍历字典中所有key,去模型中查找对应的属性,把值给模型属性赋值。

    //[s setValuesForKeysWithDictionary:dict];底层实现：

    [dict enumerateKeysAndObjectsUsingBlock:^(id  _Nonnull key, id  _Nonnull obj, BOOL * _Nonnull stop) {

        [s setValue:obj forKey:key];
    }];

 [s setValue:dict[@"source"] forKey:@"source"];

原理：
 1.首先会去模型中查找有没有【setSource方法】,如果有 直接调用set方法 [s setSource:dict[@"source"]];
 2.否则,去模型中查找有没有【source属性】,如果有 source = dict[@"source"]
 3.否则,去模型中查找有没有【_source属性】,如果有 _source = dict[@"source"]
 4.再否则,调用对象的 【setValue:forUndefinedKey:】直接报错

使用KVC最大的弊端：模型中属性名要跟字典中key一一对应，不对应就会报错：

 2016-04-15 11:11:29.591 Runtime(字典转模型KVC实现)[39288:1411792] *** Terminating app due to uncaught exception 'NSUnknownKeyException', reason: '[<Status 0x7f9cb9f19680> setValue:forUndefinedKey:]: this class is not key value coding-compliant for the key source.'

那么，【重写setValue:forUndefinedKey:方法】，屏蔽系统报错就能解决模型中属性名要跟字典中key必须对应的问题。

@implementation Status
+ (instancetype)statusWithDict:(NSDictionary *)dict{
    // 创建模型
    Status *s = [[self alloc] init];
    
    // 字典value转模型属性保存
    [s setValuesForKeysWithDictionary:dict];
   
    return s;
}

- (void)setValue:(id)value forUndefinedKey:(NSString *)key {}
@end

这样就不用把字典中的所有key都写入模型了，只需要写我们想要的数据。

三.Runtime字典转模型一级转换

刚刚介绍了字典转模型的第一种方式---KVC，下面进入主题。

•    字典转模型的方式二：Runtime
    ◦    思路：利用运行时，【遍历模型中所有属性，根据模型的属性名，去字典中查找key，取出对应的值，给模型的属性赋值】。
    ◦    步骤：提供一个NSObject分类，专门字典转模型，以后所有模型都可以通过这个分类来转。

#import <Foundation/Foundation.h>

@interface NSObject (Model)

+ (instancetype)modelWithDict:(NSDictionary *)dict;

@end


#import <objc/message.h>

//class_copyPropertyList(__unsafe_unretained Class cls, unsigned int *outCount)
//这个方法只能获取【属性】列表(大括号里的成员变量不能获取)

@implementation NSObject (Model)
+ (instancetype)modelWithDict:(NSDictionary *)dict
{
    id objc = [[self alloc] init];
    
    // 获取成员变量列表
    // 第一个参数class:获取哪个类成员变量列表
    // 第二个参数count:成员变量总数
    unsigned int count = 0;

    // 成员变量数组 指向数组第0个元素
    Ivar *ivarList = class_copyIvarList(self, &count);

    // 遍历所有成员变量
    for (int i = 0; i < count; i++) {
        // 获取成员变量
        Ivar ivar = ivarList[i];
        // 获取成员变量名称
        NSString *ivarName = [NSString stringWithUTF8String:ivar_getName(ivar)];
 
        // 成员变量名称转换key，去掉成员变量名称前面的下划线
        NSString *key = [ivarName substringFromIndex:1];
        
        // 从字典中取出对应value
        id value = dict[key];
        
        // 给模型中属性赋值
        [objc setValue:value forKey:key];
    }
    return objc;
}
@end

模型中只需要保留想要的属性名即可。

四.Runtime字典转模型二级转换

开发中可能会遇到，二级转换:如果字典中还有字典，也需要把对应的字典转换成模型，那么就需要二级转换。

#import <Foundation/Foundation.h>

@interface NSObject (Model)

+ (instancetype)modelWithDict:(NSDictionary *)dict;

@end

#import <objc/message.h>

@implementation NSObject (Model)
+ (instancetype)modelWithDict:(NSDictionary *)dict
{
    id objc = [[self alloc] init];

    unsigned int count = 0;

    // 成员变量数组 指向数组第0个元素
    Ivar *ivarList = class_copyIvarList(self, &count);

    // 遍历所有成员变量
    for (int i = 0; i < count; i++) {
        
        // 获取成员变量 user
        Ivar ivar = ivarList[i];
        // 获取成员变量名称
        NSString *ivarName = [NSString stringWithUTF8String:ivar_getName(ivar)];
        
        // 获取成员变量类型(后续判断是否进行二次转换)
        NSString *type = [NSString stringWithUTF8String:ivar_getTypeEncoding(ivar)];
        NSLog(@"%@",type);
        // @"@"User"" -> @"User"
        type = [type stringByReplacingOccurrencesOfString:@"@\"" withString:@""];
        type = [type stringByReplacingOccurrencesOfString:@"\"" withString:@""];
       
        // 成员变量名称转换key
        NSString *key = [ivarName substringFromIndex:1];
        
        // 从字典中取出对应value dict[@"user"] -> 字典
        id value = dict[key];
        
        // 二级转换
        // 并且是自定义类型,才需要转换
        if ([value isKindOfClass:[NSDictionary class]] && ![type containsString:@"NS"]) { // 只有是字典,并且不包含NS才需要转换
           
            //获取类名
            Class className = NSClassFromString(type);
            
            // 字典转模型
            value = [className modelWithDict:value];
        }
        
        // 给模型中属性赋值 key:user value:字典 ---> 模型
        if (value) {
            [objc setValue:value forKey:key];
        }
    }
    return objc;
}
@end