**YYMode 只有 5 个文件就实现了字典转模型,这是相当的牛逼! **
YYModel.h
NSObject+YYModel.h
NSObject+YYModel.m
YYClassInfo.h
YYClassInfo.m
YYMode 中的类:
NSObject+YYModel : 主要定义一些字典转模型,模型转字典的方法
NSArray+YYModel : 字典数组转模型数组
NSDictionary+YYModel : 字典转模型字典
protocol YYModel : 白名单,黑名单,模型属性和字典不匹配的转换,容器属性的映射等。
_YYModelMeta : 模型元
_YYModelPropertyMeta:模型属性元
YYClassInfo : 存储类的一些信息
YYClassIvarInfo : 存储变量的一些信息
YYClassMethodInfo : 存储方法的一些信息
YYClassPropertyInfo : 存储属性的一些信息
YYMode 特性:
- 高性能: 转换性能接近手写代码。
- 自动类型转换:可以自动转换的对象类型。
- 类型安全:所有数据类型将验证以确保类型安全的转换过程。
- 非侵入性:没有必要使模型类从其他基类继承。
- 重量轻: 这个库仅包含5个文件。
- 文档和单元测试覆盖:文档覆盖率100%, 代码覆盖率99.6%。
github 地址: https://github.com/ibireme/YYModel
字典转模型框架实现的基本功能:
- 字典转模型
YYMode要实现的转换过程:
json 字符串 ——> data ——> dict ——> mode
最需要 YYMode 做的也就是 dict ——> mode 这一步。 - 模型转字典
mode ——> dict ——> data ——>json字符串
最需要 YYMode 做的也就是 mode ——> dict 这一步。
你可能需要问:json 字符串 ——> data ——> dict 和 dict ——> data ——>json 字符串 这几步的转换谁给我们做了。
答案: 是 apple 给我做了。
json 字符串 ——> data ——> dict
// 定义一个 json 字符串
NSString *jsonStr = @"{\"name\" : \"json\"}";
// 字符串转 data
NSData *data = [jsonStr dataUsingEncoding:NSUTF8StringEncoding];
// data 转 dict 或者 array
NSDictionary *dict = [NSJSONSerialization JSONObjectWithData:data options:0 error:nil];
// 打印结果
{
name = json;
}
dict ——> data ——>json
// 创建一个 dict
NSDictionary *dict = @{@"name" : @"json"};
// 将 dict 转换为 data
NSData *newData = [NSJSONSerialization dataWithJSONObject:dict options:0 error:nil];
// data 转字符串
NSString *newJsonStr = [[NSString alloc] initWithData:newData encoding:NSUTF8StringEncoding];
// 打印结果
{"name":"json"} // 不要和我说,我上例定义的字符串和打印的字符串不一样。
这几步就这么愉快的搞定了。(YYMode 具体怎么做的还要看源码)
看源码最快的方式是找主要功能方法追根溯源!
我们现在就根据 YYMode 的主要功能代码,查看字典转模型的实现原理。
作者给出的实例代码
// 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
// Convert json to model:
User *user = [User yy_modelWithJSON:json];
这个方法就是主要的字典转模型的方法:
+ (nullable instancetype)yy_modelWithJSON:(id)json;
方法的具体实现:
+ (instancetype)yy_modelWithJSON:(id)json {
// 解析 json 对象 为 字典对象
NSDictionary *dic = [self _yy_dictionaryWithJSON:json];
// 字典转模型操作
return [self yy_modelWithDictionary:dic];
}
解析 json 对象 为 字典对象
+ (NSDictionary *)_yy_dictionaryWithJSON:(id)json {
// 判断 json 对象是否为空,为空就直接返回
if (!json || json == (id)kCFNull) return nil;
NSDictionary *dic = nil;
NSData *jsonData = nil;
// 传入的 json 为 dict 就 直接记录
if ([json isKindOfClass:[NSDictionary class]]) {
dic = json;
// 传入的 json 为 string 就 转为 data
} else if ([json isKindOfClass:[NSString class]]) {
jsonData = [(NSString *)json dataUsingEncoding : NSUTF8StringEncoding];
// 传入的 json 为 data 就 直接记录
} else if ([json isKindOfClass:[NSData class]]) {
jsonData = json;
}
// 这里是进行 data 转字典的操作
if (jsonData) {
dic = [NSJSONSerialization JSONObjectWithData:jsonData options:kNilOptions error:NULL];
if (![dic isKindOfClass:[NSDictionary class]]) dic = nil;
}
return dic;
}
处理的整体过程和我的 json 字符串 ——> data ——> dict 一致。
** 字典转模型 **
+ (instancetype)yy_modelWithDictionary:(NSDictionary *)dictionary {
// 判断传入的字典是否是空 ,为空直接返回
if (!dictionary || dictionary == (id)kCFNull) return nil;
// 传入的数据不是字典数据直接返回
if (![dictionary isKindOfClass:[NSDictionary class]]) return nil;
// 主要是对类的信息进行一些缓存处理
/*
1. 类的白名单
2. 类的黑名单
3. 容器属性类的处理
4. 类的属性列表
5. 类的变量列表
6. 类的方法列表
等等!
*/
Class cls = [self class];
_YYModelMeta *modelMeta = [_YYModelMeta metaWithClass:cls];
if (modelMeta->_hasCustomClassFromDictionary) {
cls = [cls modelCustomClassForDictionary:dictionary] ?: cls;
}
// 通过自己的 “类” 创建一个模型对象
NSObject *one = [cls new];
// 进行字典转模型操作 (转换成功直接返回,转换失败返回 nil )
// 由于对类的信息已经进行了处理,这里其实就是简单的赋值操作
if ([one yy_modelSetWithDictionary:dictionary]) return one;
return nil;
}
- (BOOL)yy_modelSetWithDictionary:(NSDictionary *)dic {
// 传入的字典为 nil 直接字典转模型失败
if (!dic || dic == (id)kCFNull) return NO;
// dict 不是字典直接转换失败
if (![dic isKindOfClass:[NSDictionary class]]) return NO;
// 获取 元类 模型缓存
_YYModelMeta *modelMeta = [_YYModelMeta metaWithClass:object_getClass(self)];
// 元类 模型的 映射 key 和 keyPath 的个数是 0 , 直接转换失败
if (modelMeta->_keyMappedCount == 0) return NO;
// 自定义转换
if (modelMeta->_hasCustomWillTransformFromDictionary) {
dic = [((id)self) modelCustomWillTransformFromDictionary:dic];
if (![dic isKindOfClass:[NSDictionary class]]) return NO;
}
// 模型设置上下文 (暂时没明白是干嘛的)
ModelSetContext context = {0};
// 元模型
context.modelMeta = (__bridge void *)(modelMeta);
// 模型
context.model = (__bridge void *)(self);
// 字典
context.dictionary = (__bridge void *)(dic);
// 模型中的 key value 的映射基本是在这完成的
// 模型的 映射 key 和 keyPath 大于等于 字典中元素的个数
if (modelMeta->_keyMappedCount >= CFDictionaryGetCount((CFDictionaryRef)dic)) {
//
CFDictionaryApplyFunction((CFDictionaryRef)dic, ModelSetWithDictionaryFunction, &context);
// 路径属性
if (modelMeta->_keyPathPropertyMetas) {
CFArrayApplyFunction((CFArrayRef)modelMeta->_keyPathPropertyMetas,
CFRangeMake(0, CFArrayGetCount((CFArrayRef)modelMeta->_keyPathPropertyMetas)),
ModelSetWithPropertyMetaArrayFunction,
&context);
}
// 多路径属性
if (modelMeta->_multiKeysPropertyMetas) {
CFArrayApplyFunction((CFArrayRef)modelMeta->_multiKeysPropertyMetas,
CFRangeMake(0, CFArrayGetCount((CFArrayRef)modelMeta->_multiKeysPropertyMetas)),
ModelSetWithPropertyMetaArrayFunction,
&context);
}
} else {
CFArrayApplyFunction((CFArrayRef)modelMeta->_allPropertyMetas,
CFRangeMake(0, modelMeta->_keyMappedCount),
ModelSetWithPropertyMetaArrayFunction,
&context);
}
if (modelMeta->_hasCustomTransformFromDictionary) {
return [((id)self) modelCustomTransformFromDictionary:dic];
}
return YES;
}