iOS中yy_model解析

JSON转Model

id json —> dict —> Model

原理是用Runtime换取Model的属性,生成映射表,然后objc_msgSend(…)调用setter方法赋值

你给我一个 Model 类，我会用 runtime 提供的各种函数来拿到你所有的属性和对应的get``set，判断完相应的类型以后，调用objc_msgSend(...)。

// json转模型
+ (instancetype)yy_modelWithJSON:(id)json;
 
// 模型转字符串
- (NSString *)yy_modelToJSONString 
 
// 字典转模型
+ (instancetype)yy_modelWithDictionary:(NSDictionary *)dictionary ;
 
// 声明数组、字典或者集合里的元素类型时要重写
+ (nullable NSDictionary<NSString *, id> *)modelContainerPropertyGenericClass；
 
// 字典里的key值与模型的属性值不一致要重复 需遵循<YYModel>
+ (nullable NSDictionary<NSString *, id> *)modelCustomPropertyMapper;
//黑名单 需遵循<modelPropertyBlacklis>
+ (nullable NSArray<NSString *> *)modelPropertyBlacklist;
//白名单 需遵循<modelPropertyWhitelist>
+ (nullable NSArray<NSString *> *)modelPropertyWhitelist;

最常用的就是下边三个，用法：

1.字典转模型，这个很简单不说了；

// JSON:
{
    "uid":123456,
    "name":"Harry",
    "created":"1965-07-31T00:00:00+0000"
}

// Model:
@interface User : NSObject
@property UInt64 uid;
@property NSString *name;
@property NSDate *created;
@end
@implementation User
@end

    
// 将 JSON (NSData,NSString,NSDictionary) 转换为 Model:
User *user = [User yy_modelWithJSON:json];
    
// 将 Model 转换为 JSON 对象:
NSDictionary *json = [user yy_modelToJSONObject];

2.声明数组、字典或者集合元素是要重写：

+ (NSDictionary<NSString *,id> *)modelContainerPropertyGenericClass {
    return @{
             @"result":ResultModel.class,
             };
}

3.字典里的key值与模型的属性值不一致（这个经常比如id等关键字）

Model 属性名和 JSON 中的 Key 不相同
// JSON:
{
    "n":"Harry Pottery",
    "p": 256,
    "ext" : {
        "desc" : "A book written by J.K.Rowing."
    },
    "ID" : 100010
}

// Model:
@interface Book : NSObject
@property NSString *name;
@property NSInteger page;
@property NSString *desc;
@property NSString *bookID;
@end
@implementation Book
//返回一个 Dict，将 Model 属性名对映射到 JSON 的 Key。
+ (NSDictionary *)modelCustomPropertyMapper {
    return @{@"name" : @"n",
             @"page" : @"p",
             @"desc" : @"ext.desc",
             @"bookID" : @[@"id",@"ID",@"book_id"]};
}
@end
//如
+ (NSDictionary<NSString *,id> *)modelCustomPropertyMapper{
  
    return @{@"pid":@"id"};
}

4、容器类属性

@class Shadow, Border, Attachment;

@interface Attributes
@property NSString *name;
@property NSArray *shadows; //Array<Shadow>
@property NSSet *borders; //Set<Border>
@property NSMutableDictionary *attachments; //Dict<NSString,Attachment>
@end

@implementation Attributes
// 返回容器类中的所需要存放的数据类型 (以 Class 或 Class Name 的形式)。
+ (NSDictionary *)modelContainerPropertyGenericClass {
    return @{@"shadows" : [Shadow class],
             @"borders" : Border.class,
             @"attachments" : @"Attachment" };
}
@end

6、黑名单与白名单
@interface User
@property NSString *name;
@property NSUInteger age;
@end
    
@implementation Attributes
// 如果实现了该方法，则处理过程中会忽略该列表内的所有属性
+ (NSArray *)modelPropertyBlacklist {
    return @[@"test1", @"test2"];
}
// 如果实现了该方法，则处理过程中不会处理该列表外的属性。
+ (NSArray *)modelPropertyWhitelist {
    return @[@"name"];
}
@end