前言
同項目中同事使用YYModel割以，比原生的要簡單高效許多！１炯ァ珊泳！
YYModel是YYKit的高效組件之一，在實際場景中的非常實用拷沸，運用于項目中使用MVC或MVVM架構時色查，使用model做數(shù)據(jù)處理。
自動轉換模型數(shù)據(jù)
自動檢測數(shù)據(jù)安全性撞芍，避免carch
無需繼承其他類秧了，使用方便
適用model各種數(shù)據(jù)加載運用場景
在使用之前先展示一些YYModel比較常用的方法，后面會具體介紹用法
// 字典轉模型
- (nullable instancetype)modelWithDictionary:(NSDictionary *)dictionary;
// json轉模型 - (nullable instancetype)modelWithJSON:(id)json;
// 模型轉NSObject
- (nullable id)modelToJSONObject;
// 模型轉NSData - (nullable NSData *)modelToJSONData;
// 模型轉json字符串 - (nullable NSString *)modelToJSONString;
// 模型深拷貝 - (nullable id)modelCopy;
// 判斷模型是否相等 - (BOOL)modelIsEqual:(id)model;
// 屬性數(shù)據(jù)映射序无，用來定義多樣化數(shù)據(jù)時轉換聲明
- (nullable NSDictionary<NSString *, id> *)modelCustomPropertyMapper;
// 屬性自定義類映射验毡，用來實現(xiàn)自定義類的轉換聲明 - (nullable NSDictionary<NSString *, id> *)modelContainerPropertyGenericClass;
// 屬性黑名單，該名單屬性不轉換為model - (nullable NSArray<NSString *> *)modelPropertyBlacklist;
// 屬性白名單帝嗡，只有該名單的屬性轉換為model - (nullable NSArray<NSString *> *)modelPropertyWhitelist;
// JSON 轉為 Model 完成后晶通，該方法會被調用，返回false該model會被忽略
// 同時可以在該model中做一些哟玷，轉換不能實現(xiàn)的操作狮辽，如NSDate類型轉換
- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic;
// Model 轉為 JSON 完成后，該方法會被調用巢寡，返回false該model會被忽略
// 同時可以在該model中做一些喉脖，轉換不能實現(xiàn)的操作，如NSDate類型轉換 - (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic
運用場景
1抑月、簡單的數(shù)據(jù)交換
YYModel最簡單的使用树叽，在正常的數(shù)據(jù)調用，創(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導入<NSObject+YYModel.h>頭文件，直接進行賦值就可以了挨稿，數(shù)據(jù)類型可可以是JSON/Dictionary仇轻，具體的可以看<NSObject+YYModel.h>給出的方法。
// ViewController.m
NSDictionary *dic = @{
@"name":@"張三",
@"age":@(12),
@"sex":@"男"
};
// 將數(shù)據(jù)轉模型
YYPersonModel *model = [YYPersonModel modelWithDictionary:dic];
// 將模型轉數(shù)據(jù)
NSDictionary *dics = [model modelToJSONObject];
使用起來是不是變得特別方便奶甘，會自動根據(jù)key一一映射到對應的屬性中對數(shù)據(jù)進行賦值篷店，事實上使用只調用modelWithDictionary一個方法，剩下的YYModel會幫你處理里面的數(shù)據(jù)，自動進行安全性判斷和值類型轉換疲陕。
2方淤、自定義屬性映射數(shù)據(jù)交換
YYModel支持自定義的屬性名進行映射，即數(shù)據(jù)的key和屬性名可以是不相同蹄殃。那么怎么才知道你自定義的屬性名對應的是數(shù)據(jù)的哪個key呢携茂？那就需要對自定義屬性的映射進行映射聲明。例如該例子中的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诅岩，返回設定的映射值,并且YYModel提供多個字段的映射讳苦。
// YYPersonModel.m
- (NSDictionary *)modelCustomPropertyMapper {
// 將personId映射到key為id的數(shù)據(jù)字段
return @{@"personId":@"id"};
// 映射可以設定多個映射字段
// return @{@"personId":@[@"id",@"uid",@"ID"]};
}
最后依然通過像原來的數(shù)據(jù)那樣，直接通過字典的方式進行模型轉換吩谦，當key為id時鸳谜，會自動給personId賦值，達到我們需要的效果式廷。
// 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會自動設置為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ù)的層次關系并沒有那么完美，那么這個時候該怎么做呢怀各。例如該例子中的獲取到sex倔韭，是嵌套在下一層，同樣的我們也需要去聲明：
// YYPersonModel.m
- (NSDictionary *)modelCustomPropertyMapper {
return @{
@"personId":@"id",
@"sex":@"sexDic.sex" // 聲明sex字段在sexDic下的sex
};
}
在數(shù)據(jù)中依然可以找到NSArray和NSDictionary和sexDic下的sex字段并轉化為模型
// 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ù)轉換
項目使用過程中寿酌，我們會涉及到多個model嵌套使用的情況，關于自定義類的聲明硕蛹，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進行聲明后法焰，可直接賦值秧荆。
// 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ù)的其他處理
在轉化過程中埃仪，YYModel提供了過濾的功能乙濒，可以將想要轉換的屬性或者不需要轉換的屬性加入到黑白名單中，通常不同時使用。
// YYPersonModel.m
// 黑白名單不同時使用
// 如果實現(xiàn)了該方法颁股，則處理過程中會忽略該列表內的所有屬性
- (NSArray *)modelPropertyBlacklist {
return @[@"sex", @"languages"];
}
// 如果實現(xiàn)了該方法么库，則處理過程中不會處理該列表外的屬性。 - (NSArray *)modelPropertyWhitelist {
return @[@"eats"];
}
有時候轉換后的model并不是我們最終想要的甘有，這個情況轉換結束時YYModel提供了校驗的接口诉儒，可以在該接口中，校驗轉換的結果返回false則直接忽略該model亏掀，同時可以在該接口中處理轉換過程中忱反，不能處理的數(shù)據(jù)。
// YYPersonModel.m
// 當 JSON 轉為 Model 完成后幌氮，該方法會被調用缭受。
- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic {
// 可以在這里處理一些數(shù)據(jù)邏輯，如NSDate格式的轉換
return YES;
}
// 當 Model 轉為 JSON 完成后该互，該方法會被調用米者。
- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic {
return YES;
}
最后在Model使用過程中，往往會遇到一個深拷貝的問題宇智，為了不改變原model的數(shù)據(jù)蔓搞，YYModel也提供了一個接口實現(xiàn)深拷貝。至于不懂深拷貝的同學可以先去網(wǎng)上了解一下
// ViewController.m
// 深拷貝model
YYPersonModel *model2 = [model modelCopy];
總結
到這里為止随橘，關于YYModel的詳細使用方法已經寫完喂分，基本上所有的使用場景都會在，如果有什么疑問可以給我留言机蔗。
