YYModel使用總結(jié)
高性能 iOS/OSX 模型轉(zhuǎn)換框架
該項目是 YYKit 組件之一
性能
處理 GithubUser 數(shù)據(jù) 10000 次耗時統(tǒng)計 (iPhone 6):
特性
- 高性能: 模型轉(zhuǎn)換性能接近手寫解析代碼奕污。
- 自動類型轉(zhuǎn)換: 對象類型可以自動轉(zhuǎn)換，詳情見下方表格征冷。
- 類型安全: 轉(zhuǎn)換過程中国拇，所有的數(shù)據(jù)類型都會被檢測一遍黍瞧，以保證類型安全躬翁，避免崩潰問題昧旨。
- 無侵入性: 模型無需繼承自其他基類拜轨。
- 輕量: 該框架只有 5 個文件 (包括.h文件)抽减。
- 文檔和單元測試: 文檔覆蓋率100%, 代碼覆蓋率99.6%。
使用方法
簡單的 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 對象:
NSDictionary *json = [user yy_modelToJSONObject];
當(dāng) JSON/Dictionary 中的對象類型與 Model 屬性不一致時橄碾，YYModel將會進行如下自動轉(zhuǎn)換卵沉。自動轉(zhuǎn)換不支持的值將會被忽略颠锉，以免各種潛在的崩潰問題
| JSON/Dictionary | Model |
|---|---|
| NSString | NSNumber,NSURL,SEL,Class |
| NSNumber | NSString |
| NSString/NSNumber | 基礎(chǔ)類型 (BOOL,int,float,NSUInteger,UInt64,...) NaN和Inf 會被忽略 |
| NSString | NSDate 以下列格式解析: 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 |
| NSDate | NSString 格式化為 ISO8601: "YYYY-MM-dd'T'HH:mm:ssZ" |
| NSValue | struct (CGRect,CGSize,...) |
| NSNull | nil,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) 映射到一個或多個屬性琼掠。如果一個屬性沒有映射關(guān)系，那默認(rèn)會使用相同屬性名作為映射停撞。
在 json->model 的過程中：如果一個屬性對應(yīng)了多個 json key瓷蛙，那么轉(zhuǎn)換過程會按順序查找，并使用第一個不為空的值戈毒。
在 model->json 的過程中：如果一個屬性對應(yīng)了多個 json key (key path)艰猬，那么轉(zhuǎn)換過程僅會處理第一個 json key (key path)；如果多個屬性對應(yīng)了同一個 json key埋市，則轉(zhuǎn)換過過程會使用其中任意一個不為空的值姥宝。
Model 包含其他 Model
// JSON
{
"author":{
"name":"J.K.Rowling",
"birthday":"1965-07-31T00:00:00+0000"
},
"name":"Harry Potter",
"pages":256
}
// Model
@interface Book : NSObject
@property NSString *name;
@property NSUInteger pages;
@property Author *author; //Book 包含 Author 屬性
@end
@implementation Book
@end
//被包含的Model什么都不用做，如果屬性名不對應(yīng)恐疲，也要實現(xiàn)映射的方法 “+ (NSDictionary *)modelCustomPropertyMapper”
@interface Author : NSObject
@property NSString *name;
@property NSDate *birthday;
@end
@implementation Author
@end
容器類屬性
@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
// 返回容器類中的所需要存放的數(shù)據(jù)類型 (以 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
// 如果實現(xiàn)了該方法，則處理過程中會忽略該列表內(nèi)的所有屬性
+ (NSArray *)modelPropertyBlacklist {
return @[@"test1", @"test2"];
}
// 如果實現(xiàn)了該方法培己，則處理過程中不會處理該列表外的屬性碳蛋。
+ (NSArray *)modelPropertyWhitelist {
return @[@"name"];
}
@end
數(shù)據(jù)校驗與自定義轉(zhuǎn)換
// JSON:
{
"name":"Harry",
"timestamp" : 1445534567
}
// Model:
@interface User
@property NSString *name;
@property NSDate *createdAt;
@end
@implementation User
// 當(dāng) JSON 轉(zhuǎn)為 Model 完成后，該方法會被調(diào)用省咨。
// 你可以在這里對數(shù)據(jù)進行校驗肃弟，如果校驗不通過，可以返回 NO零蓉，則該 Model 會被忽略笤受。
// 你也可以在這里做一些自動轉(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 完成后敌蜂，該方法會被調(diào)用箩兽。
// 你可以在這里對數(shù)據(jù)進行校驗，如果校驗不通過章喉，可以返回 NO汗贫，則該 Model 會被忽略。
// 你也可以在這里做一些自動轉(zhuǎn)換不能完成的工作秸脱。
- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic {
if (!_createdAt) return NO;
dic[@"timestamp"] = @(n.timeIntervalSince1970);
return YES;
}
@end
Coding/Copying/hash/equal/description
@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]; }
- (NSString *)description { return [self yy_modelDescription]; }
@end
安裝
CocoaPods
- 在 Podfile 中添加 pod 'YYModel'落包。
- 執(zhí)行 pod install 或 pod update。
- 導(dǎo)入 <YYModel/YYModel.h>摊唇。
Carthage
- 在 Cartfile 中添加 github "ibireme/YYModel"咐蝇。
- 執(zhí)行 carthage update --platform ios 并將生成的 framework 添加到你的工程。
- 導(dǎo)入 <YYModel/YYModel.h>巷查。
手動安裝
- 下載 YYModel 文件夾內(nèi)的所有內(nèi)容有序。
- 將 YYModel 內(nèi)的源文件添加(拖放)到你的工程抹腿。
- 導(dǎo)入 YYModel.h。
文檔
你可以在 CocoaDocs 查看在線 API 文檔笔呀，也可以用 appledoc 本地生成文檔幢踏。
系統(tǒng)要求
該項目最低支持 iOS 6.0 和 Xcode 7.0。
許可證
YYModel 使用 MIT 許可證许师，詳情見 LICENSE 文件房蝉。
github原文地址
https://github.com/ibireme/YYModel#codingcopyinghashequaldescription-1
