MJExtension概述
MJExtension是是一个非常易用且功能强大的第三方Model和JSON相互转化的商业化第三方库,帮助开发者节省了从JSON或者Foundation object转换成Model所需的时间,而且强大的拓展功能,满足了开发者的大部分数据模型化的需求。
用MJ自己的话来说,第三方库MJExtension就是
A fast, convenient and nonintrusive conversion between JSON and model. Your model class don't need to extend another base class. You don't need to modify any model file.
MJExtension项目源代码请查看github上的Demo
下面,Fabric就来为大家揭开MJExtension的神秘面纱。
你需要了解的知识:
这篇文章适合于iOS中级开发者,在开启阅读之前,你需要了解以下知识点:
- Objective-C runtime运行时机制,有兴趣的请参阅runtime iOS官方文档介绍
- objc_property_t结构体的相关知识点,尤其是Declared property type encodings的相关知识点,具体请见Declared Properties iOS官方文档介绍
- 类的分类进行动态添加属性的原理。
- block和delegate的基本使用方法。
- SEL指针的基本使用方法。
- C语言结构体中变量的存储结构,寻址方法。
However,无论你了不了解这些知识点,相信读完整篇文章都会帮助你更加深入地了解Object-C这门语言,领略它独特的魅力。
为了方便叙述,我把一些基本的Foundation的数据结构,例如NSDictionary, NSArray, NSSet等统一称之为Foundation object。
基本原理
基本原理非常简单,Fabric在这里简略介绍一下
第一步:获取NSObject中的所有属性
unsigned int propertyCount = 0;
///通过运行时获取当前类的属性
objc_property_t *propertys = class_copyPropertyList([self class], &propertyCount);
//把属性放到数组中
for (int i = 0; i < propertyCount; i ++) {
///取出第一个属性
objc_property_t property = propertys[i];
//得到属性对应的名称
NSString *name = @(property_getName(property));
NSLog(@"name:%@", name);
}
复制代码
ps:虽然没有看到runtime的完整源码,但是有些方法的内部构造我们还是可以猜测出来的,例如:
const char * _Nonnull property_getName(objc_property_t _Nonnull property) {
return property->name;
}
复制代码
这就是一个对于获取结构体对应指针值的一个很简单的包装。
第二步:在Foundation object(数组、字典等)以name 为key,寻找到对应的value值,然后将对应值填充入相应的Model当中
- (void)setValue:(id)value forObject:(id)object
{
if (self.type.KVCDisabled || value == nil) return;
[object setValue:value forKey:self.name];
}
复制代码
ps:这里需要着重介绍一下,NSObject可以通过-[setValue:forKey:]的方式对相应的属性进行赋值,了解这点对于了解MJExtension原理很有必要。
MJExtension的优势
看了Fabric刚才的基本原理介绍,大家可能认为JSON转化为model非常简单嘛,核心代码也就几句。但是,MJExtension作为商业化SDK,它的强大优势在于它的兼容性好,拓展性强。开发者可以替换key值的名称,可以将数组里面的字典转化为对应的model,可以忽略某些转换的属性,也可以定义所有需要转换的属性,还可以针对于一些旧值,转换为新值,例如时间戳和时间的相互转换。
MJExtension详细原理
MJExtension内部结构
Fabric画了一张原理图,大致地将MJExtension的内部结构和类与类之间的相互关系描述了出来。
- MJExtensionConst类: 类中定义了一些字符串常量,分别表示property的属性类型,具体的类型字符串是存放在MJProperty的属性MJPropertyType中的code属性下的。不同类型的属性由不同的encode字符串表示,读者可以自己
@encode(int)
@encode(float)
@encode(NSString)
打印出一些常用类型属性的encode值来加深理解。 - MJPropertyType类: 用于记录MJProperty的一些相关的特性,例如要转换的对象的类型,是否是Foundation object类型对象等等,主要包括:
+ (instancetype)cachedTypeWithCode:(NSString *)code
用于查找缓存的type类型。
BOOL idType
BOOL numberType
BOOL boolType
等一堆代表要转换value对象具体类型的属性。
Class typeClass
表明value对象的类型。
NSString *code
,用来写入Property的encode值。
BOOL fromFoundation
,用来表示要转换的 对象是否是NSDictionary``NSArray``NSSet
等基本的Foundation object类型,简单来说就是如果要转换的对象是NSObject的子类且不是NSManagedObject类就返回NO。
KVCDisabled
该对象是否能被监听
- MJPropertyKey类: 负责将value写入MJProperty,主要包括:
- (id)valueInObject:(id)object
用于将value值写入MJProperty对象。MJPropertyKeyType type
用于表明当前的MJProperty中需要转换的value是一个字典里面的value还是在数组里面的value。NSString *name
用于表示当前的NSDictionary中value的key值或者NSArray中value的index。 - MJFoundation类: 判断当前对象是不是Foundation object(NSDictionary, NSArray等)
- MJProperty类: MJExtension包装属性值的基本单位,每一个objc_property_t值都有一个MJProperty来进行包装,这个类是整个MJExtension代码中最核心的一个类,对于该类的作用,Fabric会在下文为大家介绍。
- NSObject+MJProperty类: 为开发者预留了一些可以重写的方法和block,开发者可以用这些方法可以将字典中的key替换为Model中对应的Property,可以指定NSArray中的字典对应的Model。
- NSObject+MJClass类: 设置JSON和Model互转的黑白名单,设置归档的黑白名单。
- NSObject+MJKeyValue类: JSON和Model互转的实现类。
- NSString+MJExtension类: 一些字符串特殊处理的方法,包括大小写互相转换,驼峰命名法和下划线命名法字符串的相互转换等。
- NSObject+MJCoding类: 重写了
-[encodeObject:forKey:]
和-[decoderObject:forkey:]
两个方法,使得对象可以直接进行归档操作。
MJExtension核心代码分析
MJExtension的设计非常巧妙,涉及的方法也非常多,有限的篇幅里面很难说的细致入微,所以Fabric决定带大家一起探索一下MJExtension实现Model转换的核心的方法: - (instancetype)mj_setKeyValues:(id)keyValues context:(NSManagedObjectContext *)context
。我们按照方法里面的代码,由上之下,从内而外执行下去:
//将JSON转换为Foundation object对象(NSDictionary, NSArray等)
keyValues = [keyValues mj_JSONObject];
复制代码
//设置黑名单和白名单
NSArray *allowedPropertyNames = [clazzmj_totalAllowedPropertyNames];
NSArray *ignoredPropertyNames = [clazz mj_totalIgnoredPropertyNames];
复制代码
//声称了所有的MJProperty属性并进行遍历输出
[clazz mj_enumerateProperties:^(MJProperty *property, BOOL *stop) {
//遍历所有的MJProperty对象,设置到Model的对应的属性当中
}
复制代码
现在我们探究一下,每一个MJProperty对象是怎么生成的,结合我上面的MJExtension内部结构图,大家可能理解起来比较容易。 在NSObject+MJProperty
类中,+ (NSMutableArray *)properties
这个方法是专门负责生成所有的MJProperty对象的。
//首先从缓存中读取存储的MJProperty数组
NSMutableArray *cachedProperties = [self dictForKey:&MJCachedPropertiesKey][NSStringFromClass(self)];
复制代码
在这里需要注意两点:
1、掌握缓存的技巧可以提高项目性能,减少代码重复执行。
2、Fabric认为这里并不需要用字典来存储MJproperty对象数组,因为每一个Model都对应一个class,所以不存在两个class公用一个cachedProperty的情况,因此直接用数组来承接MJProperty属性数组就可以了。
继续探究+ (NSMutableArray *)properties
方法, 如果没有缓存,就遍历所有的非Foundation object基本类型的对象,取出objc_property_t数组,包装成MJProperty数组。
unsigned int outCount = 0;
objc_property_t *properties = class_copyPropertyList(c, &outCount);
for (unsigned int i = 0; i<outCount; i++) {
//包装properties
MJProperty *property = [MJProperty cachedPropertyWithProperty:properties[i]];
if ([MJFoundation isClassFromFoundation:property.srcClass]) continue;
property.srcClass = c;
[property setOriginKey:[self propertyKey:property.name] forClass:self];
[property setObjectClassInArray:[self propertyObjectClassInArray:property.name] forClass:self];
[cachedProperties addObject:property];
}
复制代码
Fabric认为
if ([MJFoundation isClassFromFoundation:property.srcClass]) continue;
property.srcClass = c;
复制代码
这两行代码有些鸡肋,因为srcClass只有两种可能:Model类型或者nil,所以完全可以使用一个BOOL值来判断srcClass是否是Foundation object类型,而不用一个Class *srcClass
属性。
在这里需要着重理解这几行代码
[property setOriginKey:[self propertyKey:property.name] forClass:self];
[property setObjectClassInArray:[self propertyObjectClassInArray:property.name]
复制代码
第一个方法是把所有要替换的key值包装成数组存储到NSMutableDictionary *propertyKeysDict
对象中;
第二个方法是把数组中对应的想要转换成的Model的Class类型保存到NSMutableDictionary *objectClassInArrayDict
字典中。
理解了这两个方法也就理解了+ (NSDictionary *)mj_replacedKeyFromPropertyName
和+ (void)mj_setupObjectClassInArray:(MJObjectClassInArray)objectClassInArray
两个功能函数的实现原理了。
继续看如何包装objc_property_t property
,先从缓存中读取MJProperty。
//这里需要注意property指针指向的内存地址每次都是不变的,所以可以这样动态关联
MJProperty *propertyObj = objc_getAssociatedObject(self, property);
复制代码
如果没有缓存就把property包装成一个MJProperty,
- (void)setProperty:(objc_property_t)property
{
_property = property;
MJExtensionAssertParamNotNil(property);
// 1.属性名
_name = @(property_getName(property));
// 2.成员类型
NSString *attrs = @(property_getAttributes(property));
NSUInteger dotLoc = [attrs rangeOfString:@","].location;
NSString *code = nil;
NSUInteger loc = 1;
if (dotLoc == NSNotFound) { // 没有,
code = [attrs substringFromIndex:loc];
} else {
code = [attrs substringWithRange:NSMakeRange(loc, dotLoc - loc)];
}
_type = [MJPropertyType cachedTypeWithCode:code];
}
复制代码
这里代码已经很清楚了,获取property的name和attrs中的encode属性通过截取字符串来获得属性的类型。 下面来看一下MJProperty的type属性是如何设置的,
#pragma mark - 公共方法
- (void)setCode:(NSString *)code
{
_code = code;
MJExtensionAssertParamNotNil(code);
if ([code isEqualToString:MJPropertyTypeId]) {
_idType = YES;
} else if (code.length == 0) {
_KVCDisabled = YES;
} else if (code.length > 3 && [code hasPrefix:@"@\""]) {
// 去掉@"和",截取中间的类型名称
_code = [code substringWithRange:NSMakeRange(2, code.length - 3)];
_typeClass = NSClassFromString(_code);
_fromFoundation = [MJFoundation isClassFromFoundation:_typeClass];
_numberType = [_typeClass isSubclassOfClass:[NSNumber class]];
} else if ([code isEqualToString:MJPropertyTypeSEL] ||
[code isEqualToString:MJPropertyTypeIvar] ||
[code isEqualToString:MJPropertyTypeMethod]) {
_KVCDisabled = YES;
}
// 是否为数字类型
NSString *lowerCode = _code.lowercaseString;
NSArray *numberTypes = @[MJPropertyTypeInt, MJPropertyTypeShort, MJPropertyTypeBOOL1, MJPropertyTypeBOOL2, MJPropertyTypeFloat, MJPropertyTypeDouble, MJPropertyTypeLong, MJPropertyTypeLongLong, MJPropertyTypeChar];
if ([numberTypes containsObject:lowerCode]) {
_numberType = YES;
if ([lowerCode isEqualToString:MJPropertyTypeBOOL1]
|| [lowerCode isEqualToString:MJPropertyTypeBOOL2]) {
_boolType = YES;
}
}
}
复制代码
以上代码判断了property属性的具体类型,参考@encode()函数和MJExtensionConst方法,大家应该能够理解以上代码。
到这里,MJProperty的包装就基本说完了。
紧接着,取出keyValues中对应的值,
// 1.取出属性值
id value;
NSArray *propertyKeyses = [property propertyKeysForClass:clazz];
for (NSArray *propertyKeys in propertyKeyses) {
value = keyValues;
for (MJPropertyKey *propertyKey in propertyKeys) {
value = [propertyKey valueInObject:value];
}
if (value) break;
}
复制代码
处理value值,
// 值的过滤
id newValue = [clazz mj_getNewValueFromObject:self oldValue:value property:property];
if (newValue != value) { // 有过滤后的新值
[property setValue:newValue forObject:self];
return;
}
// 如果没有值,就直接返回
if (!value || value == [NSNull null]) return;
复制代码
最后是根据MJProperty的type中的typeClass,将不可扩展的集合转换成可变集合,方便后续的操作。对特定的值进行处理,如果是模型属性就继续进行递归转化,
if (!type.isFromFoundation && propertyClass) { // 模型属性
value = [propertyClass mj_objectWithKeyValues:value context:context];
}
复制代码
如果是数组,就遍历数组,如果数组中还是数组就继续递归,如果不是调用+[mj_objectWithKeyValues:context]转化成对应的Model元素放入数组,
for (NSDictionary *keyValues in keyValuesArray) {
if ([keyValues isKindOfClass:[NSArray class]]){
[modelArray addObject:[self mj_objectArrayWithKeyValuesArray:keyValues context:context]];
} else {
id model = [self mj_objectWithKeyValues:keyValues context:context];
if (model) [modelArray addObject:model];
}
}
复制代码
对于其他的propertyClass类型,Fabric在这里不做赘述,大家可以自己研究,并不复杂。
最后一步,将经过处理的value值代入Model当中,
// 3.赋值
[property setValue:value forObject:self];
复制代码
在模型转换完成之后,大家还可以重写- (void)mj_keyValuesDidFinishConvertingToObject
这个函数进行后续操作。
说到这里,Fabric基本上把MJExtension的Foundation object(或者JSON)转换成Model的原理细致的说了一遍。因为篇幅有限,本人能力有限,很多东西没有说清楚,感兴趣的同学和朋友们可以加我的微信:justlikeitRobert进行详细探讨。
谢谢大家的耐心阅读,Fabric祝大家狗年旺旺旺!