深入理解 Objective-C：Category
点击上方“iOSTps”，选择“星标”
在看 真爱
编辑：老峰，作者：美团 iOS 研发组
摘要
无论一个类设计的多么完美，在未来的需求演进中，都有可能会碰到一些无法预测的情况。那怎么扩展已有的类呢？一般而言，继承和组合是不错的选择。但是在 Objective-C 2.0 中，又提供了category 这个语言特性，可以动态地为已有类添加新行为。如今 category 已经遍布于 Objective-C 代码的各个角落，从 Apple 官方的 framework 到各个开源框架，从功能繁复的大型 APP 到简单的应用，catagory 无处不在。本文对 category 做了比较全面的整理，希望对读者有所裨益。
简介
本文系学习 Objective-C 的 runtime 源码时整理所成，主要剖析了category 在 runtime 层的实现原理以及和 category 相关的方方面面，内容包括：
初入宝地 -category 简介
连类比事 -category 和 extension
挑灯细览 -category 真面目
追本溯源 -category 如何加载
旁枝末叶 -category 和 +load 方法
触类旁通 -category 和方法覆盖
更上一层 -category 和关联对象
初入宝地：Category 简介
category 是 Objective-C 2.0 之后添加的语言特性，category 的主要作用是为已经存在的类添加方法。除此之外，Apple 还推荐了 category 的另外两个使用场景
可以把类的实现分开在几个不同的文件里面。这样做有几个显而易见的好处：1、可以减少单个文件的体积；2、可以把不同的功能组织到不同的 category里；3、可以由多个开发者共同完成一个类；4、可以按需加载想要的 category 等等。
声明私有方法
不过除了 Apple 推荐的使用场景，广大开发者脑洞大开，还衍生出了 category 的其他几个使用场景：
模拟多继承
把 framework 的私有方法公开
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）
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 看一下 category 到底为何物：
MyClass.h：
#import
@interface MyClass : NSObject
- (void)printName;
@end
@interface MyClass(MyAddition)
@property(nonatomic, copy) NSString *name;
- (void)printName;
@end
MyClass.m：
#import "MyClass.h"
@implementation MyClass
- (void)printName
{
NSLog(@"%@",@"MyClass");
}
@end
@implementation MyClass(MyAddition)
- (void)printName
{
NSLog(@"%@",@"MyAddition");
}
@end
我们使用 clang 的命令去看看 category 到底会变成什么：
clang -rewrite-objc MyClass.m
好吧，我们得到了一个 3M 大小，10w 多行的 .cpp 文件（这绝对是 Apple 值得吐槽的一点），我们忽略掉所有和我们无关的东西，在文件的最后，我们找到了如下代码片段：
static struct /*_method_list_t*/ {unsigned int entsize; // sizeof(struct _objc_method)unsigned int method_count;struct _objc_method method_list[1];} _OBJC_$_CATEGORY_INSTANCE_METHODS_MyClass_$_MyAddition __attribute__ ((used, p ("__DATA,__objc_const"))) = {sizeof(_objc_method),1,{{(struct objc_selector *)"printName", "v16@0:8", (void *)_I_MyClass_MyAddition_printName}}};
static struct /*_prop_list_t*/ {unsigned int entsize; // sizeof(struct _prop_t)unsigned int count_of_properties;struct _prop_t prop_list[1];} _OBJC_$_PROP_LIST_MyClass_$_MyAddition __attribute__ ((used, p ("__DATA,__objc_const"))) = {sizeof(_prop_t),1,{{"name","T@\"NSString\",C,N"}}};
extern "C" __declspec(dllexport) struct _class_t OBJC_CLASS_$_MyClass;
static struct _category_t _OBJC_$_CATEGORY_MyClass_$_MyAddition __attribute__ ((used, p ("__DATA,__objc_const"))) ={"MyClass",0, // &OBJC_CLASS_$_MyClass,(const struct _method_list_t *)&_OBJC_$_CATEGORY_INSTANCE_METHODS_MyClass_$_MyAddition,0,0,(const struct _prop_list_t *)&_OBJC_$_PROP_LIST_MyClass_$_MyAddition,};static void OBJC_CATEGORY_SETUP_$_MyClass_$_MyAddition(void ) {_OBJC_$_CATEGORY_MyClass_$_MyAddition.cls = &OBJC_CLASS_$_MyClass;}#pragma p(".objc_inithooks$B", long, read, write)__declspec(allocate(".objc_inithooks$B")) static void *OBJC_CATEGORY_SETUP[] = {(void *)&OBJC_CATEGORY_SETUP_$_MyClass_$_MyAddition,};static struct _class_t *L_OBJC_LABEL_CLASS_$ [1] __attribute__((used, p ("__DATA, __objc_classlist,regular,no_dead_strip")))= {&OBJC_CLASS_$_MyClass,};static struct _class_t *_OBJC_LABEL_NONLAZY_CLASS_$[] = {&OBJC_CLASS_$_MyClass,};static struct _category_t *L_OBJC_LABEL_CATEGORY_$ [1] __attribute__((used, p ("__DATA, __objc_catlist,regular,no_dead_strip")))= {&_OBJC_$_CATEGORY_MyClass_$_MyAddition,};我们可以看到，
1)、首先编译器生成了实例方法列表 OBJC_MyAddition 和属性列表 OBJC_MyAddition，两者的命名都遵循了公共前缀 + 类名 +category 名字的命名方式，而且实例方法列表里面填充的正是我们在 MyAddition 这个 category 里面写的方法 printName，而属性列表里面填充的也正是我们在 MyAddition 里添加的name属性。还有一个需要注意到的事实就是 category 的名字用来给各种列表以及后面的 category 结构体本身命名，而且有 static 来修饰，所以在同一个编译单元里我们的 category 名不能重复，否则会出现编译错误。
2)、其次，编译器生成了 category 本身 OBJC_MyAddition ，并用前面生成的列表来初始化 category 本身。
3)、最后，编译器在 DATA 段下的 objc_catlist p 里保存了一个大小为 1 的category_t 的数组 L_OBJC_LABELCATEGORY$（当然，如果有多个category，会生成对应长度的数组。
到这里，编译器的工作就接近尾声了，对于 category 在运行期怎么加载，我们下节揭晓。
4、追本溯源：Category 如何加载
我们知道，Objective-C 的运行是依赖 OC 的 runtime 的，而 OC 的 runtime 和其他系统库一样，是 OS X 和 iOS 通过 dyld 动态加载的。
想了解更多 dyld 的同学可以移步这里（3）。
对于 OC 运行时，入口方法如下（在 objc-os.mm 文件中）：
void _objc_init(void){ static bool initialized = 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 */，看来苹果有过给类添加属性的计划啊。
我们接着往里看，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 categories if ((cats = unattachedCategoriesForClass(cls))) { chained_property_list *newproperties; const protocol_list_t **newprotos; if (PrintConnecting) { _objc_inform("CLASS: attaching categories to class '%s' %s", getName(cls), isMeta ? "(meta)" : ""); } // Update methods, properties, protocols BOOL 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 vtables flushCaches(cls); if (vtableAffected) flushVtables(cls); }}而对于添加类的实例方法而言，又会去调用 attachCategoryMethods 这个方法，我们去看下 attachCategoryMethods：
static voidattachCategoryMethods(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。我们可以看到控制台的输出顺序变了：
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 中添加和对象关联的值，这个时候可以求助关联对象来实现。
MyClass+Category1.h:
#import "MyClass.h"
@interface MyClass (Category1)
@property(nonatomic,copy) NSString *name;
@end
MyClass+Category1.m:
#import "MyClass+Category1.h"
#import
@implementation MyClass (Category1)
+ (void)load
{
NSLog(@"%@",@"load in Category1");
}
- (void)setName:(NSString *)name
{
objc_setAssociatedObject(self,
"name",
name,
OBJC_ASSOCIATION_COPY);
}
- (NSString*)name
{
NSString *nameObject = objc_getAssociatedObject(self, "name");
return nameObject;
}
@end
但是关联对象又是存在什么地方呢？如何存储？对象销毁时候如何处理关联对象呢？
我们去翻一下 runtime 的源码，在 objc-references.mm 文件中有个方法 _object_set_associative_reference：
void _object_set_associative_reference(id object, void *key, id value, uintptr_t policy) { // retain the new value (if any) outside the lock. ObjcAssociation old_association(0, nil); id new_value = value ? acquireValue(value, policy) : nil; { AssociationsManager manager; AssociationsHashMap &associations(manager.associations()); disguised_ptr_t disguised_object = DISGUISE(object); if (new_value) { // break any existing association. AssociationsHashMap::iterator i = associations.find(disguised_object); if (i != associations.end()) { // secondary table exists ObjectAssociationMap *refs = i->second; ObjectAssociationMap::iterator j = refs->find(key); if (j != refs->end()) { old_association = j->second; j->second = ObjcAssociation(policy, new_value); } else { (*refs)[key] = ObjcAssociation(policy, new_value); } } else { // create the new association (first time). ObjectAssociationMap *refs = new ObjectAssociationMap; associations[disguised_object] = refs; (*refs)[key] = ObjcAssociation(policy, new_value); _class_setInstancesHaveAssociatedObjects(_object_getClass(object)); } } else { // setting the association to nil breaks the association. AssociationsHashMap::iterator i = associations.find(disguised_object); if (i != associations.end()) { ObjectAssociationMap *refs = i->second; ObjectAssociationMap::iterator j = refs->find(key); if (j != refs->end()) { old_association = j->second; refs->erase(j); } } } } // release the old value (outside of the lock). if (old_association.hasValue()) ReleaseValue()(old_association);}我们可以看到所有的关联对象都由 AssociationsManager 管理，而 AssociationsManager 定义如下：
class AssociationsManager { static OSSpinLock _lock; static AssociationsHashMap *_map; // associative references: object pointer -> PtrPtrHashMap.public: AssociationsManager() { OSSpinLockLock(&_lock); } ~AssociationsManager() { OSSpinLockUnlock(&_lock); } AssociationsHashMap &associations() { if (_map == NULL) _map = new AssociationsHashMap(); return *_map; }};AssociationsManager 里面是由一个静态 AssociationsHashMap 来存储所有的关联对象的。这相当于把所有对象的关联对象都存在一个全局 map 里面。而 map 的的 key 是这个对象的指针地址（任意两个不同对象的指针地址一定是不同的），而这个 map 的 value 又是另外一个 AssociationsHashMap，里面保存了关联对象的 kv 对。
而在对象的销毁逻辑里面，见 objc-runtime-new.mm:
void *objc_destructInstance(id obj){ if (obj) { Class isa_gen = _object_getClass(obj); class_t *isa = newcls(isa_gen);
// Read all of the flags at once for performance. bool cxx = hasCxxStructors(isa); bool assoc = !UseGC && _class_instancesHaveAssociatedObjects(isa_gen);
// This order is important. if (cxx) object_cxxDestruct(obj); if (assoc) _object_remove_assocations(obj); if (!UseGC) objc_clear_deallocating(obj); }
return obj;}
嗯，runtime 的销毁对象函数 objc_destructInstance 里面会判断这个对象有没有关联对象，如果有，会调用 _object_remove_assocations 做关联对象的清理工作。
后记
正如侯捷先生所讲-“源码面前，了无秘密”，Apple 的 Cocoa Touch 框架虽然并不开源，但是 Objective-C 的 runtime 和 Core Foundation 却是完全开放源码的(在 http://www.opensource.apple.com/tarballs/可以下载到全部的开源代码)。
推荐阅读：
苹果 2019 卖什么？新 iPhone 值不值得买？
如何实现一个手帐 App
理解 Xcode 编译系统
