High performance model framework for iOS/OSX.
High performance model framework for iOS/OSX.
(It's a component of YYKit)
Time cost (process GithubUser 10000 times on iPhone 6):
See
Benchmark/ModelBenchmark.xcodeprojfor more benchmark case.
// 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
// Convert json to model: User *user = [User yy_modelWithJSON:json];
// Convert model to json: NSDictionary *json = [user yy_modelToJSONObject];
If the type of an object in JSON/Dictionary cannot be matched to the property of the model, the following automatic conversion is performed. If the automatic conversion failed, the value will be ignored.
JSON/Dictionary | Model |
---|---|
NSString | NSNumber,NSURL,SEL,Class |
NSNumber | NSString |
NSString/NSNumber | C number (BOOL,int,float,NSUInteger,UInt64,...) NaN and Inf will be ignored |
NSString | NSDate parsed with these formats: 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 formatted with ISO8601: "YYYY-MM-dd'T'HH:mm:ssZ" |
NSValue | struct (CGRect,CGSize,...) |
NSNull | nil,0 |
"no","false",... | @(NO),0 |
"yes","true",... | @(YES),1 |
// 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
@"page" : @"p",
@"desc" : @"ext.desc",
@"bookID" : @[@"id",@"ID",@"book_id"]};
}
@end
You can map a json key (key path) or an array of json key (key path) to one or multiple property name. If there's no mapper for a property, it will use the property's name as default.
// JSON { "author":{ "name":"J.K.Rowling", "birthday":"1965-07-31T00:00:00+0000" }, "name":"Harry Potter", "pages":256 }// Model: (no need to do anything) @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; @end @implementation Book @end
@class Shadow, Border, Attachment;@interface Attributes @property NSString *name; @property NSArray *shadows; //Array @property NSSet *borders; //Set @property NSMutableDictionary *attachments; //Dict @end
@implementation Attributes
@"borders" : Border.class,
@"attachments" : @"Attachment" };
}
@end
@interface User @property NSString *name; @property NSUInteger age; @end@implementation Attributes
// JSON: { "name":"Harry", "timestamp" : 1445534567 }// Model: @interface User @property NSString *name; @property NSDate *createdAt; @end
@implementation User
@interface YYShadow :NSObject @property (nonatomic, copy) NSString *name; @property (nonatomic, assign) CGSize size; @end@implementation YYShadow
pod 'YYModel'to your Podfile.
pod installor
pod update.
github "ibireme/YYModel"to your Cartfile.
carthage update --platform iosand add the framework to your project.
YYModel.h.
Full API documentation is available on CocoaDocs.
You can also install documentation locally using appledoc.
This library requires
iOS 6.0+and
Xcode 8.0+.
YYModel is provided under the MIT license. See LICENSE file for details.
高性能 iOS/OSX 模型转换框架。
(该项目是 YYKit 组件之一)
处理 GithubUser 数据 10000 次耗时统计 (iPhone 6):
更多测试代码和用例见
Benchmark/ModelBenchmark.xcodeproj。
// 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 以下列格式解析: 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 |
// 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。
@"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,则转换过过程会使用其中任意一个不为空的值。
// 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 @property NSSet *borders; //Set @property NSMutableDictionary *attachments; //Dict @end
@implementation Attributes // 返回容器类中的所需要存放的数据类型 (以 Class 或 Class Name 的形式)。
@"borders" : Border.class,
@"attachments" : @"Attachment" };
}
@end
@interface User @property NSString *name; @property NSUInteger age; @end@implementation Attributes // 如果实现了该方法,则处理过程中会忽略该列表内的所有属性
// JSON: { "name":"Harry", "timestamp" : 1445534567 }// Model: @interface User @property NSString *name; @property NSDate *createdAt; @end
@implementation User // 当 JSON 转为 Model 完成后,该方法会被调用。 // 你可以在这里对数据进行校验,如果校验不通过,可以返回 NO,则该 Model 会被忽略。 // 你也可以在这里做一些自动转换不能完成的工作。
// 当 Model 转为 JSON 完成后,该方法会被调用。 // 你可以在这里对数据进行校验,如果校验不通过,可以返回 NO,则该 Model 会被忽略。 // 你也可以在这里做一些自动转换不能完成的工作。
@interface YYShadow :NSObject @property (nonatomic, copy) NSString *name; @property (nonatomic, assign) CGSize size; @end@implementation YYShadow // 直接添加以下代码即可自动完成
pod 'YYModel'。
pod install或
pod update。
github "ibireme/YYModel"。
carthage update --platform ios并将生成的 framework 添加到你的工程。
YYModel.h。
你可以在 CocoaDocs 查看在线 API 文档,也可以用 appledoc 本地生成文档。
该项目最低支持
iOS 6.0和
Xcode 8.0。
YYModel 使用 MIT 许可证,详情见 LICENSE 文件。