Dive into Category

本文系学习Objective-C的runtime源码时候整理所成，主要剖析了category在runtime层的实现原理以及和category相关的方方面面，包含了

• 初入宝地-category简介
• 连类比事-category和extension
• 挑灯细览-category真面目
• 追本溯源-category如何加载
• 旁枝末叶-category和+load方法
• 触类旁通-category和方法覆盖
• 更上一层-category和关联对象

1、初入宝地-category简介

category是Objective-C 2.0之后添加的语言特性，ctagegory的主要作用是为已经存在的类添加方法。除此之外，apple还推荐了ctagegory的另外两个使用场景 1

• 可以把类的实现分开在几个不同的文件里面。这样做有几个显而易见的好处，a)可以减少单个文件的体积 b)可以把不同的功能组织到不同的category里 c)可以由多个开发者共同完成一个类 d)可以按需加载想要的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真面目

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的可为（可以添加实例方法，类方法，甚至可以实现协议，添加属性）和不可为（无法添加实例变量）。ok，我们先去写一个category看一下category到底为何物：

MyClass.h：

#import <Foundation/Foundation.h>  @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, section ("__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, section ("__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, section ("__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 section(".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, section ("__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, section ("__DATA, __objc_catlist,regular,no_dead_strip")))= { &_OBJC_$_CATEGORY_MyClass_$_MyAddition, };

4、追本溯源-category如何加载

对于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*/, ↦_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);    }   }  } } 

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 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]; } 

5、旁枝末叶-category和+load方法

我们的代码里有MyClass和MyClass的两个category （Category1和Category2），MyClass和两个category都添加了+load方法，并且Category1和Category2都写了MyClass的printName方法。在Xcode中点击Edit Scheme，添加如下两个环境变量（可以在执行load方法以及加载category的时候打印log信息，更多的环境变量选项可参见objc-private.h）:

运行项目，我们会看到控制台打印很多东西出来，我们只找到我们想要的信息，顺序如下：

我们调整一个Category1和Category2的编译顺序，run。ok，我们可以看到控制台的输出顺序变了：

虽然对于+load的执行顺序是这样，但是对于“覆盖”掉的方法，则会先找到最后一个编译的category里的对应方法。这一节我们只是用很直观的方式得到了问题的答案，有兴趣的同学可以继续去研究一下OC的运行时代码。

6、触类旁通-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 <objc/runtime.h> @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做关联对象的清理工作。

后记