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

2024-02-02 00:18

本文主要是介绍又一个高性能轻量级的iOS模型框架YYModel,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

iOS的模型框架其实有很多了,去年研究过Mantle,也了解过JSONModelMJExtension,最近的项目项目优化的时候,再次考虑,基于轻量级、高性能的考虑,最终选择了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行业人员进入!

这篇关于又一个高性能轻量级的iOS模型框架YYModel的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/668909

相关文章

LiteFlow轻量级工作流引擎使用示例详解

《LiteFlow轻量级工作流引擎使用示例详解》:本文主要介绍LiteFlow是一个灵活、简洁且轻量的工作流引擎,适合用于中小型项目和微服务架构中的流程编排,本文给大家介绍LiteFlow轻量级工... 目录1. LiteFlow 主要特点2. 工作流定义方式3. LiteFlow 流程示例4. LiteF

SpringBoot集成LiteFlow实现轻量级工作流引擎的详细过程

《SpringBoot集成LiteFlow实现轻量级工作流引擎的详细过程》LiteFlow是一款专注于逻辑驱动流程编排的轻量级框架,它以组件化方式快速构建和执行业务流程,有效解耦复杂业务逻辑,下面给大... 目录一、基础概念1.1 组件(Component)1.2 规则(Rule)1.3 上下文(Conte

详解如何使用Python从零开始构建文本统计模型

《详解如何使用Python从零开始构建文本统计模型》在自然语言处理领域,词汇表构建是文本预处理的关键环节,本文通过Python代码实践,演示如何从原始文本中提取多尺度特征,并通过动态调整机制构建更精确... 目录一、项目背景与核心思想二、核心代码解析1. 数据加载与预处理2. 多尺度字符统计3. 统计结果可

SpringBoot整合Sa-Token实现RBAC权限模型的过程解析

《SpringBoot整合Sa-Token实现RBAC权限模型的过程解析》:本文主要介绍SpringBoot整合Sa-Token实现RBAC权限模型的过程解析,本文给大家介绍的非常详细,对大家的学... 目录前言一、基础概念1.1 RBAC模型核心概念1.2 Sa-Token核心功能1.3 环境准备二、表结

C++ HTTP框架推荐(特点及优势)

《C++HTTP框架推荐(特点及优势)》:本文主要介绍C++HTTP框架推荐的相关资料,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1. Crow2. Drogon3. Pistache4. cpp-httplib5. Beast (Boos

SpringBoot基础框架详解

《SpringBoot基础框架详解》SpringBoot开发目的是为了简化Spring应用的创建、运行、调试和部署等,使用SpringBoot可以不用或者只需要很少的Spring配置就可以让企业项目快... 目录SpringBoot基础 – 框架介绍1.SpringBoot介绍1.1 概述1.2 核心功能2

Nginx使用Keepalived部署web集群(高可用高性能负载均衡)实战案例

《Nginx使用Keepalived部署web集群(高可用高性能负载均衡)实战案例》本文介绍Nginx+Keepalived实现Web集群高可用负载均衡的部署与测试,涵盖架构设计、环境配置、健康检查、... 目录前言一、架构设计二、环境准备三、案例部署配置 前端 Keepalived配置 前端 Nginx

C#实现高性能Excel百万数据导出优化实战指南

《C#实现高性能Excel百万数据导出优化实战指南》在日常工作中,Excel数据导出是一个常见的需求,然而,当数据量较大时,性能和内存问题往往会成为限制导出效率的瓶颈,下面我们看看C#如何结合EPPl... 目录一、技术方案核心对比二、各方案选型建议三、性能对比数据四、核心代码实现1. MiniExcel

Android与iOS设备MAC地址生成原理及Java实现详解

《Android与iOS设备MAC地址生成原理及Java实现详解》在无线网络通信中,MAC(MediaAccessControl)地址是设备的唯一网络标识符,本文主要介绍了Android与iOS设备M... 目录引言1. MAC地址基础1.1 MAC地址的组成1.2 MAC地址的分类2. android与I

Spring框架中@Lazy延迟加载原理和使用详解

《Spring框架中@Lazy延迟加载原理和使用详解》:本文主要介绍Spring框架中@Lazy延迟加载原理和使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录一、@Lazy延迟加载原理1.延迟加载原理1.1 @Lazy三种配置方法1.2 @Component