前言

iOS的模型框架其实有不少了，去年研究过Mantle，也了解过JSONModel、MJExtension，最近的项目项目优化的时候，再次考虑，基于轻量级、高性能的考虑，最终选择了YYModel。html

项目主页

YYModelios

简介

YYModel在Github的简介是， iOS/OSX平台下一个高性能的模型框架。下面这张图片展现了原做者的性能比较：git

特点功能

• 高性能：转换效率接近手写代码。程序员

• 自动类型转换：对象类型能自动转换。github

• 类型安全：在转换过程当中全部的类型都会被验证，以确保类型安全。编程

• 非侵入性：不须要让模型类继承自基类。json

• 轻量级：整个库只包含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 将会进行以下自动转换。自动转换不支持的值将会被忽略，以免各类潜在的崩溃问题。app

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行业人员进入！