iOS关联对象的源码探究

本文探究问题:
- 怎么通过关联对象为分类category添加成员变量?
- 添加的成员变量被存储在哪了?

1.为分类(category)添加成员变量

我们都知道直接往分类中添加属性,只是声明了相应的setter/getter方法,并没有添加相应的成员变量到分类中,但有时候我们会有这样的需求,苹果为我们提供了相应的方法:通过关联对象来添加成员变量.

#import 
@interface UIView (MYView)
//为分类添加属性url
@property(nonatomic,copy)NSString *url;
@end
#import "UIView+MYView.h"
#import //要导入头文件
#define MYKEY @"urlStr"
@implementation UIView (MYView)
//关联对象 添加属性
//getter方法中
- (NSString *)url
{
    //objc_getAssociatedObject(id  _Nonnull object, const void * _Nonnull key)
    //object 要获取属性的对象
    //key    属性的名字
   return objc_getAssociatedObject(self,MYKEY );
}
//setter方法中
- (void)setUrl:(NSString *)url
{
    //objc_setAssociatedObject(id  _Nonnull object, const void * _Nonnull key, id  _Nullable value, objc_AssociationPolicy policy)
    //object 要添加属性的对象
    //key    属性的名称
    //value  属性的值
    //policy 属性修饰符
    return  objc_setAssociatedObject(self, MYKEY, url, OBJC_ASSOCIATION_COPY_NONATOMIC);
}

@end

如果要移除对象的关联对象,可以通过下面的方式

//移除指定对象所有的关联对象
objc_removeAssociatedObjects(id _Nonnull object)

2.关联对象底层源码分析

说明:本文使用到的runtime源码版本为objc4-756.2
在objc-runtime.mm文件中可以找到关联对象方法的实现

#pragma mark -  关联对象方法
/**********************************************************************
* Associative Reference Support
**********************************************************************/
id objc_getAssociatedObject(id object, const void *key) {
    return _object_get_associative_reference(object, (void *)key);
}

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

void objc_removeAssociatedObjects(id object) 
{
    if (object && object->hasAssociatedObjects()) {
        _object_remove_assocations(object);
    }
}

重点看objc_setAssociatedObject方法的实现,它调用了函数 _object_set_associative_reference

void _object_set_associative_reference(id object, void *key, id value, uintptr_t policy) {
    // This code used to work when nil was passed for object and key. Some code
    // probably relies on that to not crash. Check and handle it explicitly.
    // rdar://problem/44094390
    if (!object && !value) return;//判空
    
    assert(object);
    
    if (object->getIsa()->forbidsAssociatedObjects())
        _objc_fatal("objc_setAssociatedObject called on instance (%p) of class %s which does not allow associated objects", object, object_getClassName(object));
    
    // retain the new value (if any) outside the lock.
    ObjcAssociation old_association(0, nil);
    //acquireValue函数根据policy对对象value发送相应的retain或者copy消息
    id new_value = value ? acquireValue(value, policy) : nil;
    {
        //关联对象管理类,C++ 实现的一个类
        AssociationsManager manager;
        //获取维护一个HashMap,可以理解为是一个字典
        //============
        //是一个全局容器
        //============
        AssociationsHashMap &associations(manager.associations());
        //根据传进来的object 对指针地址按位取反,作为全局容器中每一个对象的key或者说是唯一标识
        disguised_ptr_t disguised_object = DISGUISE(object);
        if (new_value) {
            // break any existing association.
            //根据对象指针查找对应的一个ObjectAssociationMap结构的map
            AssociationsHashMap::iterator i = associations.find(disguised_object);
            if (i != associations.end()) {//map找到的情况 即不是第一次添加关联对象
                // secondary table exists
                ObjectAssociationMap *refs = i->second;
                ObjectAssociationMap::iterator j = refs->find(key);
                //根据传递进来的key查找,如果查找到了key,把原来的值替换为新传进来的value
                if (j != refs->end()) {
                    old_association = j->second;
                    j->second = ObjcAssociation(policy, new_value);
                } else {
                    //如果没有key,在ObjectAssociationMap中添加对应的key 及由value和policy封装成的ObjcAssociation
                    (*refs)[key] = ObjcAssociation(policy, new_value);
                }
            } else {//map未找到的情况
                // create the new association (first time).
                //之前没有添加过关联对象 创建一个ObjectAssociationMap对象
                ObjectAssociationMap *refs = new ObjectAssociationMap;
                //把ObjectAssociationMap值作为value,添加到以object为对应键的AssociationsHashMap中
                associations[disguised_object] = refs;
                (*refs)[key] = ObjcAssociation(policy, new_value);
                object->setHasAssociatedObjects();//设置对象有了关联对象
            }
            /*
          全局容器结构:
                         AssociationsHashMap
                ----------------------------------------
                DISGUISE(object)  | ObjectAssociationMap
         
         对象关联map结构 :      
                       ObjectAssociationMap
                 -----------------------------------
                 @selector(url) | ObjectAssociation
             
           ObjectAssociation封装结构:
                        ObjectAssociation
                |-------------------------------|
                |          value                |
                |-------------------------------|
                |OBJC_ASSOCIATION_COPY_NONATOMIC|
                |-------------------------------|
             */
            
        } else {//传递值为空的情况
            // setting the association to nil breaks the association.
            //
            //根据对象object获取 对象关联map
            AssociationsHashMap::iterator i = associations.find(disguised_object);
            if (i !=  associations.end()) {//如果获取到了 对象的关联map
                ObjectAssociationMap *refs = i->second;
                //根据key查找,如果有 进行檫除操作
                ObjectAssociationMap::iterator j = refs->find(key);
                if (j != refs->end()) {
                    old_association = j->second;
                    refs->erase(j);//檫除操作
                    //想要删除一个已经被关联到对象上的值时,可以通过把value传为nil来实现
                }
            }
        }
    }
    // release the old value (outside of the lock).
    if (old_association.hasValue()) ReleaseValue()(old_association);
}

从上面的源码可以分析出:

1.关联对象由AssociationsManager管理,并在AssociationsHashMap存储
2.所有对象的关联内容都在同一个全局容器中(为不同的类添加的成员变量都在这个全局容器里),在全局容器中通过DISGUISE(object) 来唯一标识对象object的关联内容.
3.如果要删除一个关联对象被关联的值,可以把value值传为nil,key对应的值会被擦除.

你可能感兴趣的:(iOS关联对象的源码探究)