第10条:在既有类中使用关联对象存放自定义数据

2017/7/5 posted in  第二章 对象,消息,运行期

有时需要在对象中存放相关信息。这时我们通常会从对象所属的类中继承一个子类,然后改用这个子类对象。然而并非所有情况下都能这么做,有时候类的实例可能是由某种机制所创建的,而开发者无法令这种机制创建出自己所写的子类实例

Objective-C中有一项强大的特性可以解决此问题,这就是“关联对象"(Associated Object)

可以给某对象关联许多其他对象,这些对象通过“键”来区分.存储对象值的时候,可以指明“存储策略”(storage policy),用以维护相应的“内存管理语义”。存储策略由名为Objc_ASSOCiationPolicy的枚举所定义,下表列出了该枚举的取值,同时还列出了与之等效属性:假如关联对象成为了属性,那么它就会具备对应的语义(第6条详解了“属性”这个概念).

关联类型 等效的@property属性
OBJC_ASSOCIATION_ASSIGN assign
OBJC_ASSOCIATION_RETAIN_NONATOMIC nonatomic, retain
OBJC_ASSOCIATION_COPY_NONATOMIC nonatomic, copy
OBJC_ASSOCIATION_RETAIN retain
OBJC_ASSOCIATION_COPY copy

下列方法可以管理关联对象:

  • void objc_setAssociatedObject ( id object, void*key, id value, objc AssociationPolicypolicy)
    此方法以给定的键和策略为某对象设置关联对象值。

  • id objc_getAssociatedObject(id object, void*key)
    此方法根据给定的键从某对象中获取相应的关联对象值。

  • void objc removeAssociatedObjects(id object)
    此方法移除指定对象的全部关联对象。

我们可以把某对象想象成NSDictionary,把关联到该对象的值理解为字典中的条目,于是,存取关联对象的值就相当于在NSDictionary对象上调用[object setObject:value forKey:key][object objectForKey:key]方法。然而两者之间有个重要差别:设置关联对象时用的键(key)是个"不透明的指针"(opaque pointer)”。如果在两个键上调用“isEqual:”方法的返回值是YES,那么NSDictionary就认为二者相等;然而在设置关联对象值时,若想令两个键匹配到同一个值,则二者必须是完全相同的指针才行。鉴于此,在设置关联对象值时,通常使用静态全局变量做键

关联对象用法举例

开发iOS时经常用到UIAlertView类,该类提供了一种标准视图,可向用户展示警告信息.当用户按下按钮关闭该视图时,需要用委托协议(delegate protocol)来处理此动作,但是,要想设置好这个委托机制,就得把创建警告视图和处理按钮动作的代码分开。由于代码分作两块,所以读起来有点乱。比方说,我们在使用UIAlertView时,一般都会这么写:

-(void)askUserAQuestion{
    UIAlertView *alert = [[UIAlertView alloc]
                            initWithTitle:@"Question"
                                  message:@"What do you want to do?"
                                 delegate:self
                        cancelButtonTitle:@"Cancel"
                        otherButtonTitles:@"Continue", nil];
        [alert show];
}

// UIAlertViewDelegate protocol method
-(void)alertView:(UIAlertView *)alertView
        clickedButtonAtlndex:(NSInteger)buttonIndex
{
    if (buttonlndex == 0) {
        [self doCancel];
    } else {
        [self doContinue];
    }
}

如果想在同一个类里处理多个警告信息视图,那么代码就会变得更为复杂,我们必须在 delegate方法中检査传人的alertView参数,并据此选用相应的逻辑。要是能在创建警告视图的时候直接把处理每个按钮的逻辑都写好,那就简单多了。这可以通过关联对象来做。创建完警告视图之后,设定一个与之关联的"块"(block),等到执行delegate方法时再将其读出来。此方案的实现代码如下:


#import <objc/runtime.h>

static void *EOCMyAlertViewKey = "EOCMyAlertViewKey";

-(void)askUserAQuestion {
    UIAlertView *alert = [[UIAlertViewalloc]
                            initWithTitle:@"Question"
                                  message: @"What do you want to do?"
                                 delegate:self
                        cancelButtonTitle: @"Cancel",
                        otherButtonTitles: @"Continue", nil];
        void (^block)(NSInteger) = ^(NSInteger buttonIndex){
            if (buttonlndex == 0) {
                [self doCancel];
            }else {
                [self doContinue];
            }
        };
        objc_setAssociatedObject(alert,
                                 EOCMyAlertViewKey,
                                 block,
                                 OBJC_ASSOCIATION_COPY);
        [alert show];
}

// UIAlertViewDelegate protocol method
-(void)alertView:(UIAlertView*)alertView
       clickedButtonAtIndex:(NSInteger)buttonIndex
{
    void (^block)(NSInteger)=
        objc_getAssociatedObject(alertView, EOCMyAlertViewKey);
    block(buttonIndex);
}


以这种方式改写之后,创建警告视图与处理操作结果的代码都放在一起了,这样比原来更易读慷,因为我们无须在两部分代码之间来回游走,即可明白警告视图的用处。但是,采用该方案时需注意:块可能要捕获(capture)某些变量,这也许会造成“保留环”(retain cycle)。第40条详述了此问题。

正如大家所见,这种做法很有用,但是只应该在其他办法行不通时才去考虑用它。若是
滥用,则很快就会令代码失控,使其难于调试。
“保留环”产生的原因很难査明,因为关联对象之间的关系并没有正式的定义(formal definition),其内存管理语义是在关联的时候才定义的,而不是在接口中预先定好的。使用这种写法时要小心,不能仅仅因为某处可以用该写法就一定要用它。想创建这种UIAlertView还有个办法,那就是从中继承子类,把块保存为子类中的属性。笔者认为:若是需要多次用到alert视图,那么这种做法比使用关联对象要好。

要点

  • 可以通过"关联对象"机制来把两个对象连起来
  • 定义关联对象时可指定内存管理语义,用以模仿定义属性时所采用的“拥有关系”与“非拥有关系”。
  • 只有在其他做法不可行时才应选用关联对象,因为这种做法通常会引入难于査找的bug。