簡介
YYModel是YYKit的高效組件之一刹悴，在實際場景中的非常實用行楞，運用于項目中使用MVC或MVVM架構(gòu)時，使用model做數(shù)據(jù)處理土匀。
自動轉(zhuǎn)換模型數(shù)據(jù)
自動檢測數(shù)據(jù)安全性子房，避免carch
無需繼承其他類，使用方便
適用model各種數(shù)據(jù)加載運用場景
在使用之前先展示一些YYModel比較常用的方法就轧，后面會具體介紹用法
// 字典轉(zhuǎn)模型
+ (nullable instancetype)modelWithDictionary:(NSDictionary *)dictionary;
// json轉(zhuǎn)模型
+ (nullable instancetype)modelWithJSON:(id)json;
// 模型轉(zhuǎn)NSObject
- (nullable id)modelToJSONObject;
// 模型轉(zhuǎn)NSData
- (nullable NSData *)modelToJSONData;
// 模型轉(zhuǎn)json字符串
- (nullable NSString *)modelToJSONString;
// 模型深拷貝
- (nullable id)modelCopy;
// 判斷模型是否相等
- (BOOL)modelIsEqual:(id)model;
// 屬性數(shù)據(jù)映射证杭，用來定義多樣化數(shù)據(jù)時轉(zhuǎn)換聲明
+ (nullable NSDictionary<NSString *, id> *)modelCustomPropertyMapper;
// 屬性自定義類映射，用來實現(xiàn)自定義類的轉(zhuǎn)換聲明
+ (nullable NSDictionary<NSString *, id> *)modelContainerPropertyGenericClass;
// 屬性黑名單妒御，該名單屬性不轉(zhuǎn)換為model
+ (nullable NSArray<NSString *> *)modelPropertyBlacklist;
// 屬性白名單躯砰，只有該名單的屬性轉(zhuǎn)換為model
+ (nullable NSArray<NSString *> *)modelPropertyWhitelist;
// JSON 轉(zhuǎn)為 Model 完成后，該方法會被調(diào)用携丁，返回false該model會被忽略
// 同時可以在該model中做一些，轉(zhuǎn)換不能實現(xiàn)的操作，如NSDate類型轉(zhuǎn)換
- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic;
// Model 轉(zhuǎn)為 JSON 完成后梦鉴，該方法會被調(diào)用李茫，返回false該model會被忽略
// 同時可以在該model中做一些，轉(zhuǎn)換不能實現(xiàn)的操作肥橙，如NSDate類型轉(zhuǎn)換
- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic
運用場景
1魄宏、簡單的數(shù)據(jù)交換
YYModel最簡單的使用，在正常的數(shù)據(jù)調(diào)用存筏，創(chuàng)建一個model類YYPersonModel宠互，增加幾個屬性。
// YYPersonModel.h
@interface YYPersonModel : NSObject
@property (copy, nonatomic) NSString *name;
@property (assign, nonatomic) int age;
@property (copy, nonatomic) NSString *sex;
@end
接著在viewController導(dǎo)入<NSObject+YYModel.h>頭文件椭坚，直接進(jìn)行賦值就可以了予跌，數(shù)據(jù)類型可可以是JSON/Dictionary，具體的可以看<NSObject+YYModel.h>給出的方法善茎。
// ViewController.m
NSDictionary *dic = @{
@"name":@"張三",
@"age":@(12),
@"sex":@"男"
};
// 將數(shù)據(jù)轉(zhuǎn)模型
YYPersonModel *model = [YYPersonModel modelWithDictionary:dic];
// 將模型轉(zhuǎn)數(shù)據(jù)
NSDictionary *dics = [model modelToJSONObject];
使用起來是不是變得特別方便券册，會自動根據(jù)key一一映射到對應(yīng)的屬性中對數(shù)據(jù)進(jìn)行賦值，事實上使用只調(diào)用modelWithDictionary一個方法垂涯，剩下的YYModel會幫你處理里面的數(shù)據(jù)烁焙，自動進(jìn)行安全性判斷和值類型轉(zhuǎn)換。
2耕赘、自定義屬性映射數(shù)據(jù)交換
YYModel支持自定義的屬性名進(jìn)行映射骄蝇，即數(shù)據(jù)的key和屬性名可以是不相同。那么怎么才知道你自定義的屬性名對應(yīng)的是數(shù)據(jù)的哪個key呢操骡？那就需要對自定義屬性的映射進(jìn)行映射聲明九火。例如該例子中的personId：
// YYPersonModel.h
@interface YYPersonModel : NSObject
@property (strong, nonatomic) NSNumber *personId;
@property (copy, nonatomic) NSString *name;
@property (assign, nonatomic) int age;
@property (copy, nonatomic) NSString *sex;
@end
在YYPersonModel.m 重寫yymodel的方法modelCustomPropertyMapper，返回設(shè)定的映射值,并且YYModel提供多個字段的映射当娱。
// YYPersonModel.m
+ (NSDictionary *)modelCustomPropertyMapper {
// 將personId映射到key為id的數(shù)據(jù)字段
return @{@"personId":@"id"};
// 映射可以設(shè)定多個映射字段
// return @{@"personId":@[@"id",@"uid",@"ID"]};
}
最后依然通過像原來的數(shù)據(jù)那樣吃既，直接通過字典的方式進(jìn)行模型轉(zhuǎn)換，當(dāng)key為id時跨细，會自動給personId賦值鹦倚，達(dá)到我們需要的效果。
// ViewController.m
NSDictionary *dic = @{
@"id":@"123",
@"name":@"張三",
@"age":@(12),
@"sex":@"男"
};
YYPersonModel *model = [YYPersonModel modelWithDictionary:dic];
NSLog(@"ID: %@",model.personId);
NSDictionary *dics = [model modelToJSONObject];
NSLog(@"ID: %@", dics[@"id"]);
3冀惭、多樣化的數(shù)據(jù)類型交換
YYModel支持多樣化的數(shù)據(jù)類型震叙，甚至字典，數(shù)組等數(shù)據(jù)散休，如果不存在媒楼，則該model會自動設(shè)置為null，該例子提出使用NSArray和NSDictionary作為數(shù)據(jù)戚丸，效果依然一樣
// YYPersonModel.h
@interface YYPersonModel : NSObject
@property (strong, nonatomic) NSNumber *personId;
@property (copy, nonatomic) NSString *name;
@property (assign, nonatomic) int age;
@property (copy, nonatomic) NSString *sex;
@property (strong, nonatomic) NSArray *languages;
@property (strong, nonatomic) NSDictionary *job;
@end
不得不說YYModel還是考慮很全面的划址，不僅支持各種類型數(shù)據(jù)扔嵌，甚至考慮到獲取到數(shù)據(jù)的層次關(guān)系并沒有那么完美，那么這個時候該怎么做呢夺颤。例如該例子中的獲取到sex痢缎，是嵌套在下一層，同樣的我們也需要去聲明：
// YYPersonModel.m
+ (NSDictionary *)modelCustomPropertyMapper {
return @{
@"personId":@"id",
@"sex":@"sexDic.sex" // 聲明sex字段在sexDic下的sex
};
}
在數(shù)據(jù)中依然可以找到NSArray和NSDictionary和sexDic下的sex字段并轉(zhuǎn)化為模型
// ViewController.m
NSDictionary *dic = @{
@"id":@"123",
@"name":@"張三",
@"age":@(12),
@"sexDic":@{@"sex":@"男"},
@"languages":@[
@"漢語",@"英語",@"法語"
],
@"job":@{
@"work":@"iOS開發(fā)",
@"eveDay":@"10小時",
@"site":@"軟件園"
}
};
YYPersonModel *model = [YYPersonModel modelWithDictionary:dic];
4世澜、自定義類數(shù)據(jù)轉(zhuǎn)換
項目使用過程中独旷，我們會涉及到多個model嵌套使用的情況，關(guān)于自定義類的聲明寥裂，YYModel提供給我們另外一個方法modelContainerPropertyGenericClass嵌洼。例如我們在屬性中定義了YYEatModel作為類型。
// YYPersonModel.h
@interface YYEatModel : NSObject
@property (copy, nonatomic)NSString *food;
@property (copy, nonatomic)NSString *date;
@end
@interface YYPersonModel : NSObject
@property (strong, nonatomic) NSNumber *personId;
@property (copy, nonatomic) NSString *name;
@property (assign, nonatomic) int age;
@property (copy, nonatomic) NSString *sex;
@property (strong, nonatomic) NSArray *languages;
@property (strong, nonatomic) NSDictionary *job;
@property (strong, nonatomic) NSArray <YYEatModel *> *eats;
@end
使用modelContainerPropertyGenericClass對賦值的key進(jìn)行聲明后封恰，可直接賦值麻养。
// YYPersonModel.m
+ (NSDictionary *)modelCustomPropertyMapper {
return @{
@"personId":@"id",
@"sex":@"sexDic.sex" // 聲明sex字段在sexDic下的sex
};
}
// 聲明自定義類參數(shù)類型
+ (NSDictionary *)modelContainerPropertyGenericClass {
// value使用[YYEatModel class]或YYEatModel.class或@"YYEatModel"沒有區(qū)別
return @{@"eats" : [YYEatModel class]};
}
// ViewController.m
NSDictionary *dic = @{
@"id":@"123",
@"name":@"張三",
@"age":@(12),
@"sexDic":@{@"sex":@"男"},
@"languages":@[
@"漢語",@"英語",@"法語"
],
@"job":@{
@"work":@"iOS開發(fā)",
@"eveDay":@"10小時",
@"site":@"軟件園"
},
@"eats":@[
@{@"food":@"西瓜",@"date":@"8點"},
@{@"food":@"烤鴨",@"date":@"14點"},
@{@"food":@"西餐",@"date":@"20點"}
]
};
YYPersonModel *model = [YYPersonModel modelWithDictionary:dic];
for (YYEatModel *eat in model.eats) {
NSLog(@"%@",eat.food);
}
5、YYModel數(shù)據(jù)的其他處理
在轉(zhuǎn)化過程中俭驮，YYModel提供了過濾的功能回溺，可以將想要轉(zhuǎn)換的屬性或者不需要轉(zhuǎn)換的屬性加入到黑白名單中，通常不同時使用混萝。
// YYPersonModel.m
// 黑白名單不同時使用
// 如果實現(xiàn)了該方法遗遵，則處理過程中會忽略該列表內(nèi)的所有屬性
+ (NSArray *)modelPropertyBlacklist {
return @[@"sex", @"languages"];
}
// 如果實現(xiàn)了該方法，則處理過程中不會處理該列表外的屬性逸嘀。
+ (NSArray *)modelPropertyWhitelist {
return @[@"eats"];
}
有時候轉(zhuǎn)換后的model并不是我們最終想要的车要，這個情況轉(zhuǎn)換結(jié)束時YYModel提供了校驗的接口，可以在該接口中崭倘，校驗轉(zhuǎn)換的結(jié)果返回false則直接忽略該model翼岁，同時可以在該接口中處理轉(zhuǎn)換過程中，不能處理的數(shù)據(jù)司光。
// YYPersonModel.m
// 當(dāng) JSON 轉(zhuǎn)為 Model 完成后琅坡，該方法會被調(diào)用。
- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic {
// 可以在這里處理一些數(shù)據(jù)邏輯残家，如NSDate格式的轉(zhuǎn)換
return YES;
}
// 當(dāng) Model 轉(zhuǎn)為 JSON 完成后榆俺，該方法會被調(diào)用。
- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic {
return YES;
}
最后在Model使用過程中坞淮，往往會遇到一個深拷貝的問題茴晋，為了不改變原model的數(shù)據(jù)，YYModel也提供了一個接口實現(xiàn)深拷貝回窘。至于不懂深拷貝的同學(xué)可以先去網(wǎng)上了解一下
// ViewController.m
// 深拷貝model
YYPersonModel *model2 = [model modelCopy];
