本文主要学习Objective-C的runtime源码时整理所成,主要剖析了category在runtime层的实现原理以及和category相关的方方面面,内容包括:
1、category简介
category是Objective-C 2.0之后添加的语言特性,主要作用是为已经存在的类添加方法。除此之外 apple还推荐了另外两个使用场景
*可以把类的实现分开在几个不同的文件里面。这样做有几个显而易见的好处:a)可以减少单个文件的体积 b)可以把不同的功能组织到不同的category里 c)可以由多个开发者共同完成一个类 d)可以按需加载想要的分类。
* 声明私有方法
其他使用场景:模拟多继承 、把framework的私有方法公开
2、category和extension
extension看起来很像一个匿名的category,但是extension和有名字的category几乎完全是两个东西。extension在编译期决议,它是类的一部分,在编译期和头文件里的@interface以及实现文件里的@implement一起形成一个完整的类,它伴随类的产生而产生,亦随之消亡。extension一般用来隐藏类的私有信息,你必须有一个类的源码才能为一个类添加extension 所以你无法为系统的类 比如NSString 添加extension(详见2)。 但是category完全不一样 它是在运行期决议的 就两者的区别来看 我们可以推到出一个事实 extension可以添加实例变量,而category无法添加实例变量(因为在运行期,对象的内存布局已将确定, 如果添加实例变量就会破坏类的内部布局,这对编译语言是致命的)。
3、category真面目
我们知道,所有的oc类 和对象在runtime层都是用struct表示的,category也不例外,在runtime层,category用结构体category_t(在下载objc源码objc-runtime -new
.h 可以找到定义),它包含了:类的名字、类、category中所有给类添加的实例方法的列表、category中所有添加的类方法的列表、category实现的所有协议的列表、category中添加的所有属性
typedef struct category_t {
const char *name;
classref_t cls;
struct method_list_t *instanceMethods;
struct method_list_t *classMethods;
struct protocol_list_t *protocols;
struct property_list_t *instanceProperties;
}category_t;
从category的定义也可以看出category的可为(可以添加实例方法,类方法,甚至可以实现协议,添加属性)和不可为(无法添加实例变量)。
我们写一个category看一下是什么:
然后clang命令 clang -rewrite-objc MyClass.m 看看会变成什么 会得到如下代码片段
staticstruct/*_method_list_t*/{unsignedintentsize;// sizeof(struct _objc_method)unsignedintmethod_count;struct_objc_method method_list[1];} _OBJC_$_CATEGORY_INSTANCE_METHODS_MyClass_$_MyAddition __attribute__ ((used, section ("__DATA,__objc_const"))) = {sizeof(_objc_method),1,{{(structobjc_selector *)"printName","v16@0:8", (void*)_I_MyClass_MyAddition_printName}}};staticstruct/*_prop_list_t*/{unsignedintentsize;// sizeof(struct _prop_t)unsignedintcount_of_properties;struct_prop_tprop_list[1];} _OBJC_$_PROP_LIST_MyClass_$_MyAddition __attribute__ ((used, section ("__DATA,__objc_const"))) = {sizeof(_prop_t),1,{{"name","T@\"NSString\",C,N"}}};extern"C"__declspec(dllexport)struct_class_tOBJC_CLASS_$_MyClass;staticstruct_category_t_OBJC_$_CATEGORY_MyClass_$_MyAddition __attribute__ ((used, section ("__DATA,__objc_const"))) ={"MyClass",0,// &OBJC_CLASS_$_MyClass,(conststruct_method_list_t*)&_OBJC_$_CATEGORY_INSTANCE_METHODS_MyClass_$_MyAddition,0,0,(conststruct_prop_list_t*)&_OBJC_$_PROP_LIST_MyClass_$_MyAddition,};staticvoidOBJC_CATEGORY_SETUP_$_MyClass_$_MyAddition(void) {_OBJC_$_CATEGORY_MyClass_$_MyAddition.cls = &OBJC_CLASS_$_MyClass;}#pragmasection(".objc_inithooks$B", long, read, write)__declspec(allocate(".objc_inithooks$B"))staticvoid*OBJC_CATEGORY_SETUP[] = {(void*)&OBJC_CATEGORY_SETUP_$_MyClass_$_MyAddition,};staticstruct_class_t*L_OBJC_LABEL_CLASS_$ [1] __attribute__((used, section ("__DATA, __objc_classlist,regular,no_dead_strip")))= {&OBJC_CLASS_$_MyClass,};staticstruct_class_t*_OBJC_LABEL_NONLAZY_CLASS_$[] = {&OBJC_CLASS_$_MyClass,};staticstruct_category_t*L_OBJC_LABEL_CATEGORY_$ [1] __attribute__((used, section ("__DATA, __objc_catlist,regular,no_dead_strip")))= {&_OBJC_$_CATEGORY_MyClass_$_MyAddition,};
我们可以看到,
1)、首先编译器生成了实例方法列表OBJC$_CATEGORY_INSTANCE_METHODSMyClass$_MyAddition和属性列表OBJC$_PROP_LISTMyClass$_MyAddition,两者的命名都遵循了公共前缀+类名+category名字的命名方式,而且实例方法列表里面填充的正是我们在MyAddition这个category里面写的方法printName,而属性列表里面填充的也正是我们在MyAddition里添加的name属性。还有一个需要注意到的事实就是category的名字用来给各种列表以及后面的category结构体本身命名,而且有static来修饰,所以在同一个编译单元里我们的category名不能重复,否则会出现编译错误。
2)、其次,编译器生成了category本身OBJC$_CATEGORYMyClass$_MyAddition,并用前面生成的列表来初始化category本身。
3)、最后,编译器在DATA段下的objc_catlist section里保存了一个大小为1的category_t的数组L_OBJC_LABELCATEGORY$(当然,如果有多个category,会生成对应长度的数组^_^),用于运行期category的加载。
到这里,编译器的工作就接近尾声了,对于category在运行期怎么加载,我们下节揭晓。
4、category如何加载
我们知道,Objective-C的运行是依赖OC的runtime的,而OC的runtime和其他系统库一样,是OS X和iOS通过dyld动态加载的。对于oc运行时入口代码如下:
void_objc_init(void)
{
staticboolinitialized =false;
if(initialized)return;
initialized =true;
// fixme defer initialization until an objc-using image is found?
environ_init();
tls_init();
lock_init();
exception_init();
// Register for unmap first, in case some +load unmaps something
_dyld_register_func_for_remove_image(&unmap_image); dyld_register_image_state_change_handler(dyld_image_state_bound,1/*batch*/, &map_images);
dyld_register_image_state_change_handler(dyld_image_state_dependents_initialized,0/*not batch*/, &load_images);
}
category被附加到类上面是在map_images的时候发生的,在new-ABI的标准下,_objc_init里面的调用的map_images最终会调用objc-runtime-new.mm里面的_read_images方法,而在_read_images方法的结尾,有以下的代码片段:
// Discover categories.
for(EACH_HEADER) {category_t**catlist = _getObjc2CategoryList(hi, &count);for(i =0; i < count; i++) {category_t*cat = catlist[i];class_t*cls = remapClass(cat->cls);if(!cls) {// Category's target class is missing (probably weak-linked).// Disavow any knowledge of this category.catlist[i] =NULL;if(PrintConnecting) { _objc_inform("CLASS: IGNORING category \?\?\?(%s) %p with ""missing weak-linked target class", cat->name, cat); }continue; }// Process this category. // First, register the category with its target class. // Then, rebuild the class's method lists (etc) if // the class is realized. BOOL classExists = NO;if(cat->instanceMethods || cat->protocols || cat->instanceProperties) { addUnattachedCategoryForClass(cat, cls, hi);if(isRealized(cls)) { remethodizeClass(cls); classExists = YES; }if(PrintConnecting) { _objc_inform("CLASS: found category -%s(%s) %s", getName(cls), cat->name, classExists ?"on existing class":""); } }if(cat->classMethods || cat->protocols/* || cat->classProperties */) { addUnattachedCategoryForClass(cat, cls->isa, hi);if(isRealized(cls->isa)) { remethodizeClass(cls->isa); }if(PrintConnecting) { _objc_inform("CLASS: found category +%s(%s)", getName(cls), cat->name); } } }
首先,我们拿到的catlist就是上节中讲到的编译器为我们准备的category_t数组,关于是如何加载catlist本身的,我们暂且不表,这和category本身的关系也不大,有兴趣的同学可以去研究以下Apple的二进制格式和load机制。
略去PrintConnecting这个用于log的东西,这段代码很容易理解:
1)、把category的实例方法、协议以及属性添加到类上
2)、把category的类方法和协议添加到类的metaclass上
值得注意的是,在代码中有一小段注释 / || cat->classProperties /,看来苹果有过给类添加属性的计划啊。
ok,我们接着往里看,category的各种列表是怎么最终添加到类上的,就拿实例方法列表来说吧:
在上述的代码片段里,addUnattachedCategoryForClass只是把类和category做一个关联映射,而remethodizeClass才是真正去处理添加事宜的功臣。
static void remethodizeClass(class_t *cls){ category_list *cats; BOOL isMeta; rwlock_assert_writing(&runtimeLock); isMeta = isMetaClass(cls);// Re-methodizing: check for more categoriesif((cats = unattachedCategoriesForClass(cls))) { chained_property_list *newproperties;constprotocol_list_t**newprotos;if(PrintConnecting) { _objc_inform("CLASS: attaching categories to class '%s' %s", getName(cls), isMeta ?"(meta)":""); }// Update methods, properties, protocolsBOOL vtableAffected = NO; attachCategoryMethods(cls, cats, &vtableAffected); newproperties = buildPropertyList(NULL, cats, isMeta);if(newproperties) { newproperties->next = cls->data()->properties; cls->data()->properties = newproperties; } newprotos = buildProtocolList(cats,NULL, cls->data()->protocols);if(cls->data()->protocols && cls->data()->protocols != newprotos) { _free_internal(cls->data()->protocols); } cls->data()->protocols = newprotos; _free_internal(cats);// Update method caches and vtablesflushCaches(cls);if(vtableAffected) flushVtables(cls); }}
而对于添加类的实例方法而言,又会去调用attachCategoryMethods这个方法,我们去看下attachCategoryMethods:
static void attachCategoryMethods(class_t *cls, category_list *cats,BOOL *inoutVtablesAffected){
if (!cats) return;
if (PrintReplacedMethods) printReplacements(cls, cats);
BOOL isMeta = isMetaClass(cls);
method_list_t **mlists = (method_list_t **)
_malloc_internal(cats->count * sizeof(*mlists));
// Count backwards through cats to get newest categories first
int mcount = 0;
int i = cats->count;
BOOL fromBundle = NO;
while (i--) {
method_list_t *mlist = cat_method_list(cats->list[i].cat, isMeta);
if (mlist) {
mlists[mcount++] = mlist;
fromBundle |= cats->list[i].fromBundle;
}
}
attachMethodLists(cls, mlists, mcount, NO, fromBundle, inoutVtablesAffected);
_free_internal(mlists);
}
attachCategoryMethods做的工作相对比较简单,它只是把所有category的实例方法列表拼成了一个大的实例方法列表,然后转交给了attachMethodLists方法(我发誓,这是本节我们看的最后一段代码了^_^),这个方法有点长,我们只看一小段
for (uint32_t m = 0;
(scanForCustomRR || scanForCustomAWZ) && m < mlist->count;
m++)
{
SEL sel = method_list_nth(mlist, m)->name;
if (scanForCustomRR && isRRSelector(sel)) {
cls->setHasCustomRR();
scanForCustomRR = false;
} else if (scanForCustomAWZ && isAWZSelector(sel)) {
cls->setHasCustomAWZ();
scanForCustomAWZ = false;
}
}
// Fill method list array
newLists[newCount++] = mlist;
.
.
.
// Copy old methods to the method list array
for (i = 0; i < oldCount; i++) {
newLists[newCount++] = oldLists[i];
}
需要注意的有两点:
1)、category的方法没有“完全替换掉”原来类已经有的方法,也就是说如果category和原来类都有methodA,那么category附加完成之后,类的方法列表里会有两个methodA
2)、category的方法被放到了新方法列表的前面,而原来类的方法被放到了新方法列表的后面,这也就是我们平常所说的category的方法会“覆盖”掉原来类的同名方法,这是因为运行时在查找方法的时候是顺着方法列表的顺序查找的,它只要一找到对应名字的方法,就会罢休^_^,殊不知后面可能还有一样名字的方法。
5、category和+load方法
我们知道在类和category中都可以有+load方法,有两个问题:1)在类的+load方法调用的时候,我们可以调用category中声明的方法吗? 2)这些个+load方法调用顺序是咋样的?
我们的代码里有MyClass和MyClass的两个category (Category1和Category2),MyClass和两个category都添加了+load方法,并且Category1和Category2都写了MyClass的printName方法。
在Xcode中点击Edit Scheme,添加如下两个环境变量(可以在执行load方法以及加载category的时候打印log信息,更多的环境变量选项可参见objc-private.h):
运行项目,我们会看到控制台打印很多东西出来,我们只找到我们想要的信息,顺序如下:
objc[1187]: REPLACED: -[MyClass printName] by category Category1
objc[1187]: REPLACED: -[MyClass printName] by category Category2
.
.
.
objc[1187]: LOAD: class 'MyClass' scheduled for +load
objc[1187]: LOAD: category 'MyClass(Category1)' scheduled for +load
objc[1187]: LOAD: category 'MyClass(Category2)' scheduled for +load
objc[1187]: LOAD: +[MyClass load]
.
.
.
objc[1187]: LOAD: +[MyClass(Category1) load]
.
.
.
objc[1187]: LOAD: +[MyClass(Category2) load]
所以,对于上面两个问题,答案是很明显的:
1)、可以调用,因为附加category到类的工作会先于+load方法的执行
2)、+load的执行顺序是先类,后category,而category的+load执行顺序是根据编译顺序决定的。
目前的编译顺序是这样的:
我们调整一个Category1和Category2的编译顺序,run。ok,我们可以看到控制台的输出顺序变了:
objc[1187]: REPLACED: -[MyClass printName] by category Category2
objc[1187]: REPLACED: -[MyClass printName] by category Category1
.
.
.
objc[1187]: LOAD: class 'MyClass' scheduled for +load
objc[1187]: LOAD: category 'MyClass(Category2)' scheduled for +load
objc[1187]: LOAD: category 'MyClass(Category1)' scheduled for +load
objc[1187]: LOAD: +[MyClass load]
.
.
.
objc[1187]: LOAD: +[MyClass(Category2) load]
.
.
.
objc[1187]: LOAD: +[MyClass(Category1) load]
虽然对于+load的执行顺序是这样,但是对于“覆盖”掉的方法,则会先找到最后一个编译的category里的对应方法。
这一节我们只是用很直观的方式得到了问题的答案,有兴趣的同学可以继续去研究一下OC的运行时代码。
6、category和方法覆盖
鉴于上面几节我们已经把原理都讲了,这一节只有一个问题:
怎么调用到原来类中被category覆盖掉的方法?
对于这个问题,我们已经知道category其实并不是完全替换掉原来类的同名方法,只是category在方法列表的前面而已,所以我们只要顺着方法列表找到最后一个对应名字的方法,就可以调用原来类的方法:
Class currentClass = [MyClass class];
MyClass *my = [[MyClass alloc] init];
if (currentClass) {
unsigned int methodCount;
Method *methodList = class_copyMethodList(currentClass, &methodCount);
IMP lastImp = NULL;
SEL lastSel = NULL;
for (NSInteger i = 0; i < methodCount; i++) {
Method method = methodList[i];
NSString *methodName = [NSString stringWithCString:sel_getName(method_getName(method))
encoding:NSUTF8StringEncoding];
if ([@"printName" isEqualToString:methodName]) {
lastImp = method_getImplementation(method);
lastSel = method_getName(method);
}
}
typedef void (*fn)(id,SEL);
if (lastImp != NULL) {
fn f = (fn)lastImp;
f(my,lastSel);
}
free(methodList);
7、category和关联对象
如上所见,我们知道在category里面是无法为category添加实例变量的。但是我们很多时候需要在category中添加和对象关联的值,这个时候可以求助关联对象来实现。
但是关联对象又是存在什么地方呢? 如何存储? 对象销毁时候如何处理关联对象呢?
我们去翻一下runtime的源码,在objc-references.mm文件中有个方法_object_set_associative_reference:
嗯,runtime的销毁对象函数objc_destructInstance里面会判断这个对象有没有关联对象,如果有,会调用_object_remove_assocations做关联对象的清理工作。
后记
正如侯捷先生所讲-“源码面前,了无秘密”,Apple的Cocoa Touch框架虽然并不开源,但是Objective-C的runtime和Core Foundation却是完全开放源码的
本系列runtime源码学习将会持续更新,意犹未尽的同学可以自行到上述网站下载源码学习。行笔简陋,如有错误,望指正。
本文作者来自美团酒店旅游事业群iOS研发组(https://tech.meituan.com/DiveIntoCategory.html)