iOS：YYModel的简单使用

简单的 Model 与 JSON 相互转换

<span style="font-weight: normal;">// 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];</span>

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

JSON/DictionaryModelNSStringNSNumber,NSURL,SEL,ClassNSNumberNSStringNSString/NSNumber基础类型 (BOOL,int,float,NSUInteger,UInt64,...)
NaN 和 Inf 会被忽略NSStringNSDate 以下列格式解析:
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 yyyyNSDateNSString 格式化为 ISO8601:
"YYYY-MM-dd'T'HH:mm:ssZ"NSValuestruct (CGRect,CGSize,...)NSNullnil,0"no","false",...@(NO),0"yes","true",...@(YES),1

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

<span style="font-weight: normal;">// 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</span>

你可以把一个或一组 json key (key path) 映射到一个或多个属性。如果一个属性没有映射关系，那默认会使用相同属性名作为映射。

在 json->model 的过程中：如果一个属性对应了多个 json key，那么转换过程会按顺序查找，并使用第一个不为空的值。

在 model->json 的过程中：如果一个属性对应了多个 json key (key path)，那么转换过程仅会处理第一个 json key (key path)；如果多个属性对应了同一个 json key，则转换过过程会使用其中任意一个不为空的值。

Model 包含其他 Model

<span style="font-weight: normal;">// 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</span>

容器类属性

<span style="font-weight: normal;">@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</span>

黑名单与白名单

<span style="font-weight: normal;">@interface User@property NSString *name;@property NSUInteger age;@end@implementation Attributes// 如果实现了该方法，则处理过程中会忽略该列表内的所有属性+ (NSArray *)modelPropertyBlacklist {    return @{@"test1", @"test2"};}// 如果实现了该方法，则处理过程中不会处理该列表外的属性。+ (NSArray *)modelPropertyWhitelist {    return @{@"name"};}@end</span>

数据校验与自定义转换

<span style="font-weight: normal;">// 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</span>

Coding/Copying/hash/equal

<span style="font-weight: normal;">@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</span>