runtime - 关联对象

遇到这样一个问题：“如何給NSArray添加一个属性（不能使用继承）”，筒子立马蒙逼了，不能用继承，难道用分类？但是分类貌似只能添加方法不能添加属性啊，筒子百思不得其解，直到后来接触到了runtime才恍然大悟。

什么是关联对象

关联对象是指某个OC对象通过一个唯一的key连接到一个类的实例上。
举个例子：xiaoming是Person类的一个实例，他的dog（一个OC对象）通过一根绳子（key）被他牵着散步，这可以说xiaoming和dog是关联起来的，当然xiaoming可以牵着多个dog。

怎样关联对象

runtime提供給我们的方法：

//关联对象
void objc_setAssociatedObject(id object, const void *key, id value, objc_AssociationPolicy policy)
//获取关联的对象
id objc_getAssociatedObject(id object, const void *key)
//移除关联的对象
void objc_removeAssociatedObjects(id object)

变量说明：

id object：被关联的对象（如xiaoming）
const void *key：关联的key，要求唯一
id value：关联的对象（如dog）
objc_AssociationPolicy policy：内存管理的策略

objc_AssociationPolicy policy的enum值有：

OBJC_ASSOCIATION_ASSIGN = 0,          
OBJC_ASSOCIATION_RETAIN_NONATOMIC = 1, 
OBJC_ASSOCIATION_COPY_NONATOMIC = 3,  
OBJC_ASSOCIATION_RETAIN = 01401,       
OBJC_ASSOCIATION_COPY = 01403

*  OBJC_ASSOCIATION_ASSIGN  
            等价于@property (assign) ，
                 @property (unsafe_unretained)
            弱引用关联对象
         
*  OBJC_ASSOCIATION_RETAIN_NONATOMIC
            等价于@property (strong, nonatomic)
            强引用关联对象，且为非原子操作
         
*  OBJC_ASSOCIATION_COPY_NONATOMIC
            等价于@property (copy, nonatomic)
            复制关联对象，且为非原子操作
         
         
 *  OBJC_ASSOCIATION_RETAIN
            等价于@property (strong, atomic)
            强引用关联对象，且为原子操作
         
*  OBJC_ASSOCIATION_COPY
            等价于@property (copy, atomic)
            复制关联对象，且为原子操作
         
其中，第 2 种与第 4 种、第 3 种与第 5 种关联策略的唯一差别就在于操作是否具有原子性。

objc_setAssociatedObject(button, buttonKey, _imgView, OBJC_ASSOCIATION_RETAIN_NONATOMIC);

当对象被释放时，会根据这个策略来决定是否释放关联的对象，当策略是RETAIN/COPY时，会释放（release）关联的对象，当是ASSIGN，将不会释放。
值得注意的是，我们不需要主动调用removeAssociated来接触关联的对象，如果需要解除指定的对象，可以使用setAssociatedObject置nil来实现。

关联对象的应用

1、添加公共属性

这是最常用的一个模式，通常我们会在类声明里面添加属性，但是出于某些需求（如前言描述的情况），我们需要在分类里添加一个或多个属性的话，编译器就会报错，这个问题的解决方案就是使用runtime的关联对象。
应用举例：
我们需要自定义一个tabbar，并暴露公共的属性和方法。（读者们可以思考下使用继承和分类实现的优点和不足之处）

@interface UITabBarController (Custom)

@property (nonatomic, strong) SUCustomTabbar * customTabbar;

@end

#import "UITabBarController+Custom.h"
#import <objc/runtime.h>

@implementation UITabBarController (Custom)

- (void)setCustomTabbar:(UIView *)customTabbar {
    //这里使用方法的指针地址作为唯一的key
    objc_setAssociatedObject(self, @selector(customTabbar), customTabbar, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}

- (UIView *)customTabbar {
    return objc_getAssociatedObject(self, @selector(customTabbar));
}

//其他方法...

@end

这样，我们就可以像原生的tabbar一样使用自定义的tabbar：

[self.tabBarController.customTabbar doSomgthig];

2、添加私有成员变量

有时候，需要在分类中添加不想暴露在公共声明的成员变量。
应用举例：給按钮添加点击时间的回调

@interface UIButton (Callback)

- (instancetype)initWithFrame:(CGRect)frame callback:(void (^)(UIButton *))callbackBlock;

@end

@interface UIButton ()

@property (nonatomic, copy) void (^callbackBlock)(UIButton * button);

@end

@implementation UIButton (Callback)

- (void (^)(UIButton *))callbackBlock {
    return objc_getAssociatedObject(self, @selector(callbackBlock));
}

- (void)setCallbackBlock:(void (^)(UIButton *))callbackBlock {
    objc_setAssociatedObject(self, @selector(callbackBlock), callbackBlock, OBJC_ASSOCIATION_COPY_NONATOMIC);
}

- (instancetype)initWithFrame:(CGRect)frame callback:(void (^)(UIButton *))callbackBlock {

    if (self = [super initWithFrame:frame]) {
        self.callbackBlock = callbackBlock;
        [self addTarget:self action:@selector(didClickAction:) forControlEvents:UIControlEventTouchUpInside];
    }
    return self;
}

- (void)didClickAction:(UIButton *)button {
    self.callbackBlock(button);
}

@end

以上代码是否会存在内存管理的问题？

会的，有内存泄漏问题，因为UIButton的实例持有callbackBlock这个block，在button的点击事件中这个block又持有了button本身，造成引用循环，会造成内存泄露。开发中要避免这个问题。

3、关联KVO观察者

有时候我们在分类中使用KVO，推荐使用关联的对象作为观察者，尽量避免对象观察自身。
此应用模式不再举例，有兴趣的读者可以自行深入研究，或者将代码贴到评论处。

下面就以UIAlertView为例子简单介绍一下使用方法

使用场景：在UITableView中点击某一个cell，这时候弹出一个UIAlertView，然后在UIAlertView消失的时候获取此cell的信息，我们就获取cell的indexPath

第一步：

#import <objc/runtime.h>
static char kUITableViewIndexKey;
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
{
......
UIAlertView *alert = [[UIAlertView alloc] initWithTitle:@"提示"
                                                message:@"这里是xx楼"
                                               delegate:self
                                      cancelButtonTitle:@"好的"
                                      otherButtonTitles:nil];
//然后这里设定关联，此处把indexPath关联到alert上
objc_setAssociatedObject(alert, &kUITableViewIndexKey, indexPath, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
[alert show];

}

第二步：

- (void)alertView:(UIAlertView *)alertView clickedButtonAtIndex:(NSInteger)buttonIndex
{
    if (buttonIndex == 0) {
    NSIndexPath *indexPath = objc_getAssociatedObject(alertView, &kUITableViewIndexKey);
    NSLog(@"%@", indexPath);
    }
}