yymodel使用

/

**自定义类

/

@interfaceTeamInfo :NSObject

@property(nonatomic,copy) NSString * _Nonnull teamId;

@property(nonatomic,copy) NSString * _Nonnull per;//1表示权限范围内的，0表示权限范围外的，2表示所有的

@property(nonatomic,copy) NSString * _Nonnull pid;

@property(nonatomic,copy) NSString * _Nonnull text;//名称

@end

/**

 自定义属性(该方法在自定义类实现即可,不需要声明)

 @return 返回自定义属性字典(将 Model 属性名对映射到 JSON 的 Key)

 */

+ (nullableNSDictionary *)modelCustomPropertyMapper

{

    return @{@"teamId":@"id"};

}



简单的 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/DictionaryModel

NSStringNSNumber,NSURL,SEL,Class

NSNumberNSString

NSString/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 yyyy

NSDateNSString 格式化为 ISO8601:

"YYYY-MM-dd'T'HH:mm:ssZ"

NSValuestruct (CGRect,CGSize,...)

NSNullnil,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."

    },

    "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

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

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

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

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

@property NSSet *borders; //Set

@property NSMutableDictionary *attachments; //Dict

@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/description

@interface YYShadow :NSObject

@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]; }

- (NSString *)description { return [self yy_modelDescription]; }

@end



转自这里

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 202,723评论 5赞 476
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,080评论 2赞 379
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 149,604评论 0赞 335
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,440评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,431评论 5赞 364
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,499评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,893评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,541评论 0赞 256
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,751评论 1赞 296
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,547评论 2赞 319
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,619评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,320评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,890评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,896评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,137评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,796评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,335评论 2赞 342