YYModel的源码读后感

在项目的开发中，相信很多开发者都有json映射成Model的需求。在没有接触YYModel之前，我都是用自己写的转换类来映射。主要是通过runtime库，获取对象的属性列表，继而给需要的类的属性赋值。但是，这个类有几个缺点：

1.属性名称必须与被映射的字段名称相同

2.不能进行二级映射（如果Model里面包含另外一个Model，映射不了二级的）

于是，我开始找Model映射的开源库，在朋友的介绍下，我接触到了YYModel。发现它真的很强大：

1.它不需要任何操作就能进行多级映射

2.它能改变映射的名称，不需要属性与它一致

3.它支持容器类属性包含自定义类型

4.支持黑名单与白名单

那么，它是如何做到的呢？让我们一起来看看源码：

首先YYModel给我们做了很多容错性的功能，避免了很多崩溃问题。而且，在日期方面，也给我们增加了格式化，带来了不少的方便，这里我就不贴代码了。

YYModel里面，有一个类叫YYClassInfo，这个类主要是用与记录类的信息和类的属性信息。这个类不详细说，很容易看的明白。

NSObject+YYModel，这个是整个类库的核心类。那么，它是怎么工作的呢？

1.它不需要任何操作就能进行多级映射

首先，我们需要理解，什么是KVC。了解了KVC，我们才能了解，它是如何的支持多级映射。好，言归正传，KVC是KeyValueCoding的简称，它是一种可以直接通过字符串的名字(key)来访问类属性(实例变量)的机制。而不是通过调用Setter、Getter方法访问。一般来说，系统的get/set方式已经默认帮我们处理好了。其中，KVC有一个好处，就是valueForKeyPath，这个东西，可以让我们通过xx.xx.xx进行多级的访问，如果你进行KVO的监听，也可以通过这种形式来监听多级的属性。

既然我们知道KVC有这个特性，那么，只要我们对整个自定义的对象进行属性列表获取，然后，再解析它的KeyPath，用"."来分割这个KeyPath，如果个数大于1的话，说明这个属性是一个自定义的Model，那么，我们可以继续进行这个自定义Model的属性绑定。这样，我们就可以做到多级映射了。

2.它能改变映射的名称，不需要属性与它一致

YYModel里面有一个方法叫

+ (NSDictionary *)modelCustomPropertyMapper，只要我们复写这个方法

Example:

json:

{

"n":"Harry Pottery",

"p": 256,

"ext" : {

"desc" : "A book written by J.K.Rowing."

}

}

model:

@interface YYBook : NSObject

@property NSString *name;

@property NSInteger page;

@property NSString *desc;

@end

@implementation YYBook

+ (NSDictionary *)modelCustomPropertyMapper {

return @{@"name" : @"n",

@"page" : @"p",

@"desc" : @"ext.desc"};

}

@end

那么就能随意修改谁和谁绑定数据了。其实原理很简单，只要这个类，复写了这个方法，在遍历属性列表的时候，以这个方法返回的字典的key作为要遍历的属性，value作为赋值json数据的key就可以了。

3.它支持容器类属性包含自定义类型

其实它的原理就是在赋值的时候，去查看有没有自定义容器的内容属性，

_hasCustomClassFromDictionary，有的话，找这个方法modelContainerPropertyGenericClass进行处理就可以了。

4.支持黑名单与白名单

这个其实就是过滤掉某些属性，没什么好说的了。

在这里附上使用的方法：

使用方法

简单的 Model 与 JSON 相互转换

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

当 JSON/Dictionary 中的对象类型与 Model 属性不一致时，YYModel 将会进行如下自动转换。自动转换不支持的值将会被忽略，以避免各种潜在的崩溃问题。

JSON/Dictionary	Model
NSString	NSNumber,NSURL,SEL,Class
NSNumber	NSString
NSString/NSNumber	基础类型 (BOOL,int,float,NSUInteger,UInt64,...) NaN 和 Inf 会被忽略
NSString	NSDate 以下列格式解析: yyyy-MM-dd yyyy-MM-dd HH:mm:ss yyyy-MM-dd'T'HH:mm:ss yyyy-MM-dd'T'HH:mm:ssZ EEE MMM dd HH:mm:ss Z yyyy
NSDate	NSString 格式化为 ISO8601: "YYYY-MM-dd'T'HH:mm:ssZ"
NSValue	struct (CGRect,CGSize,...)
NSNull	nil,0
"no","false",...	@(NO),0
"yes","true",...	@(YES),1

Model 属性名和 JSON 中的 Key 不相同

// JSON:
{
    "n":"Harry Pottery",
    "p": 256,
    "ext" : {
        "desc" : "A book written by J.K.Rowing."
    }
}

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

Model 包含其他 Model

// JSON
{
    "author":{
        "name":"J.K.Rowling",
        "birthday":"1965-07-31T00:00:00+0000"
    },
    "name":"Harry Potter",
    "pages":256
}

// Model: 什么都不用做，转换会自动完成
@interface Author : NSObject
@property NSString *name;
@property NSDate *birthday;
@end
@implementation Author
@end

@interface Book : NSObject
@property NSString *name;
@property NSUInteger pages;
@property Author *author; //Book 包含 Author 属性
@end
@implementation Book
@end

容器类属性

@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

黑名单与白名单

@interface User
@property NSString *name;
@property NSUInteger age;
@end

@implementation Attributes
// 如果实现了该方法，则处理过程中会忽略该列表内的所有属性
+ (NSArray *)modelPropertyBlacklist {
    return @{@"test1", @"test2"};
}
// 如果实现了该方法，则处理过程中不会处理该列表外的属性。
+ (NSArray *)modelPropertyWhitelist {
    return @{@"name"};
}
@end

数据校验与自定义转换

// JSON:
{
    "name":"Harry",
    "timestamp" : 1445534567
}

// Model:
@interface User
@property NSString *name;
@property NSDate *createdAt;
@end

@implementation User
// 当 JSON 转为 Model 完成后，该方法会被调用。
// 你可以在这里对数据进行校验，如果校验不通过，可以返回 NO，则该 Model 会被忽略。
// 你也可以在这里做一些自动转换不能完成的工作。
- (BOOL))modelCustomTransformFromDictionary:(NSDictionary *)dic {
    NSNumber *timestamp = dic[@"timestamp"];
    if (![timestamp isKindOfClass:[NSNumber class]]) return NO;
    _createdAt = [NSDate dateWithTimeIntervalSince1970:timestamp.floatValue];
    return YES;
}

// 当 Model 转为 JSON 完成后，该方法会被调用。
// 你可以在这里对数据进行校验，如果校验不通过，可以返回 NO，则该 Model 会被忽略。
// 你也可以在这里做一些自动转换不能完成的工作。
- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic {
    if (!_createdAt) return NO;
    dic[@"timestamp"] = @(n.timeIntervalSince1970);
    return YES;
}
@end

Coding/Copying/hash/equal

@interface YYShadow :NSObject <NSCoding, NSCopying>
@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) CGSize size;
@end

@implementation YYShadow
// 直接添加以下代码即可自动完成
- (void)encodeWithCoder:(NSCoder *)aCoder {

 [self yy_modelEncodeWithCoder:aCoder];
 
  }
  - (id)initWithCoder:(NSCoder *)aDecoder {
  
 self = [super init]; return [self yy_modelInitWithCoder:aDecoder];
  
  }
  
  - (id)copyWithZone:(NSZone *)zone {
  
  
 return [self yy_modelCopy];
  
  
  }
  
  
  - (NSUInteger)hash { 
  
  
  return [self yy_modelHash]; 
  
  
  }
  
  
  - (BOOL)isEqual:(id)object { 
  
  
  return [self yy_modelIsEqual:object]; 
  
  
  }
@end