无论一个类设计的多么完美,在未来的需求演进中,都有可能会碰到一些无法预测的情况。那怎么扩展已有的类呢?一般而言,继承和组合是不错的选择。但是在Objective-C 2.0中,又提供了category这个语言特性,可以动态地为已有类添加新行为。如今category已经遍布于Objective-C代码的各个角落,从Apple官方的framework到各个开源框架,从功能繁复的大型APP到简单的应用,catagory无处不在。本文对category做了比较全面的整理,希望对读者有所裨益。
简介
本文作者来自美团酒店旅游事业群iOS研发组。我们致力于创造价值、提升效率、追求卓越。 本文系学习Objective-C的runtime源码时整理所成,主要剖析了category在runtime层的实现原理以及和category相关的方方面面,内容包括:
- 初入宝地-category简介
- 连类比事-category和extension
- 挑灯细览-category真面目
- 追本溯源-category如何加载
- 旁枝末叶-category和+load方法
- 触类旁通-category和方法覆盖
- 更上一层-category和关联对象
1、初入宝地-category简介
category是Objective-C 2.0之后添加的语言特性,category的主要作用是为已经存在的类添加方法。除此之外,apple还推荐了category的另外两个使用场景1
- 可以把类的实现分开在几个不同的文件里面。这样做有几个显而易见的好处,a)可以减少单个文件的体积 b)可以把不同的功能组织到不同的category里 c)可以由多个开发者共同完成一个类 d)可以按需加载想要的category 等等。
- 声明私有方法
不过除了apple推荐的使用场景,广大开发者脑洞大开,还衍生出了category的其他几个使用场景:
Objective-C的这个语言特性对于纯动态语言来说可能不算什么,比如javascript,你可以随时为一个“类”或者对象添加任意方法和实例变量。但是对于不是那么“动态”的语言而言,这确实是一个了不起的特性。
2、连类比事-category和extension
extension看起来很像一个匿名的category,但是extension和有名字的category几乎完全是两个东西。 extension在编译期决议,它就是类的一部分,在编译期和头文件里的@interface以及实现文件里的@implement一起形成一个完整的类,它伴随类的产生而产生,亦随之一起消亡。extension一般用来隐藏类的私有信息,你必须有一个类的源码才能为一个类添加extension,所以你无法为系统的类比如NSString添加extension。(详见2)
但是category则完全不一样,它是在运行期决议的。 就category和extension的区别来看,我们可以推导出一个明显的事实,extension可以添加实例变量,而category是无法添加实例变量的(因为在运行期,对象的内存布局已经确定,如果添加实例变量就会破坏类的内部布局,这对编译型语言来说是灾难性的)。
3、挑灯细览-category真面目
我们知道,所有的OC类和对象,在runtime层都是用struct表示的,category也不例外,在runtime层,category用结构体category_t(在objc-runtime-new.h中可以找到此定义),它包含了 1)、类的名字(name) 2)、类(cls) 3)、category中所有给类添加的实例方法的列表(instanceMethods) 4)、category中所有添加的类方法的列表(classMethods) 5)、category实现的所有协议的列表(protocols) 6)、category中添加的所有属性(instanceProperties)
从category的定义也可以看出category的可为(可以添加实例方法,类方法,甚至可以实现协议,添加属性)和不可为(无法添加实例变量)。 ok,我们先去写一个category看一下category到底为何物:
MyClass.h:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
#import <Foundation/Foundation.h>
NSObject
;
end
)
;
;
end
|
MyClass.m:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
MyClass
printName
{
;
}
end
)
printName
{
;
}
end
|
我们使用clang的命令去看看category到底会变成什么:
好吧,我们得到了一个3M大小,10w多行的.cpp文件(这绝对是Apple值得吐槽的一点),我们忽略掉所有和我们无关的东西,在文件的最后,我们找到了如下代码片段:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
{
// sizeof(struct _objc_method)
;
;
{
,
,
}
;
{
// sizeof(struct _prop_t)
;
;
{
,
,
}
;
;
=
{
,
// &OBJC_CLASS_$_MyClass,
,
,
,
,
;
{
;
}
{
,
;
{
,
;
{
,
;
{
,
;
|
我们可以看到, 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动态加载的。 想了解更多dyld地同学可以移步这里(3)。
对于OC运行时,入口方法如下(在objc-os.mm文件中):
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
)
{
;
;
;
// fixme defer initialization until an objc-using image is found?
;
;
;
;
// Register for unmap first, in case some +load unmaps something
;
,
;
;
}
|
category被附加到类上面是在map_images的时候发生的,在new-ABI的标准下,_objc_init里面的调用的map_images最终会调用objc-runtime-new.mm里面的_read_images方法,而在_read_images方法的结尾,有以下的代码片段:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
// Discover categories.
{
=
;
;
;
{
// Category's target class is missing (probably weak-linked).
// Disavow any knowledge of this category.
;
{
,
;
}
;
}
// Process this category.
// First, register the category with its target class.
// Then, rebuild the class's method lists (etc) if
// the class is realized.
;
protocols
)
{
;
{
;
;
}
{
,
,
;
}
}
protocols
)
{
;
{
;
}
{
,
;
}
}
}
}
|
首先,我们拿到的catlist就是上节中讲到的编译器为我们准备的category_t数组,关于是如何加载catlist本身的,我们暂且不表,这和category本身的关系也不大,有兴趣的同学可以去研究以下Apple的二进制格式和load机制。 略去PrintConnecting这个用于log的东西,这段代码很容易理解: 1)、把category的实例方法、协议以及属性添加到类上 2)、把category的类方法和协议添加到类的metaclass上
值得注意的是,在代码中有一小段注释 / || cat->classProperties /,看来苹果有过给类添加属性的计划啊。 ok,我们接着往里看,category的各种列表是怎么最终添加到类上的,就拿实例方法列表来说吧: 在上述的代码片段里,addUnattachedCategoryForClass只是把类和category做一个关联映射,而remethodizeClass才是真正去处理添加事宜的功臣。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
)
{
;
;
;
;
// Re-methodizing: check for more categories
{
;
;
{
,
;
}
// Update methods, properties, protocols
;
;
;
{
;
;
}
;
{
;
}
;
;
// Update method caches and vtables
;
;
}
}
|
而对于添加类的实例方法而言,又会去调用attachCategoryMethods这个方法,我们去看下attachCategoryMethods:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
void
,
)
{
;
;
;
)
;
// Count backwards through cats to get newest categories first
;
;
;
{
;
{
;
;
}
}
;
;
}
|
attachCategoryMethods做的工作相对比较简单,它只是把所有category的实例方法列表拼成了一个大的实例方法列表,然后转交给了attachMethodLists方法(我发誓,这是本节我们看的最后一段代码了^_^),这个方法有点长,我们只看一小段:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
;
;
)
{
;
{
;
;
{
;
;
}
}
// Fill method list array
;
.
.
.
// Copy old methods to the method list array
{
;
}
|
需要注意的有两点: 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在方法列表的前面而已,所以我们只要顺着方法列表找到最后一个对应名字的方法,就可以调用原来类的方法:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
;
;
{
;
;
;
;
)
;
{
;
;
}
}
;
{
;
;
}
;
}
|
7、更上一层-category和关联对象
如上所见,我们知道在category里面是无法为category添加实例变量的。但是我们很多时候需要在category中添加和对象关联的值,这个时候可以求助关联对象来实现。
MyClass+Category1.h:
MyClass+Category1.m:
#import <objc/runtime.h>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
)
load
{
;
}
name
{
,
,
,
;
}
name
{
;
;
}
end
|
但是关联对象又是存在什么地方呢? 如何存储? 对象销毁时候如何处理关联对象呢? 我们去翻一下runtime的源码,在objc-references.mm文件中有个方法_object_set_associative_reference:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
|
请发表评论