iOS 关联对象

0x0. 前言

objc_setAssociatedObject通过相应的 key 和 policy，给指定的对象设置关联值。常见用法是给分类添加属性，本文主要分析objc_setAssociatedObject和objc_getAssociatedObject两者的实现原理。

0x1. objc_setAssociatedObject

在“欣赏”源码之前，先看下几个关键的类，好对基本原理有个大致的认识，也好对接下来的源码阅读有一定的帮助。

通过源码(objc4-781.tar.gz)知道，objc_setAssociatedObject内部最终调用了_object_set_associative_reference，所以重点分析下这个函数即可。

void objc_setAssociatedObject(id object, const void *key, id value, objc_AssociationPolicy policy) {
    _object_set_associative_reference(object, (void *)key, value, policy);
}

1
2
3

函数内部实现相对比较简单，主要可用以下几步概述：

先将object地址转为 uintptr_t 类型，接着value和policy作为入参，创建一个 ObjcAssociation 对象；
通过 AssociationsManager 实例，获取内部 AssociationsHashMap 对象；
如果value不为空，则把object地址作为键，同时新建一个 ObjectAssociationMap 作为值，插入到上述 AssociationsHashMap 对象中；
接着key作为键，步骤1新建的 ObjcAssociation 对象作为值，插入到步骤3创建的 ObjectAssociationMap 对象中；
如果value为空，则将之前存储在 ObjectAssociationMap 中的key和 ObjcAssociation 对象移除，如果 ObjectAssociationMap 中元素个数为0，则将其从 AssociationsHashMap 中移除。

接下来，源码就要登场了，有了上述5个步骤，源码应该不难理解：

void _object_set_associative_reference(id object, const void *key, id value, uintptr_t policy) {
    // 上述步骤1
    DisguisedPtr<objc_object> disguised{(objc_object *)object};
    ObjcAssociation association{policy, value}; // 创建 ObjcAssociation 对象

    association.acquireValue(); // retain新值

    {
        // 上述步骤2
        AssociationsManager manager;
        AssociationsHashMap &associations(manager.get()); 

        if (value) {
            // 上述步骤3
            auto refs_result = associations.try_emplace(disguised, ObjectAssociationMap{});
            if (refs_result.second) { // 如果插入成功，说明object之前不存在关联对象 (否则会插入失败)
                object->setHasAssociatedObjects(); // 所以要标记下object存在关联对象，以便在其dealloc时能够移除关联对象
            }

            /* establish or replace the association */
            auto &refs = refs_result.first->second; // 这一步是获取ObjectAssociationMap
            auto result = refs.try_emplace(key, std::move(association)); // 将key和ObjcAssociation插入到ObjectAssociationMap中
            if (!result.second) { // 如果插入失败，说明key已经设置过ObjcAssociation
                association.swap(result.first->second); // 所以这里将新的ObjcAssociation和旧的ObjcAssociation中的 value和policy 交换一下
            }
        } else {
            // 上述步骤5
            auto refs_it = associations.find(disguised); // 在AssociationsHashMap中，根据object地址查找ObjectAssociationMap
            if (refs_it != associations.end()) { 
                auto &refs = refs_it->second; // 如果找到，则取出ObjectAssociationMap
                auto it = refs.find(key); // 在ObjectAssociationMap中，根据key查找ObjcAssociation
                if (it != refs.end()) {
                    association.swap(it->second); // 如果找到，则将ObjcAssociation对象中的value设为nil
                    refs.erase(it); // 将ObjcAssociation从ObjectAssociationMap中移除
                    if (refs.size() == 0) {
                        associations.erase(refs_it); // 如果ObjectAssociationMap中已经没有元素了，则将其从AssociationsHashMap中删掉
                    }
                }
            }
        }
    }

    association.releaseHeldValue(); // release旧值
}

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

0x2. objc_getAssociatedObject

搂草打兔子，如果objc_setAssociatedObject原理弄清楚了，那么objc_getAssociatedObject不言而喻。直接祭出源码：

id _object_get_associative_reference(id object, const void *key) {
    ObjcAssociation association{};
    {
        AssociationsManager manager;
        AssociationsHashMap &associations(manager.get());
        AssociationsHashMap::iterator i = associations.find((objc_object *)object);
        if (i != associations.end()) {
            ObjectAssociationMap &refs = i->second;
            ObjectAssociationMap::iterator j = refs.find(key);
            if (j != refs.end()) {
                association = j->second;
                association.retainReturnedValue(); // 如果policy包含`OBJC_ASSOCIATION_GETTER_RETAIN`标志位，会对value进行一次retain
            }
        }
    }
    return association.autoreleaseReturnedValue(); // 如果policy包含`OBJC_ASSOCIATION_GETTER_AUTORELEASE`标志位，则对value调用autorelease
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

← KVC 原理 Block 原理 →