iOS 关联对象

概述

关联对象顾名思义，就是给对象关联对象的意思，一个对象可以关联多个其他对象，这些对象通过key来区分，存储对象值时，可以指明“存储策略”，用以维护“内存管理语义”，存储策略由名为objc_AssociationPolicy的枚举所定义，枚举类型如下：

    OBJC_ASSOCIATION_ASSIGN = 0,           /**等效 @property 属性 assign */
    OBJC_ASSOCIATION_RETAIN_NONATOMIC = 1, /**等效 @property 属性 nonatomic, retain*/
    OBJC_ASSOCIATION_COPY_NONATOMIC = 3,   /**等效 @property 属性 nonatomic, copy */
    OBJC_ASSOCIATION_RETAIN = 01401,       /**等效 @property 属性 retain*/
    OBJC_ASSOCIATION_COPY = 01403          /**等效 @property 属性 copy */

可以看出，这些枚举类型涵盖了我们用@property指定存储策略时各种类型（在ARC中strong与retain对应）。
关联对象实现的过程需要用到三个方法，即runtime库中的三个API，如下：

/** 
 * 使用给定的键和关联策略，给指定的对象设置关联值
 * 
 * @param object The source object for the association.
 * @param key The key for the association.
 * @param value The value to associate with the key key for object. Pass nil to clear an existing association.
 * @param policy The policy for the association. For possible values, see “Associative Object Behaviors.”
 */
objc_setAssociatedObject(id _Nonnull object, const void * _Nonnull key, id _Nullable value, objc_AssociationPolicy policy)

/** 
 * 使用给定的对象和关联键，返回关联值
 * 
 * @param object The source object for the association.
 * @param key The key for the association.
 * @return The value associated with the key \e key for \e object.
 */
OBJC_EXPORT id _Nullable
objc_getAssociatedObject(id _Nonnull object, const void * _Nonnull key)

/** 
 * 移除给定对象的所有关联对象
 * 
 * @param object An object that maintains associated objects.
 * @note 这个方法是用于清理对象的所有关联对象的，相当于使一个对象回到“原始状态”，
 * 不能用此方法去删除关联，删除关联应该使用objc_setAccociatedObject()方法,给此方法的value参数传nil就可以删除对应关联对象。
 */
OBJC_EXPORT void
objc_removeAssociatedObjects(id _Nonnull object)

使用场景

通常我们想给一个现有的类添加属性时，一般是创建一个继承自现有类的子类，然后再给子类添加属性，这在开发过程中非常常见，比喻自定义一个tableViewCell的类，它往往就是继承自UITableViewCell类。但是如果给UITableViewCell的category添加属性就行不通了，另外，给一个创建好的UITableViewCell对象添加一个属性，也是行不通的，这个时候关联对象就可以派上用场了。
下面来看看实例，这样会更好理解些。

实例

实例分两个部分，先创建好一个工程，做好准备。

给分类添加属性

给ViewController创建一个名为info的分类，并给这个分类添加一个名为name的NSString类型的属性，如下：

#import "ViewController.h"

NS_ASSUME_NONNULL_BEGIN

@interface ViewController (Info)

@property (nonatomic, copy)NSString *name;

@end

NS_ASSUME_NONNULL_END

编译一下，会发现报如下的警告：

我们知道在分类中是不能添加实例变量，但是可以添加属性，不过添加的属性是不会自动生成setter和getter方法的。

为什么不能添加实例变量呢?
类的内存布局在编译时期就已经确定了，category是运行时才加载的,此时早已经确定了内存布局所以无法添加实例变量，如果添加实例变量就会破坏category的内部布局。

通常setter和getter方法中是要用到属性对应实例变量的，既然分类不能添加实例变量，那又要怎样实现setter和getter方法呢？使用关联对象方法！
直接上代码

#import "ViewController+Info.h"
#import <objc/runtime.h>

@implementation ViewController (Info)

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

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

@end

解释下上面的代码

方法objc_getAssociatedObject()中的第二个参数为什么传“_cmd”?

_cmd是什么？
_cmd是指当前方法的一个SEL类型的指针，SEL可理解成方法选择器 - @selector(),就是取类成员方法的编号,他的行为基本可以等同C语言的中函数指针（函数地址）,只不过C语言中，可以把函数名直接赋给一个函数指针，而Object-C的类不能直接应用函数指针，这样只能做一个@selector语法来取,他的结果是SEL类型，用assgin修饰。

该方法第二个参数的类型为const void * 表示是一个指针，该指针可以指向任意类型的值，但它指向的值必须是常量。刚好_cmd就是一个指针，指向的是当前方法的编号，是个常量，所以传_cmd没毛病。传_cmd的一个好处就是即保证唯一性又不需要声明参数。

方法objc_setAssociatedObject()中的第四个参数为什么要传OBJC_ASSOCIATION_COPY_NONATOMIC？

因为在添加name属性的时候使用的是(nonatomic, copy)修饰的，所以对应的存储策略就应该是OBJC_ASSOCIATION_COPY_NONATOMIC。

下面使用一下在分类中创建的属性name

self.name = @"我是大厦";
NSLog(@"%@",self.name);

编译、运行，结果如下：

2019-02-15 17:21:39.565185+0800 Classes[23957:5481755] 我是大厦

这就是在分类中通过关联对象的方式添加属性的例子。

给对象添加属性

如果没有分类，没有继承父类的子类，直接给某个系统的类的一个对象添加属性，该怎么办呢？先看下面代码

    UISwitch *swit = [[UISwitch alloc] initWithFrame:CGRectMake(10, 100, 200, 50)];
    [self.view addSubview:swit];
    [swit addTarget:self action:@selector(switAction:) forControlEvents:(UIControlEventValueChanged)];

如果要想给swit对象添加属性，可以通过关联对象来实现，在这里给swit对象关联一个block对象和NSString 类型的对象，代码如下：

#import "ViewController.h"
#import "ViewController+Info.h"
#import <objc/runtime.h>

// 声明关联键
const void *associatedBlockKey = @"dd";
const void *associatedTypeKey = @"ss";

@interface ViewController ()

@end

@implementation ViewController


- (void)viewDidLoad {
    [super viewDidLoad];
    
    UISwitch *swit = [[UISwitch alloc] initWithFrame:CGRectMake(10, 100, 200, 50)];
    [self.view addSubview:swit];
    [swit addTarget:self action:@selector(switAction:) forControlEvents:(UIControlEventValueChanged)];
    
    // 创建要关联的对象值
    void (^block)(BOOL isOn) = ^(BOOL isOn){
        NSLog(@"%d",isOn);
    };
    NSString *type = @"love";
    
    // 设置关联
    objc_setAssociatedObject(swit, associatedBlockKey, block, OBJC_ASSOCIATION_COPY_NONATOMIC);
    objc_setAssociatedObject(swit, associatedTypeKey, type, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}

然后使用关联对象，在事件方法中使用：

-(void)switAction:(UISwitch*)sender{
    void (^block)(BOOL isOn) = objc_getAssociatedObject(sender, associatedBlockKey);
    block(sender.isOn);
    NSString *tempType = objc_getAssociatedObject(sender, associatedTypeKey);
    NSLog(@"%@",tempType);
}

编译运行，触发开关的一开一关操作，打印结果如下：

2019-02-15 17:35:58.277116+0800 Classes[24171:5507080] 1
2019-02-15 17:35:58.277282+0800 Classes[24171:5507080] love
2019-02-15 17:35:59.280377+0800 Classes[24171:5507080] 0
2019-02-15 17:35:59.280512+0800 Classes[24171:5507080] love

可以看出，swit对象关联对象后，每次操作开关，都可以获取到关联对象的值。到这一步就完成了对象关联对象的操作。

有点需要注意，既然是关联对象，就只能关联对象，所以如果关联的不是对象，比喻关联NSInteger类型的值，就不可以，会报错。

总结

关联对象的实现用到了三个方法，分别是：

objc_setAssociatedObject
objc_getAssociatedObject
objc_removeAssociatedBbjects

关联对象一般来说用在两种场景，即：

给分类添加属性
给对象添加关联对象

虽然关联对象有一定的实用性，但是需要注意，在实际场景中不常用到关联对象，因为它有一定的弊端，如果滥用，代码容易失控，而且代码可读性要相对差些，最主要是出了bug 也不好找，为什么这么说呢？仔细想一下，关联的对象，在运行时才会被关联，只有被关联后，才确定其内存管理语义，这样的话，在关联对象大量使用时出现bug后，排查问题的难度大大增加。所以如果有别的办法可以用，就不要选择使用关联对象。