又一個高性能輕量級的iOS模型框架YYModel

前言

iOS的模型框架其實有不少了，去年研究過Mantle，也瞭解過JSONModel、MJExtension，最近的項目項目優化的時候，再次考慮，基於輕量級、高性能的考慮，最終選擇了YYModel。

項目主頁

YYModel

簡介

YYModel在Github的簡介是， iOS/OSX平臺下一個高性能的模型框架。下面這張圖片展現了原做者的性能比較：

特點功能

• 高性能：轉換效率接近手寫代碼。

• 自動類型轉換：對象類型能自動轉換。

• 類型安全：在轉換過程當中全部的類型都會被驗證，以確保類型安全。

• 非侵入性：不須要讓模型類繼承自基類。

• 輕量級：整個庫只包含5個文件。

• 文檔和測試覆蓋：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 將會進行以下自動轉換。自動轉換不支持的值將會被忽略，以免各類潛在的崩潰問題。

JSON/Dictionary	Model
NSString	NSNumber,NSURL,SEL,Class
NSNumber	NSString
NSString/NSNumber	基礎類型 (BOOL,int,float,NSUInteger,UInt64,…) NaN 和 Inf 會被忽略
NSString	NSDate 如下列格式解析: yyy-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) 映射到一個或多個屬性。若是一個屬性沒有映射關係，那默認會使用相同屬性名做爲映射。

在 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

1. 在 Podfile 中添加 pod 'YYModel'。

2. 執行 pod install 或 pod update。

3. 導入 <YYModel/YYModel.h>。

Carthage

1. 在 Cartfile 中添加 github "ibireme/YYModel"。

2. 執行 carthage update --platform ios 並將生成的 framework 添加到你的工程。

3. 導入 <YYModel/YYModel.h>。

手動安裝

1. 下載 YYModel 文件夾內的全部內容。

2. 將 YYModel 內的源文件添加(拖放)到你的工程。

3. 導入 YYModel.h。

系統要求

該項目最低支持 iOS 6.0 和 Xcode 7.0。

實例

Model定義

////  Stock.h//  YifaDemo////  Created by 唐有煒 on 16/3/29.//  Copyright (c) 2015年 Yifa Network. All rights reserved.//#import <Foundation/Foundation.h>@interface Stock : NSObject/**
 *  交易所
 */@property (nonatomic,copy) NSString *stockMarket;/**
 * 股票代碼
 */@property (nonatomic,copy) NSString *stockCode;/**
 *  機構信息
 */@property (nonatomic,copy) NSString *stockOrg;@end

////  Stock.m//  YifaDemo////  Created by 唐有煒 on 16/3/29.//  Copyright (c) 2015年 Yifa Network. All rights reserved.//#import "Stock.h"#import <YYModel/YYModel.h>@implementation Stock#pragma mark - Model 屬性名和 JSON 中的 Key 不相同//返回一個 Dict，將 Model 屬性名對映射到 JSON 的 Key。+ (NSDictionary *)modelCustomPropertyMapper {    return @{@"stockOrg" : @"prod_name"};
}#pragma mark - Model 包含其餘 Model// Model: 什麼都不用作，轉換會自動完成#pragma mark - 容器類屬性//@property NSArray *shadows; //Array<Shadow>//@property NSSet *borders; //Set<Border>//// 返回容器類中的所須要存放的數據類型 (以 Class 或 Class Name 的形式)。//+ (NSDictionary *)modelContainerPropertyGenericClass {//       return @{@"shadows" : [Shadow class],//                @"borders" : Border.class};//}#pragma mark - 黑名單與白名單//// 若是實現了該方法，則處理過程當中會忽略該列表內的全部屬性//+ (NSArray *)modelPropertyBlacklist {//    return @[@"test1", @"test2"];//}//// 若是實現了該方法，則處理過程當中不會處理該列表外的屬性。//+ (NSArray *)modelPropertyWhitelist {//    return @[@"test3"];//}#pragma mark - 數據校驗與自定義轉換// 當 JSON 轉爲 Model 完成後，該方法會被調用。// 你能夠在這裏對數據進行校驗，若是校驗不經過，能夠返回 NO，則該 Model 會被忽略。// 你也能夠在這裏作一些自動轉換不能完成的工做。- (BOOL)modelCustomTransformFromDictionary:(NSDictionary *)dic {
    _stockMarket = [dic[@"prod_code"] componentsSeparatedByString:@"."][1];
    _stockCode = [dic[@"prod_code"] componentsSeparatedByString:@"."][0];    return YES;
}//// 當 Model 轉爲 JSON 完成後，該方法會被調用。//// 你能夠在這裏對數據進行校驗，若是校驗不經過，能夠返回 NO，則該 Model 會被忽略。//// 你也能夠在這裏作一些自動轉換不能完成的工做。//- (BOOL)modelCustomTransformToDictionary:(NSMutableDictionary *)dic {//    return YES;//}#pragma mark - Coding/Copying/hash/equal//// 直接添加如下代碼便可自動完成//- (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]; }@end

使用

一、引用#import <YYModel/YYModel.h>

二、JSON轉Model

    Stock *stock = [Stock yy_modelWithJSON:json];
    
    Stock *stock = [Stock yy_modelWithDictionary:item];

三、 將 Model 轉換爲 JSON 對象:

    NSDictionary *dic = [stock yy_modelToJSONObject];    NSString *json = [stock yy_modelToJSONString];    NSData *data = [stock yy_modelToJSONData];

參考

iOS JSON 模型轉換庫評測

YYKit系列之——YYModel使用

轉載請註明：特維博客 » 又一個高性能輕量級的iOS模型框架YYModel

http://cxy.liuzhihengseo.com/499.html

問啊APP，程序員答題神器，解決你全部的技術難題，   (上問啊APP 瞭解更多) http://t.cn/R4vE2d7 下載註冊送5元 快去下載註冊吧！ 

問啊-定製化IT教育平臺，牛人一對一服務，有問必答，開發編程社交頭條 官方網站：www.wenaaa.com 下載問啊APP，參與官方懸賞，賺百元現金。

QQ羣290551701 彙集不少互聯網精英，技術總監，架構師，項目經理！開源技術研究，歡迎業內人士，大牛及新手有志於從事IT行業人員進入！