JSONModel源码解析

本文涉及的产品
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
全局流量管理 GTM,标准版 1个月
云解析 DNS,旗舰版 1个月
简介: JSONModel源码解析

一、引言


   做移动端开发,解析网络数据是必不可少的工作之一。iOS原生框架很早前就已经提供了将JSON数据直接映射成数组或者字典对象的方法,并且结合KVC,也可以将字典数据直接赋值给对象。但是这种方式十分不灵活,例如如果网络数据中的字段与我们数据模型中的字段不一致,某些网络数据的字段可能为nil等等都需要开发者单独的处理。使用JSOMModel可以十分方便的处理映射过程中的各种情况。


二、JSOMModel类概览


   平时在使用JSOMModel框架时,往往只会用到JSOMModel这一个类,其实JSOMModel中还封装了一套网络请求逻辑,你可以直接对某个对象调用请求来映射成为数据模型。但是我建议尽量将数据的请求和解析分开来做,这样更利于请求的维护(在新的JSOMModel版本中,也将有关网络请求的部分标记为了弃用)。JSOMModel功能十分强大,代码量却并不特别多,结构逻辑也较为清晰。其中类的关系和结构如下图表示。

image.png



如上图所示,其中网络相关模块已经弃用,并且也不是JSONModel的核心模块,不在本次博客的探讨范围之内。JSONModelError定义了许多错误类型,主要用来当请求或数据解析异常时进行抛出,需要注意,JSONModel定义的自己的log函数,其只会在模拟器运行时进行打印。


三、JSONModelClassProperty类的意义


   将网络数据映射为Model模型的实质即是对Model对象中属性的赋值,在JSONModel中,类的属性被抽象为JSONModelClassProperty对象,这个对象中封装这此属性的相关信息(通过runtime来动态生成)。JSONModelClassProerty类中的属性意义如下:


@interface JSONModelClassProperty : NSObject

//已经弃用  这个用来标识当前属性是否是对象的主键 用来进行数据模型的比较

@property (assign, nonatomic) BOOL isIndex DEPRECATED_ATTRIBUTE;

//属性名

@property (copy, nonatomic) NSString *name;

//属性类型

@property (assign, nonatomic) Class type;

//属性结构体名称 基本数据类型的属性 会被抽象成结构体

@property (strong, nonatomic) NSString *structName;

//属性遵守的协议名

@property (copy, nonatomic) NSString *protocol;

//当前属性是否是可选属性 如果是 在解析时允许这个属性值为nil

@property (assign, nonatomic) BOOL isOptional;

//是否是标准的json数据,如果是则不用再调用数据转换的方法

@property (assign, nonatomic) BOOL isStandardJSONType;

//当前属性是否是可变的 如果是 则会创建可变对象

@property (assign, nonatomic) BOOL isMutable;

//自定义的 属性get函数

@property (assign, nonatomic) SEL customGetter;

//自定义的属性 set函数

@property (strong, nonatomic) NSMutableDictionary *customSetters;

@end

四、关于属性映射器JSONKeyMapper


   简单理解,JSONKeyMapper属性映射器的作用就是用来制定在数据解析时所遵循的规则。最理想的情况是JSON数据与我们要解析成的数据模型完全对应,例如:


JSON数据:


{ "firstName":"Bill" , "lastName":"Gates" }

数据Model:


@interface MyOnject : NSObject


@property(nonatomic,strong)NSString * firstName;


@property(nonatomic,strong)NSString * lastName;


@end

然而在实际的开发中,这种完美的情况却很少出现,我们更多遇到的是,JSON数据中某些字段可能有也可能无,数据Model中需要增加些本地字段,JSON数据和Model的某些字段名称可能不一致。更加复杂一点,我们可以Model的某个属性是另一个Model。或者某个属性是数组,数组中存放的是另一种Model。


   JSONKeyMapper接口定义如下:


//通过字典来创建映射器  字典的键为数据Model的属性名  值为JSOM数据的属性名

- (instancetype)initWithModelToJSONDictionary:(NSDictionary *)toJSON;


//通过block来建立映射关系 block的定义如下,其中会将JSOM数据的属性名传入 需要返回要对应Model的属性名

/*

typedef NSString *(^JSONModelKeyMapBlock)(NSString *keyName);

*/

- (instancetype)initWithModelToJSONBlock:(JSONModelKeyMapBlock)toJSON;

//创建一个 将以下划线分割的命名键 转换成驼峰命名 例如 first_name => firstName

+ (instancetype)mapperForSnakeCase;

//创建一个 将首字母大写的明明键 转换成驼峰  例如 FirstName => firstName

+ (instancetype)mapperForTitleCase;

五、核心数据模型类JSONModel


   JSONModel框架中最核心的类JSONModel类,其中代码大约有1400行,除了一些调试,复写和提供方便功能的代码外,核心代码在800行左右。首先,其头文件中声明了几个协议,如下:


@protocol Index

@end

@protocol Ignore

@end

@protocol Optional

@end

需要注意,这些协议里面都没有约定任何方法,它们也不会用来实现的,其作为属性的一种标记,例如将属性添加Ignore协议,则JSONModel不会对这个属性进行解析,使用这种方式来进行本地数据的管理,例如:


@interface MyOnject : JSONModel


@property(nonatomic,strong)NSString * firstName;


@property(nonatomic,strong)NSString * lastName;

//这个属性是本地拼接 使用

@property(nonatomic,strong)NSString<Ignore> * fullName;


@end

Optional协议表示这个属性是可选的,即JSON数据中如果有这个属性就解析,如果没有就跳过。Index协议标记这个属性是当前对象的主键,已经弃用。


   有了这3个协议,在声明属性时,我们可以十分容易的设定他们的解析规则,在JSONModel中,协议除了可以用来规定解析规则外,还可以用来指定自定义数据类型的解析,只是我们需要自己定义一个协议,名称与自定义类名一致,示例如下:


#import "JSONModel.h"


@protocol Address

@end


@interface Address:JSONModel


@property(nonatomic,strong)NSString * info;


@end


@interface MyObject : JSONModel


@property(nonatomic,strong)NSString<Optional> * firstName;


@property(nonatomic,strong)NSString * lastName;


@property(nonatomic,strong)NSArray<Address> * address;


@end

如上代码所以,在解析数据时,会直接将address数组中赋值为Address的对象,当前也可以直接解析对象,例如:


@protocol Address

@end


@interface Address:JSONModel


@property(nonatomic,strong)NSString * info;


@end




@interface MyObject : JSONModel


@property(nonatomic,strong)NSString<Optional> * firstName;


@property(nonatomic,strong)NSString * lastName;


@property(nonatomic,strong)Address<Address> * address;


@end

需要注意,在Objective-C中,只有NSObject的子类可以遵守协议,原始数据类型是不能遵守协议的,那么对于类似BOOL,int这样的属性有没有办法设置他们的忽略解析或者可选解析呢,当然也可以,我们可以通过重写JSONModel中的一些函数来实现,这种方法更加通用,JSONModel类接口意义如下:


//将JSON字符串解析成数据模型对象

- (instancetype)initWithString:(NSString *)string error:(JSONModelError **)err;

- (instancetype)initWithString:(NSString *)string usingEncoding:(NSStringEncoding)encoding error:(JSONModelError **)err;

//将数据模型对象转换成JSON字符串

- (NSString *)toJSONString;

//将数据模型对象转换成JSON数据

- (NSData *)toJSONData;

//将数据模型对象中的某些键组合成JSON字符串

- (NSString *)toJSONStringWithKeys:(NSArray *)propertyNames;

//将数据模型对象中的某些键组合成JSON数据

- (NSData *)toJSONDataWithKeys:(NSArray *)propertyNames;


//重写这个函数 来设置解析时使用的属性映射器

+ (JSONKeyMapper *)keyMapper;

//重写这个函数 来设置某个属性是否是可选的

+ (BOOL)propertyIsOptional:(NSString *)propertyName;

//重写这个函数 来设置某个属性是否是忽略的

+ (BOOL)propertyIsIgnored:(NSString *)propertyName;

//重写这个函数 来设置 如果某个属性集合中是一个自定义对象或本身是自定义对象 设置此对象的类

+ (Class)classForCollectionProperty:(NSString *)propertyName;

JSONModel的源码这里就不在列举,其首先在类load函数中进行静态数据的加载,所支持的原生类型和基础数据类型的定义等。在对象的初始化方法中,首先使用runtime获取所有的属性和属性的修饰内容,所谓修饰内容,即是指属性名称,类型,所遵守的协议,以及是否忽略,是否可选,是否是主键等内容(过程中会使用到属性映射器keyMapper进行转化),将其抽象成JSONModelClassProperty对象。后面在解析时,会根据JSONModelClassProperty中的自定义setter和其他信息进行赋值。

目录
相关文章
|
2月前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
87 2
|
11天前
|
存储 设计模式 算法
【23种设计模式·全精解析 | 行为型模式篇】11种行为型模式的结构概述、案例实现、优缺点、扩展对比、使用场景、源码解析
行为型模式用于描述程序在运行时复杂的流程控制,即描述多个类或对象之间怎样相互协作共同完成单个对象都无法单独完成的任务,它涉及算法与对象间职责的分配。行为型模式分为类行为模式和对象行为模式,前者采用继承机制来在类间分派行为,后者采用组合或聚合在对象间分配行为。由于组合关系或聚合关系比继承关系耦合度低,满足“合成复用原则”,所以对象行为模式比类行为模式具有更大的灵活性。 行为型模式分为: • 模板方法模式 • 策略模式 • 命令模式 • 职责链模式 • 状态模式 • 观察者模式 • 中介者模式 • 迭代器模式 • 访问者模式 • 备忘录模式 • 解释器模式
【23种设计模式·全精解析 | 行为型模式篇】11种行为型模式的结构概述、案例实现、优缺点、扩展对比、使用场景、源码解析
|
11天前
|
设计模式 存储 安全
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
结构型模式描述如何将类或对象按某种布局组成更大的结构。它分为类结构型模式和对象结构型模式,前者采用继承机制来组织接口和类,后者釆用组合或聚合来组合对象。由于组合关系或聚合关系比继承关系耦合度低,满足“合成复用原则”,所以对象结构型模式比类结构型模式具有更大的灵活性。 结构型模式分为以下 7 种: • 代理模式 • 适配器模式 • 装饰者模式 • 桥接模式 • 外观模式 • 组合模式 • 享元模式
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
|
11天前
|
设计模式 存储 安全
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
创建型模式的主要关注点是“怎样创建对象?”,它的主要特点是"将对象的创建与使用分离”。这样可以降低系统的耦合度,使用者不需要关注对象的创建细节。创建型模式分为5种:单例模式、工厂方法模式抽象工厂式、原型模式、建造者模式。
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
|
2月前
|
缓存 监控 Java
Java线程池提交任务流程底层源码与源码解析
【11月更文挑战第30天】嘿,各位技术爱好者们,今天咱们来聊聊Java线程池提交任务的底层源码与源码解析。作为一个资深的Java开发者,我相信你一定对线程池并不陌生。线程池作为并发编程中的一大利器,其重要性不言而喻。今天,我将以对话的方式,带你一步步深入线程池的奥秘,从概述到功能点,再到背景和业务点,最后到底层原理和示例,让你对线程池有一个全新的认识。
57 12
|
1月前
|
PyTorch Shell API
Ascend Extension for PyTorch的源码解析
本文介绍了Ascend对PyTorch代码的适配过程,包括源码下载、编译步骤及常见问题,详细解析了torch-npu编译后的文件结构和三种实现昇腾NPU算子调用的方式:通过torch的register方式、定义算子方式和API重定向映射方式。这对于开发者理解和使用Ascend平台上的PyTorch具有重要指导意义。
|
12天前
|
安全 搜索推荐 数据挖掘
陪玩系统源码开发流程解析,成品陪玩系统源码的优点
我们自主开发的多客陪玩系统源码,整合了市面上主流陪玩APP功能,支持二次开发。该系统适用于线上游戏陪玩、语音视频聊天、心理咨询等场景,提供用户注册管理、陪玩者资料库、预约匹配、实时通讯、支付结算、安全隐私保护、客户服务及数据分析等功能,打造综合性社交平台。随着互联网技术发展,陪玩系统正成为游戏爱好者的新宠,改变游戏体验并带来新的商业模式。
|
2月前
|
存储 安全 Linux
Golang的GMP调度模型与源码解析
【11月更文挑战第11天】GMP 调度模型是 Go 语言运行时系统的核心部分,用于高效管理和调度大量协程(goroutine)。它通过少量的操作系统线程(M)和逻辑处理器(P)来调度大量的轻量级协程(G),从而实现高性能的并发处理。GMP 模型通过本地队列和全局队列来减少锁竞争,提高调度效率。在 Go 源码中,`runtime.h` 文件定义了关键数据结构,`schedule()` 和 `findrunnable()` 函数实现了核心调度逻辑。通过深入研究 GMP 模型,可以更好地理解 Go 语言的并发机制。
|
2月前
|
消息中间件 缓存 安全
Future与FutureTask源码解析,接口阻塞问题及解决方案
【11月更文挑战第5天】在Java开发中,多线程编程是提高系统并发性能和资源利用率的重要手段。然而,多线程编程也带来了诸如线程安全、死锁、接口阻塞等一系列复杂问题。本文将深度剖析多线程优化技巧、Future与FutureTask的源码、接口阻塞问题及解决方案,并通过具体业务场景和Java代码示例进行实战演示。
61 3
|
3月前
|
存储
让星星⭐月亮告诉你,HashMap的put方法源码解析及其中两种会触发扩容的场景(足够详尽,有问题欢迎指正~)
`HashMap`的`put`方法通过调用`putVal`实现,主要涉及两个场景下的扩容操作:1. 初始化时,链表数组的初始容量设为16,阈值设为12;2. 当存储的元素个数超过阈值时,链表数组的容量和阈值均翻倍。`putVal`方法处理键值对的插入,包括链表和红黑树的转换,确保高效的数据存取。
68 5

推荐镜像

更多