YYModel高性能 iOS數據模型轉換

YYmodel的底層核心是運用runtime獲取類結構體中Ivars，進行KVC操作，然後根據不同情況進行分別處理。
Git官方項目地址：https://github.com/ibireme/YYModel
處理 GithubUser 數據 10000 次耗時統計 (iPhone 6):

特性：

• 高性能: 模型轉換性能接近手寫解析代碼。
• 自動類型轉換: 對象類型可以自動轉換，詳情見下方表格。
• 類型安全: 轉換過程中，所有的數據類型都會被檢測一遍，以保證類型安全，避免崩潰問題。
• 無侵入性: 模型無需繼承自其他基類。
• 輕量: 該框架只有 5 個文件 (包括.h文件)。
• 文檔和單元測試: 文檔覆蓋率100%, 代碼覆蓋率99.6%。

使用方法：

簡單的 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 將會進行如下自動轉換。自動轉換不支持的值將會被忽略，以避免各種潛在的崩潰問題。

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<Shadow>
@property NSSet *borders; //Set<Border>
@property NSMutableDictionary *attachments; //Dict<NSString,Attachment>
@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 <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'。
• 執行 pod install 或 pod update
• 導入<YYModel/YYModel>。