又一个高性能轻量级的iOS模型框架YYModel

最新推荐文章于 2022-12-22 18:05:00 发布
最新推荐文章于 2022-12-22 18:05:00 发布
阅读量6k 收藏 4
点赞数 1
分类专栏： IOS9

前言

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

使用

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

2、JSON转Model

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

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

刘星石
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
JCDB:基于FMDB和SQLite的轻量级iOS数据库框架
05-19
基于和轻量级iOS数据库框架。 特征 该框架支持在ARC中开发iOS 7.0+。 数据库表CREATE / DROP / ALERT。 数据库使用SELECT记录查询。 数据库记录INSERT / REPLACE / UPDATE / DELETE。 创建并关闭数据库 [...
经典iOS第三方库源码分析 - YYModel
weixin_30430169的博客
04-24 168
YYModel介绍 YYModel是一个针对iOS/OSX平台的高性能的Model解析库，是属于YYKit的一个组件，创建是ibireme。 其实在YYModel出现之前，已经有非常多的Model解析库，例如JSONModel、Mantle和MJExtension。 YYModel从易用性和性能方面均达到了最高水平。 性能 Model解析库对比 特性 H...
iOS YYModel的使用
长沙火山
12-22 2456
YYModel支持多样化的数据类型，甚至字典，数组等数据，如果不存在，则该model会自动设置为null，该例子提出使用NSArray和NSDictionary作为数据，效果依然一样。@end不得不说YYModel还是考虑很全面的，不仅支持各种类型数据，甚至考虑到获取到数据的层次关系并没有那么完美，那么这个时候该怎么做呢。return @{@"sex":@"sexDic.sex" // 声明sex字段在sexDic下的sex};}@"name":@"张三",
iOS源码解析—YYModel（NSObject+YYModel）
panfeng200866的博客
03-06 1498
概述​ iOS源码解析—YYModel（YYClassInfo）分析了如何根据OC的Class对象构建YYClassInfo对象，为接下来的JSON数据和Model转换作准备，这篇文章开始讲解NSObject+YYModel。
从YYModel源码中可以学到什么：前篇
weixin_34253126的博客
12-29 176
前言 YYModel一个高性能模型框架。 作者在Github上给出的性能对比图(iphone 6 y：时间) YYModel：具体以下特点：高性能、自动类型转换、类型安全、非侵入性、轻量等。 关于如何使用YYModel查看文档和示例【传送门】。 本文主要任务，分析YYModel的整体架构，实现思路，涉及到的知识点。 版本：1.0.4 文件结构 YYModel，只有5个文件。接下我们会具体看这五...
YYModel 比较重要的几个方法modelCustomPropertyMapper，objectClassInArray，modelPropertyWhitelist和modelPropertyBl
liuyinghui523的专栏
11-14 7030
1.modelCustomPropertyMapper   解决json文件中关键字和定义的类的属性不一致的问题。   例如 在类型定义了属性 @property (nonatomic, assign) NSInteger errnoTest; 在json中对应的内容是 "error": "2"  使用方法 + (NSDictionary *) modelCustomPropert...
iOS关于model的两种写法
猿人在北京
01-12 8321
前言今天和大家说一说model的一些问题。model相信大家都不默生，因为对于OC来说（其他语言都应该是一样的），MVC这个模式应该都是最基本的。只要用刀MVC那么你就要用到model。在我刚刚开始OC的时候，是一种写法，当自己感觉对OC有一点点自己的理解了之后，model的写法又是另一种。今天把我自己前后对于model的两种写法写出来，让大家参考一下。 Demo链接正文第一种model写法一个m
YYModel的源码读后感
AlexAoMin的博客
04-26 3539
在项目的开发中，相信很多开发者都有json映射成Model的需求。在没有接触YYModel之前，我都是用自己写的转换类来映射。主要是通过runtime库，获取对象的属性列表，继而给需要的类的属性赋值。但是，这个类有几个缺点： 1.属性名称必须与被映射的字段名称相同 2.不能进行二级映射（如果Model里面包含另外一个Model，映射不了二级的） 于是，我开
YYModel的简介与使用
MikeJune的博客
12-21 7474
关于YYModel的性能，一张图带你看懂 特性: 高性能: 模型转换性能接近手写解析代码。 自动类型转换: 对象类型可以自动转换，详情见下方表格。 类型安全: 转换过程中，所有的数据类型都会被检测一遍，以保证类型安全，避免崩溃问题。 无侵入性: 模型无需继承自其他基类。 轻量: 该框架只有 5 个文件 (包括.h文件)。 文档和单元测试: 文档覆盖率100%, 代码覆
一个轻量级框架
04-05
作者OldChicken，源码LCCSqliteManager，这是一个轻量级框架，可以让使用的人脱离Sql语句进行数据库的管理。概述:一个封装了sqlite的轻量级框架。目前提供了建表（可以带主键和外键约束），查询表字段，获取表数据，...
YYModel的具体用法
09-06
此文件包含现在iOS领域最火热的模型转换工具类YYModel，有各种用法及注释。
ios-Model自动生成工具.zip
07-11
填写json文件自动生成Model 配合jsonSerialize组合使用 如有问题可留言告知 https://github.com/xiaouhu/BXHJsonSerialize.git https://github.com/xiaouhu/BXHModelTools.git
iOS换肤model
04-07
可以选择tabbar的皮肤 还有导航栏进行换肤
iOS的字典转模型（单Model）
10-28
以上主要完成了从plist文件读取，自定义view，九宫格算法，imageView的圆角显示和简单的动画效果
iOS一键Model变json或字典
04-10
通过封装的一个类，实现一步Model转json或者字典，详细信息参考我的博客地址：http://blog.csdn.net/baidu_21172753/article/details/44975835
茜：轻量级本地iOS MVVM框架
02-05
茜 Akane是一个iOS框架，可通过采用MVVM设计模式帮助您构建更好的本机应用程序。 如果想查看框架的实际用例，请转到我们的。 注意：当前版本（0.30）是beta。 如果您需要最新稳定版本（0.20.0）的文档，请。 主要...
基于C++11线程池技术简单易用的轻量级网络编程框架源码.zip
05-31
一个基于C++11的轻量级网络框架，基于线程池技术可以实现大并发网络IO 特点： 基于C++11开发，避免使用裸指针，代码稳定可靠；同时跨平台移植简单方便，代码清晰简洁。 使用epoll+线程池+异步网络IO模式开发，并发...
swift-NoChat一个轻量级的iOS聊天UI框架
08-15
NoChat 一个轻量级的iOS聊天UI框架
YYModel之黑白名单
MeteoriteMan的博客
08-18 1041
上一篇我们讲了一下如何将共有属性抽出为共有的模型. 这一篇我准备讲一讲YYModel黑白名单的设置. /// 大家应该都知道setvaluesforkeys可以自动转换. /// setvaluesforundefinekey不实现的话.出现没有的key就会崩溃. /// 黑名单类似于实现setvaluesforundifinekey空实现 /// 白名单就类似于手动设置需要转换的字段.不在字...
2. 轻量级推理框架
最新发布
08-30
C知道：轻量级推理框架是用于进行机器学习模型推理的工具。它们通常拥有较小的内存占用和计算资源需求，适合在资源受限的环境中部署和使用。以下是一些常见的轻量级推理框架： 1. TensorFlow Lite：由Google开发的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值