一直以为能够读懂源代码是件很牛的事情,但是每次都被动辄复杂的语法的架构吓跑,在偶然看到一个叫Draveness的大牛写的源代码分析博客,耐着性子看完了一篇SDWebImage
框架的分析,才发觉其实啃源代码没那么可怕,而且对于功力的提升十分显著,尤其偶尔接触到的底层的理解让我豁然开朗,遂打算独自写一篇第三方框架的源代码分析作为自己的第一篇技术博客.
MJExtension
A fast, convenient and nonintrusive conversion between JSON and model.
MJExtension
是一套字典和模型之间互相转换的超轻量级框架.
能做什么
- 字典(JSON)--> 模型(Model) CoreData模型(Core Data Model)
- JSON字符串(JSONString) --> 模型(Model)、CoreData模型(Core Data Model)
- 模型(Model)、CoreData模型(Core Data Model) --> 字典(JSON)
- JSON数组(JSON Array) --> 模型数组(Model Array)、CoreData模型数组(Core Data Model Array)
- JSON字符串(JSONString) --> 模型数组(Model Array)、CoreData模型数组(Core Data Model Array)
- 模型数组(Model Array)、CoreData模型数组(Core Data Model Array) --> 字典数组(JSON Array)
- 只需要一行代码,就能实现模型的所有属性进行Coding(归档和解档)
字典 -> 模型
MJExtension提供了一个类方法进行字典转模型的工作,我们通过对
+ (instancetype)mj_objectWithKeyValues:(id)keyValues
方法解析,来开始本篇分析.下面让我们打开这个方法的实现代码NSObject+MJKeyValue.m.
当然你也可以git clone github git@github.com:CoderMJLee/MJExtension.git
到本地来看.
+ (instancetype)mj_objectWithKeyValues:(id)keyValues
{
return [self mj_objectWithKeyValues:keyValues context:nil];
}
使用这个类方法的唯一作用就是调用了另一个方法
+ (instancetype)mj_objectWithKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
{
// 获得JSON对象
keyValues = [keyValues mj_JSONObject];
MJExtensionAssertError([keyValues isKindOfClass:[NSDictionary class]], nil, [self class], @"keyValues参数不是一个字典");
if ([self isSubclassOfClass:[NSManagedObject class]] && context) {
return [[NSEntityDescription insertNewObjectForEntityForName:NSStringFromClass(self) inManagedObjectContext:context] mj_setKeyValues:keyValues context:context];
}
return [[[self alloc] init] mj_setKeyValues:keyValues];
}
下面我们就仔细分析一下这个方法的实现过程.
两个参数
- (id)keyValues 用来接收传入的字典,将参数写为id类型是为了能够接收所有类型的参数
- (NSManagedObjectContext *)context (NSManagedObjectContext)是一个对于数据库的封装,只要能保存在数据库中的内容,都可以保存在NSManagedObjectContext中.
获取对象
方法的第一步是接收传入的对象
- (id)mj_JSONObject
{
if ([self isKindOfClass:[NSString class]]) {
return [NSJSONSerialization JSONObjectWithData:[((NSString *)self) dataUsingEncoding:NSUTF8StringEncoding] options:kNilOptions error:nil];
} else if ([self isKindOfClass:[NSData class]]) {
return [NSJSONSerialization JSONObjectWithData:(NSData *)self options:kNilOptions error:nil];
}
return self.mj_keyValues;
}
如果传入对象是NSString
类型或者NSData
类型,会使用系统自带的数据类型转换将对象转换成JSON
类型返回,否则返回自己.
构建错误
第二行代码使用了一个自定义的方法MJExtensionAssertError
#define MJExtensionAssertError(condition, returnValue, clazz, msg) \
[clazz setMj_error:nil]; \
if ((condition) == NO) { \
MJExtensionBuildError(clazz, msg); \
return returnValue;\
}
通过第一步的转换,传入的对象会是JSON
类型或其他类型的一种,如果传入的不是JSON
类型,MJExtensionBuildError
会调用runtime
中的objc_setAssociatedObject
方法为当前类关联一个NSError
对象,用来生成错误日志.
在庞大的项目中难免会遇到传值错误类型的低级错误,这个方法可以让用户在debug
的过程中准确找出错误位置并进行修改.
这里作者为clazz
这个参数的定义是[self class]
,即自身类别.
context参数处理
接下来会进行context
参数的处理
if ([self isSubclassOfClass:[NSManagedObject class]] && context) { return [[NSEntityDescription insertNewObjectForEntityForName:NSStringFromClass(self) inManagedObjectContext:context] mj_setKeyValues:keyValues context:context]; }
如果调用此方法的类别为NSManagedObject
的子类而且传入的context
不为空,则会实例一个NSEntityDescription
对象重新进行类型转换.
实例化对象
return [[[self alloc] init] mj_setKeyValues:keyValues];
最后实例化一个self
类型的对象进行类型转换操作.
以上行为我称之为是对参数的预处理,只有传入正确或者通过处理后能够进行类型转换的参数后才能够正确的进行类型转换方法.
类型转换
+ (instancetype)mj_objectWithKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
最后一步进入类型转换处理,在这里进行的是JSON
转Model
行为.
- (instancetype)mj_setKeyValues:(id)keyValues context:
(NSManagedObjectContext *)context```
由于这个方法的实现代码太长,在这里就不再贴出全部代码,后文会挑选关键代码进行分析.