YYModel的幾種使用場(chǎng)景

一、YYModel的使用場(chǎng)景

1.簡(jiǎn)單的 Model 與 JSON 相互轉(zhuǎn)換

// 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) 轉(zhuǎn)換為 Model:

User *user = [User yy_modelWithJSON:json];

// 將 Model 轉(zhuǎn)換為 JSON 對(duì)象:

NSDictionary *json = [user yy_modelToJSONObject];

JSON/Dictionary 中的對(duì)象類(lèi)型與 Model 屬性不一致時(shí),YYModel 將會(huì)進(jìn)行如下自動(dòng)轉(zhuǎn)換。自動(dòng)轉(zhuǎn)換不支持的值將會(huì)被忽略,以避免各種潛在的崩潰問(wèn)題。

格式自動(dòng)轉(zhuǎn)換.png

2.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

//返回一個(gè) Dict,將 Model 屬性名對(duì)映射到 JSON 的 Key。

+ (NSDictionary *)modelCustomPropertyMapper {

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

@"page" : @"p",

@"desc" : @"ext.desc",

@"bookID" : @[@"id",@"ID",@"book_id"]};

}

@end

你可以把一個(gè)或一組 json key (key path) 映射到一個(gè)或多個(gè)屬性。如果一個(gè)屬性沒(méi)有映射關(guān)系,那默認(rèn)會(huì)使用相同屬性名作為映射。

在 json->model 的過(guò)程中:如果一個(gè)屬性對(duì)應(yīng)了多個(gè) json key,那么轉(zhuǎn)換過(guò)程會(huì)按順序查找,并使用第一個(gè)不為空的值。

在 model->json 的過(guò)程中:如果一個(gè)屬性對(duì)應(yīng)了多個(gè) json key (key path),那么轉(zhuǎn)換過(guò)程僅會(huì)處理第一個(gè) json key (key path);如果多個(gè)屬性對(duì)應(yīng)了同一個(gè) json key,則轉(zhuǎn)換過(guò)過(guò)程會(huì)使用其中任意一個(gè)不為空的值。

3.Model 包含其他 Model

// JSON

{

"author":{

"name":"J.K.Rowling",

"birthday":"1965-07-31T00:00:00+0000"

},

"name":"Harry Potter",

"pages":256

}

// Model: 什么都不用做,轉(zhuǎn)換會(huì)自動(dòng)完成

@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

4.容器類(lèi)屬性

@class Shadow, Border, Attachment;

@interface Attributes

@property NSString *name;

@property NSArray *shadows; //Array

@property NSSet *borders; //Set

@property NSMutableDictionary *attachments; //Dict

@end

@implementation Attributes

// 返回容器類(lèi)中的所需要存放的數(shù)據(jù)類(lèi)型 (以 Class 或 Class Name 的形式)。

+ (NSDictionary *)modelContainerPropertyGenericClass {

return @{@"shadows" : [Shadow class],

@"borders" : Border.class,

@"attachments" : @"Attachment" };

}

@end

在實(shí)際使用過(guò)過(guò)程中,[Shadow class],Border.class,@"Attachment"沒(méi)有明顯的區(qū)別。

這里僅僅是創(chuàng)建作者有說(shuō)明,實(shí)際使用時(shí),需要對(duì)其遍歷,取出容器中得字典,然后繼續(xù)字典轉(zhuǎn)模型。(YYModel的核心是通過(guò)runtime獲取結(jié)構(gòu)體中得Ivars的值,將此值定義為key,然后給keyvalue值,所以我們需要自己遍歷容器(NSArrayNSSetNSDictionary),獲取每一個(gè)值,然后KVC)。

具體的代碼實(shí)現(xiàn)如下:

NSDictionary *json =[self getJsonWithJsonName:@"ContainerModel"];

ContainerModel *containModel = [ContainerModel yy_modelWithDictionary:json];

NSDictionary *dataDict = [containModel valueForKey:@"data"];

//定義數(shù)組,接受key為list的數(shù)組

self.listArray = [dataDict valueForKey:@"list"];

//遍歷數(shù)組

[self.listArray enumerateObjectsUsingBlock:^(id? _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {

NSDictionary *listDict = obj;

//獲取數(shù)組中得字典

List *listModel = [List yy_modelWithDictionary:listDict];

//獲取count 和 id

NSString *count = [listModel valueForKey:@"count"];

NSString *id = [listModel valueForKey:@"id"];

5.黑名單與白名單

@interface User

@property NSString *name;

@property NSUInteger age;

@end

@implementation Attributes

// 如果實(shí)現(xiàn)了該方法,則處理過(guò)程中會(huì)忽略該列表內(nèi)的所有屬性

+ (NSArray *)modelPropertyBlacklist {

return @[@"test1", @"test2"];

}

// 如果實(shí)現(xiàn)了該方法,則處理過(guò)程中不會(huì)處理該列表外的屬性。

+ (NSArray *)modelPropertyWhitelist {

return @[@"name"];

}

@end

6.數(shù)據(jù)校驗(yàn)與自定義轉(zhuǎn)換

實(shí)際這個(gè)分類(lèi)的目的比較簡(jiǎn)單和明確。

就是對(duì)判斷是否為時(shí)間戳,然后對(duì)時(shí)間戳進(jìn)行處理,調(diào)用

_createdAt = [NSDate dateWithTimeIntervalSince1970:timestamp.floatValue];

獲取時(shí)間。

// JSON:

{

"name":"Harry",

"timestamp" : 1445534567? ? //時(shí)間戳

}

// Model:

@interface User

@property NSString *name;

@property NSDate *createdAt;

@end

@implementation User

// 當(dāng) JSON 轉(zhuǎn)為 Model 完成后,該方法會(huì)被調(diào)用。

// 你可以在這里對(duì)數(shù)據(jù)進(jìn)行校驗(yàn),如果校驗(yàn)不通過(guò),可以返回 NO,則該 Model 會(huì)被忽略。

// 你也可以在這里做一些自動(dòng)轉(zhuǎn)換不能完成的工作。

- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic {

NSNumber *timestamp = dic[@"timestamp"];

if (![timestamp isKindOfClass:[NSNumber class]]) return NO;

_createdAt = [NSDate dateWithTimeIntervalSince1970:timestamp.floatValue];

return YES;

}

// 當(dāng) Model 轉(zhuǎn)為 JSON 完成后,該方法會(huì)被調(diào)用。

// 你可以在這里對(duì)數(shù)據(jù)進(jìn)行校驗(yàn),如果校驗(yàn)不通過(guò),可以返回 NO,則該 Model 會(huì)被忽略。

// 你也可以在這里做一些自動(dòng)轉(zhuǎn)換不能完成的工作。

- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic {

if (!_createdAt) return NO;

dic[@"timestamp"] = @(n.timeIntervalSince1970);

return YES;

}

@end

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容