iOS分类(category)和类扩展(extension)

发表于   |   分类于 ，   |  

摘要

无论一个类设计的多么完美，在需求的演进当中，总会碰到一些无法预测的情况。那么怎么扩展已有的类？一般而言，有继承和组合两种选择。在 Objective-C 2.0 中，又提供了 category 这个语言特性，可以动态地为已有类添加新行为。本文将对 category 和 extension 进行介绍。

分类(category)

简介

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

  1. 可以把类的实现分开在几个不同的文件里面。这样做有几个显而易见的好处：
    • 可以减少单个文件的体积
    • 可以把不同的功能组织到不同的 category 里
    • 可以由多个开发者共同完成一个类
    • 可以按需加载想要的 category 等等
  2. 声明私有方法

不过除了apple推荐的使用场景，广大开发者脑洞大开，还衍生出了category的其他几个使用场景：

  1. 模拟多继承
  2. 把 framework 的私有方法公开

category 的结构

所有的 OC 类和对象，在 runtime 层都是用 struct 表示的，category 也不例外。在runtime层，category用结构体category_t

1
2
3
4
5
6
7
8
typedef struct category_t {
    const char *name;							// 分类名字
    classref_t cls;								// 所属类
    struct method_list_t *instanceMethods;		// category 中所有给类添加的实例方法的列表
    struct method_list_t *classMethods;			// category 中所有添加的类方法的列表
    struct protocol_list_t *protocols;			// category 实现的所有协议的列表
    struct property_list_t *instanceProperties; // category 中添加的所有属性
};

从 category 的定义也可以看出 category 的可以添加实例方法，类方法，实现协议，添加属性；但是无法添加实例变量。

category 的编译解析

自定义一个类，GGShop.h :

1
2
3
4
5
6
7
8
9
10
11
12
13
#import <Foundation/Foundation.h>
// 自定义的类
@interface GGShop : NSObject
@property (nonatomic, copy) NSString *name;
- (void)doSomething;
@end
    
// GGShop 的分类 Add
@interface GGShop (Add)<NSCopying>
@property (nonatomic, copy) NSString *age;
- (void)doSomething;
+ (void)otherSomthing;
@end

GGShop.m:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
#import "GGShop.h"

@implementation GGShop
- (void)doSomething {
    NSLog(@"++++++");
}
@end


@implementation GGShop (Add)
- (void)doSomething {
    NSLog(@"------");
}
+ (void)otherSomthing {
    NSLog(@"======");
}
@end

使用 clang 的命令去看看 category 到底会变成什么：

1
clang -rewrite-objc GGShop.m

执行命令后，GGShop.m 被编译成一个 GGShop.cpp文件，大约 3.5M，代码将近10万行，搜索在文件得最后位置找到分类的代码片段

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
54
55
56
57
58
59
60
61
// 分类实现的实例方法列表，只是在 .h 中声明了但没有实现的方法不会出现在这里
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_GGShop_$_Add __attribute__ ((used, section ("__DATA,__objc_const"))) = {
	sizeof(_objc_method),
	1,
	{{(struct objc_selector *)"doSomething", "v16@0:8", (void *)_I_GGShop_Add_doSomething}}
};

// 分类实现的类方法列表，同样只声明了的不会编译出现
static struct /*_method_list_t*/ {
	unsigned int entsize;  // sizeof(struct _objc_method)
	unsigned int method_count;
	struct _objc_method method_list[1];
} _OBJC_$_CATEGORY_CLASS_METHODS_GGShop_$_Add __attribute__ ((used, section ("__DATA,__objc_const"))) = {
	sizeof(_objc_method),
	1,
	{{(struct objc_selector *)"otherSomthing", "v16@0:8", (void *)_C_GGShop_Add_otherSomthing}}
};

// 分类遵守的协议列表
static struct /*_protocol_list_t*/ {
	long protocol_count;  // Note, this is 32/64 bit
	struct _protocol_t *super_protocols[1];
} _OBJC_CATEGORY_PROTOCOLS_$_GGShop_$_Add __attribute__ ((used, section ("__DATA,__objc_const"))) = {
	1,
	&_OBJC_PROTOCOL_NSCopying
};

// 分类的属性列表
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_GGShop_$_Add __attribute__ ((used, section ("__DATA,__objc_const"))) = {
	sizeof(_prop_t),
	1,
	{{"age","T@\"NSString\",C,N"}}
};

extern "C" __declspec(dllexport) struct _class_t OBJC_CLASS_$_GGShop;
// 分类的结构体
static struct _category_t _OBJC_$_CATEGORY_GGShop_$_Add __attribute__ ((used, section ("__DATA,__objc_const"))) = 
{
	"GGShop",
	0, // &OBJC_CLASS_$_GGShop,
	(const struct _method_list_t *)&_OBJC_$_CATEGORY_INSTANCE_METHODS_GGShop_$_Add,
	(const struct _method_list_t *)&_OBJC_$_CATEGORY_CLASS_METHODS_GGShop_$_Add,
	(const struct _protocol_list_t *)&_OBJC_CATEGORY_PROTOCOLS_$_GGShop_$_Add,
	(const struct _prop_list_t *)&_OBJC_$_PROP_LIST_GGShop_$_Add,
};

static void OBJC_CATEGORY_SETUP_$_GGShop_$_Add(void ) {
	_OBJC_$_CATEGORY_GGShop_$_Add.cls = &OBJC_CLASS_$_GGShop;
}

static struct _category_t *L_OBJC_LABEL_CATEGORY_$ [1] __attribute__((used, section ("__DATA, __objc_catlist,regular,no_dead_strip")))= {
	&_OBJC_$_CATEGORY_GGShop_$_Add,
};

可以看到，编译器生成了实例方法，类方法，属性，协议列表。它们的命名遵循

1
2
3
4
5
// 公共前缀 + 类名 + 分类名
_OBJC_$_CATEGORY_INSTANCE_METHODS_	GGShop_$_	Add,
_OBJC_$_CATEGORY_CLASS_METHODS_		GGShop_$_	Add,
_OBJC_CATEGORY_PROTOCOLS_$_			GGShop_$_	Add,
_OBJC_$_PROP_LIST_					GGShop_$_	Add,
  • category 的名字（例如Add）用来给各种列表以及后面的 category 结构体本身命名，而且有 static 来修饰，所以在同一个编译单元里我们的 category 名不能重复，否则会出现编译错误。
  • 编译器生成了category 本身 _OBJC_$_CATEGORY_GGShop_$_Add，并用前面生成的列表来初始化 category 本身。
  • 最后，编译器在DATA段下的 objc_catlist section 里保存了一个大小为1的 category_t 的数组L_OBJC_LABEL_CATEGORY_$（如果有多个category，会生成对应长度的数组），用于运行期category的加载

category 的加载

Objective-C 的运行是依赖 OC 的runtime的，而 OC 的runtime和其他系统库一样，是 OS X 和 iOS 通过dyld 动态加载的。

对于 OC 运行时，入口方法如下（在objc-os.mm文件中）：

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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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) {
    // catlist 就是上节中讲到的编译器准备的 category_t 数组
    category_t **catlist = _getObjc2CategoryList(hi, &count);
    // 遍历数组
    for (i = 0; i < count; i++) {
        category_t *cat = catlist[i];
        // 获取 category_t 的类
        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;
        // 把 category 的实例方法、协议以及属性添加到类上
        if (cat->instanceMethods ||  cat->protocols 
            ||  cat->instanceProperties)
        {
            // 类和 category 做一个关联映射
            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" : "");
            }
        }

        // 把 category 的类方法和协议添加到类的 metaclass 上
        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);
            }
        }
    }
}

下面来看 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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
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 添加方法
    attachMethodLists(cls, mlists, mcount, NO, fromBundle, inoutVtablesAffected);

    _free_internal(mlists);
}

// 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 的方法会“覆盖”掉原来类的同名方法，这是因为运行时在查找方法的时候是顺着方法列表的顺序查找的，它只要一找到对应名字的方法，就会罢休^_^，殊不知后面可能还有一样名字的方法。
  3. 如果有多个 category 都重新实现同一个方法，后加载的 category 的方法会加到其他同名方法的前面

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
24
25
26
27
28
29
30
31
32
Class className = [GGShop class];
GGShop *shop = [[GGShop alloc] init];

NSLog(@"%@", shop);

if (className) {
    // 获取类的方法列表
    unsigned int methodCount;
    Method *methodList = class_copyMethodList(className, &methodCount);
    
    IMP methodIMP = NULL;
	SEL methodSEL = NULL;
    // 遍历方法列表
    for (int i = 0; i < methodCount; i++) {
        
        Method method = methodList[i];
        NSString *methodString = NSStringFromSelector(method_getName(method));
        NSLog(@"------%@", methodString);
        // 寻找对应方法
        if ([@"doSomething" isEqualToString:methodString]) {
            // 获取找到的对应方法的 IMP 和 SEL 
            methodIMP = method_getImplementation(method);
            methodSEL = method_getName(method);
        }
    }
    // 直接调用 IMP
    typedef void(* Func)(id, SEL);
    if (methodIMP != NULL) {
        Func f = (Func)methodIMP;
        f(shop, methodSEL);
    } 
}

category 和 +load 方法

类在加载时，会调用 +load 方法，如果分类中有 +load 方法，会怎样调用

1
2
3
+ (void)load {
    NSLog(@"%s", __func__);
}

在类和分类中分别重写 +load 方法。

在Xcode中点击Edit Scheme -> Run -> Arguments -> Environment Variables，添加如下两个环境变量，设置 Value 为YES（可以在执行load方法以及加载 category 的时候打印 log 信息，更多的环境变量选项可参见objc-private.h）。

1
2
// OBJC_PRINT_LOAD_METHODS
// OBJC_PRINT_REPLACED_METHODS

按照 原类，Category1，Category2 的顺序加载类，运行输出结果如下：

1
2
3
4
5
6
7
8
REPLACED: -[GGShop doSomething]  by category Category1 
REPLACED: -[GGShop doSomething]  by category Category2
...
...
...
+[GGShop load]
+[GGShop(Category1) load]
+[GGShop(Category2) load]

由打印结果可以看出：

  • 附加 Category 方法到类的工作会先于 +load 方法的执行
  • +load 方法会先后分被执行，顺序为首先执行原类的，然后按照 Category 文件加载的顺序先后执行。
  • 在 +load 方法中不要调用父类的 +load 方法，因为父类在加载时会自动调用它的这个方法。
  • 与其他运行时才调用的方法不同，+load 方法在 APP 启动时，可执行文件加载到内存时便调用了。其他运行时的方法，最后加载的会加到其他同名方法前边，调用时只执行这一个。而 +load 方法 会按照 文件加载的顺序先后分别执行。

category 和关联对象

在 category 里面是无法为类添加实例变量，但是可以通过 Runtime 的方法给类添加关联的值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// .h
#import "GGShop.h"

@interface GGShop (Category1)
@property (nonatomic, copy) NSString *name;
@end

// .m
#import "GGShop+Category1.h"
#import <objc/runtime.h>

@implementation GGShop (Category1)

- (void)setName:(NSString *)name {
    objc_setAssociatedObject(self, @"name", name, OBJC_ASSOCIATION_COPY);
}

- (NSString *)name {
    NSString *name = objc_getAssociatedObject(self, @"name");
    return 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
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
54
55
56
57
58
59
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
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管理。
  • AssociationsManager里面是由一个静态AssociationsHashMap来存储所有的关联对象的。
  • 这相当于把所有对象的关联对象都存在一个全局 map 里面。而 map 的 key 是这个对象的指针地址（任意两个不同对象的指针地址一定是不同的），而这个 map 的 value 又是另外一个AssociationsHashMap，里面保存了关联对象的kv对。

而在对象的销毁逻辑里面，见objc-runtime-new.mm:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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做关联对象的清理工作。

类扩展(extension)

extension 被开发者称之为扩展、延展、匿名分类。extension 看起来很像一个匿名的category，但是 extension 和category 几乎完全是两个东西。和 category 不同的是 extension 不但可以声明方法，还可以声明属性、成员变量。extension 一般用于声明私有方法，私有属性，私有成员变量。

category是拥有.h文件和.m文件的东西。但是extension不然。extension只存在于一个.h文件中，或者extension只能寄生于一个类的.m文件中。比如，viewController.m文件中通常寄生这么个东西，其实这就是一个extension：

1
2
@interface ViewController ()
@end

当然我们也可以创建一个单独的extension文件，但是，extension 常用的形式并不是以一个单独的.h文件存在，而是寄生在类的.m文件中。

category 和 extension 对比

extension 看起来像匿名的 category，但是 extension 和有名字的 category 几乎完全是两个东西。

  • extension 在编译期决议，它就是类的一部分，在编译期和头文件里的@interface以及实现文件里的@implement一起形成一个完整的类，它伴随类的产生而产生，亦随之一起消亡。extension 一般用来隐藏类的私有信息，你必须有一个类的源码才能为一个类添加 extension，所以你无法为系统的类比如NSString添加 extension。
  • 但是 category 则完全不一样，它是在运行期决议的。
  • extension 可以添加实例变量，而 category 是无法添加实例变量的（因为在运行期，对象的内存布局已经确定，如果添加实例变量就会破坏类的内部布局，这对编译型语言来说是灾难性的）。
  • extension 和 category 都可以添加属性，但是 category 的属性不能生成成员变量和 getter、setter方法的实现