YYModel源码阅读
1.Demo简要介绍: 只有2个实现文件,NSObject+YYModel 和 YYClassInfo
1.普通简直映射,NSObject的扩展:
+ (instancetype)modelWithJSON:(id)json;
我们需要自己声明json中的key值,key值的类型可以是任何类型,如嵌套一个model。
2.自定义映射方式。如果json中的key值并不是你期望的key值,可以使用以下方法做一个映射:
+ (NSDictionary *)modelCustomPropertyMapper;
返回的字典中,value是json中的key值,字典的key是生成的model的属性。
3.model的一些扩展属性,包括:
Coding\Copying\hash\equal
2.学习准备
我们从方法调用的时序去了解它内部的原理。但是在这之前,我们需要做一些准备工作。准备了一份objc4的源码,我们了解YYClassInfo时会用到一些知识。
ivar: 定义对象的实例变量
struct ivar_t {
#if __x86_64__
// *offset was originally 64-bit on some x86_64 platforms.
// We read and write only 32 bits of it.
// Some metadata provides all 64 bits. This is harmless for unsigned
// little-endian values.
// Some code uses all 64 bits. class_addIvar() over-allocates the
// offset for their benefit.
#endif
int32_t *offset;
const char *name;
const char *type;
// alignment is sometimes -1; use alignment() instead
uint32_t alignment_raw;
uint32_t size;
uint32_t alignment() const {
if (alignment_raw == ~(uint32_t)0) return 1U << WORD_SHIFT;
return 1 << alignment_raw;
}
};
property: 属性
struct property_t {
const char *name;
const char *attributes;
};
method: SEL是选择子,是方法名的唯一标识符。IMP是方法实现的指针。
struct method_t {
SEL name;
const char *types;
IMP imp;
struct SortBySELAddress :
public std::binary_function
{
bool operator() (const method_t& lhs,
const method_t& rhs)
{ return lhs.name < rhs.name; }
};
};
元类meta class
建议阅读: Objective-C 中的元类(meta class)是什么? 和 唐巧: Objective-C对象模型及应用
简单的说,元类是类对象的类。我们知道,实例对象的方法存储在类中。而类对象的方法,是存储在元类中的,这也使得Object-C的对象模型得到了统一。
3.源码学习
1.YYClassInfo
json数据只是字符串,离我们使用的多元的数据类型差距较大,更何况还有属性等修饰。YYClassInfo正如其名,就是对类信息的一层封装,并且提供了很多公有的属性,便于我们去配置。主要有:
1.YYClassIvarInfo
2.YYClassPropertyInfo
3.YYClassMethodInfo
查看这几个类的公有属性,再对比上文学习准备objc4中的源码实现,不难看出它主要把结构体中对我们不可见的成员开放了出来。并且自身实现了YYEncodingType枚举,用于区分编码类型(后文说明)。我们再看YYClassInfo的声明,包含了类,父类,元类和上文提及的类的信息。
查看他的构造方法:
+ (instancetype)classInfoWithClass:(Class)cls {
if (!cls) return nil;
static CFMutableDictionaryRef classCache;
static CFMutableDictionaryRef metaCache;
static dispatch_once_t onceToken;
static dispatch_semaphore_t lock;
dispatch_once(&onceToken, ^{
classCache = CFDictionaryCreateMutable(CFAllocatorGetDefault(), 0, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
metaCache = CFDictionaryCreateMutable(CFAllocatorGetDefault(), 0, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
lock = dispatch_semaphore_create(1);
});
dispatch_semaphore_wait(lock, DISPATCH_TIME_FOREVER);
YYClassInfo *info = CFDictionaryGetValue(class_isMetaClass(cls) ? metaCache : classCache, (__bridge const void *)(cls));
if (info && info->_needUpdate) {
[info _update];
}
dispatch_semaphore_signal(lock);
if (!info) {
info = [[YYClassInfo alloc] initWithClass:cls];
if (info) {
dispatch_semaphore_wait(lock, DISPATCH_TIME_FOREVER);
CFDictionarySetValue(info.isMeta ? metaCache : classCache, (__bridge const void *)(cls), (__bridge const void *)(info));
dispatch_semaphore_signal(lock);
}
}
return info;
}
创建了2个缓存区,classCache和metaCache,分别用于存放元类和类。由于可变字典的创建不是线性安全的,所以使用了信号量。信号量可以参考这里。然后,从缓存区获取info,如果获取失败则创建一个info,并将info存入缓存区。init方法也很简单:
- (instancetype)initWithClass:(Class)cls {
if (!cls) return nil;
self = [super init];
_cls = cls;
_superCls = class_getSuperclass(cls);
_isMeta = class_isMetaClass(cls);
if (!_isMeta) {
_metaCls = objc_getMetaClass(class_getName(cls));
}
_name = NSStringFromClass(cls);
[self _update];
_superClassInfo = [self.class classInfoWithClass:_superCls];
return self;
}
我们注意到内部有一个_update方法,顾名思义就是更新info的属性的值。
_YYModelPropertyMeta (NSObject+YYModel.m中)
如注释所说,这是一个关于model的property信息的类。需要注意的一点是声明的成员变量列表末尾有一个next指针,结合构造方法可以知道该meta类的对象是用链表的方式组合在一起的。
/// A property info in object model.
@interface _YYModelPropertyMeta : NSObject {
//...略
}
它只有一个构造方法,做的事是:把传入的classInfo,propertyInfo,generic(映射关系表)等信息全部组装到了YYModelPropertyMeta中。用来干啥呢?后文继续~
+ (instancetype)metaWithClassInfo:(YYClassInfo *)classInfo
propertyInfo:(YYClassPropertyInfo *)propertyInfo
generic:(Class)generic;
YYModelMeta
如YYModelPropertyMeta,YYModelMeta就是一个关于model的class信息的类。构造方法内的注释也非常清晰。简单提及一下,具体的讲解将根据实际场景分析。请记住这5个步骤,后文我将用1~5来举例这五步。
- (instancetype)initWithClass:(Class)cls {
//1.获取黑名单
//2.获取白名单
//3.获取容器属性的映射关系表
//4.将YYClassInfo实例中的所有YYClassPropertyInfo加入到字典中
//5.创建一个新的映射表
}
4.具体应用场景
取YYKit Demo中最简单的例子(即SimpleObjectExample)。
调用modelWithJSON后,JSON会用系统的json解析器解析为字典,并传入metaWithClass中。
①先查看metaWithClass内部的流程:
1)在metaWithClass中,初次创建model时从缓存获取meta失败,则调用initWithClass生成一个YYModelMeta。
+ (instancetype)modelWithDictionary:(NSDictionary *)dictionary {
//...
_YYModelMeta *meta = CFDictionaryGetValue(cache, (__bridge const void *)(cls));
dispatch_semaphore_signal(lock);
if (!meta || meta->_classInfo.needUpdate) {
meta = [[_YYModelMeta alloc] initWithClass:cls];
//...
}
//...
}
2)在YYModelMeta的initWithClass中,先根据参数cls生成YYClassInfo类classInfo,用classInfo方便我们对数据处理。
3)简单的model,会直接调用第四部(前文提及)。
这里主要是把classInfo中的property信息取出,生成一个YYModelPropertyMeta实例。然后全部存入allPropertyMetas数组中。插问一句,为什么property这么重要?因为它是我们的model提供对外的属性,对应了JSON数据中的字典。是链接JSON数据和model的桥梁(我乱比喻~)。
4)非自定义的key值,直接遍历存入哈希表中
[allPropertyMetas enumerateKeysAndObjectsUsingBlock:^(NSString *name, _YYModelPropertyMeta *propertyMeta, BOOL *stop) {
propertyMeta->_mappedToKey = name;
propertyMeta->_next = mapper[name] ?: nil;
mapper[name] = propertyMeta;
}];
5)最后是一些布尔值成员变量的赋值。经过以上的步骤,我们成功的拿到了modelMeta。
6#)这只是对最基本的JSON数据类型的解析,YYModelMeta的初始化方法里面还有对自定义键值的处理,还是值得我们去深入了解的。本文暂时先分析到这。
②再看modelSetWithDictionary方法中做啥
1)缓存中可以获取到moedelMeta
2)提供了一个ModelSetContext
typedef struct {
void *modelMeta; ///< _YYModelMeta
void *model; ///< id (self)
void *dictionary; ///< NSDictionary (json)
} ModelSetContext;
3)首先说一下CFArrayApplyFunction这个方法,字典同理:
void CFArrayApplyFunction(CFArrayRef theArray,
CFRange range,
CFArrayApplierFunction CF_NOESCAPE applier,
void *context);
在给定的range中遍历theArray,执行applier方法。对应到YYModel的代码,我们看下ModelSetWithDictionaryFunction中做了什么事情。
static void ModelSetWithDictionaryFunction(const void *_key, const void *_value, void *_context) {
ModelSetContext *context = _context;
__unsafe_unretained _YYModelMeta *meta = (__bridge _YYModelMeta *)(context->modelMeta);
__unsafe_unretained _YYModelPropertyMeta *propertyMeta = [meta->_mapper objectForKey:(__bridge id)(_key)];
__unsafe_unretained id model = (__bridge id)(context->model);
while (propertyMeta) {
if (propertyMeta->_setter) {
ModelSetValueForProperty(model, (__bridge __unsafe_unretained id)_value, propertyMeta);
}
propertyMeta = propertyMeta->_next;
};
}
根据propertyMeta遍历,通过ModelSetValueForProperty方法给属性的赋值。ModelSetValueForProperty方法中通过swich-case对不同类型的值一一赋值。最终,我们得到了想要的model!
5.回顾(个人的总结,仅供参考)
YYModel对外的API非常简单明了,但是内部高度使用了CFFoundation框架,大量使用了指针、结构体等C语言层面的内容,都是希望在性能上表现更好。它把类、元类中许多没有对外开放的内容对外开放,封装,方便了定制化的操作。
学习的过程中,需要对OC对象模型有较好的了解,对CFFoundation有一定的掌握,这些都更能加深我们对OC这么语言的认知,很好!
全文只是个人的理解,有问题的地方希望指正,交流!