iOS分类添加成员变量和关联对象详解

一、背景

因为分类的底层结构不能添加成员变量，要想实现成员变量的效果，可以使用runtime关联对象去实现

---

二、分类不能添加成员变量的原因

• 有个问题需要注意下，分类是能声明属性，但是不能添加成员变量，这个很容易混淆。
  
  但是在分类里是不一样的，在声明属性在分类里，不会自动添加成员变量，也不会自动实现set和get方法。
  
  在分类中添加成员变量会报Instance variables may not be placed in categories实例变量不能放在类别中的错误
  

  1-1.png

• 分类底层结构

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;
    // Fields below this point are not always present on disk.
    struct property_list_t *_classProperties;

    method_list_t *methodsForMeta(bool isMeta) {
        if (isMeta) return classMethods;
        else return instanceMethods;
    }

    property_list_t *propertiesForMeta(bool isMeta, struct header_info *hi);
};

从分类的底层结构中可以看到，底层结构中有存放实例方法、类方法、协议和属性的地方，但是没有存放成员变量的地方，所以从底层结构上就决定了无法添加成员变量。

---

三、runtime关联对象实现分类添加成员变量的效果

• 关联对象API
  添加关联对象

void objc_setAssociatedObject(id object, const void * key,
                                    id value, objc_AssociationPolicy policy)

第一个参数：填为哪个对象去添加关联对象的(一般填self)
第二个参数：关联对象的key，后面获取关联对象就是根据这个key去获取的
第三个参数：关联对象的值
第四个参数：关联对象策略

typedef OBJC_ENUM(uintptr_t, objc_AssociationPolicy) {
OBJC_ASSOCIATION_ASSIGN = 0, // assign
OBJC_ASSOCIATION_RETAIN_NONATOMIC = 1, // strong, nonatomic
OBJC_ASSOCIATION_COPY_NONATOMIC = 3, // copy, nonatomic
OBJC_ASSOCIATION_RETAIN = 01401, // strong, atomic
OBJC_ASSOCIATION_COPY = 01403 // copy, atomic
};

• 获取关联对象

id objc_getAssociatedObject(id object, const void * key)

第一个参数：需要关联对象的对象
第二个参数：关联对象的key，跟添加关联对象时一样的

• 移除关联对象

void objc_removeAssociatedObjects(id object)

参数：需要关联对象的对象

• 实现关联对象添加成员变量效果
  1、先在分类中添加头文件#import <objc/runtime.h>
  2、在分类中声明属性
  3、在分类中实现set和get方法

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

- (NSString *)name
{
    return objc_getAssociatedObject(self, @selector(name));
}

这样就能实现为分类添加成员变量的效果了

---

四、关联对象原理

• 关联对象存放在哪
  关联对象并不是像本类的成员变量保存在本类中，因为分类底层结构中没有存放的地方，关联对象是存放在全局的AssociationsManager中。
• AssociationsManager中有个AssociationsHashMap类似于字典一样的结构

class AssociationsManager {
    // associative references: object pointer -> PtrPtrHashMap.
    static AssociationsHashMap *_map;
public:
    AssociationsManager()   { AssociationsManagerLock.lock(); }
    ~AssociationsManager()  { AssociationsManagerLock.unlock(); }
    
    AssociationsHashMap &associations() {
        if (_map == NULL)
            _map = new AssociationsHashMap();
        return *_map;
    }
};

• AssociationsHashMap中以需要关联对象的对象为key(关联对象的一个参数)，保存中这个对象的所有被关联的属性，value为ObjectAssociationMap

    class AssociationsHashMap : public unordered_map<disguised_ptr_t, ObjectAssociationMap *, DisguisedPointerHash, DisguisedPointerEqual, AssociationsHashMapAllocator> {
    public:
        void *operator new(size_t n) { return ::malloc(n); }
        void operator delete(void *ptr) { ::free(ptr); }
    };

• ObjectAssociationMap中是已添加关联对象的key值作为key值的，value为ObjcAssociation，而ObjcAssociation里是包含了关联对象的值和关联策略

class ObjectAssociationMap : public std::map<void *, ObjcAssociation, ObjectPointerLess, ObjectAssociationMapAllocator>

1-2.png