×

Objective-C Runtime之关联对象

96
周鶏
2016.12.26 16:14* 字数 1478

文章也同时在个人博客 http://kimihe.com/更新

引言

最近在补习《Effective Objective-C 2.0》。其中涉及到部分OC runtime的知识,runtime是OC的一个重要特性,掌握它对于理解OC有着巨大的帮助,也能够提升我们的开发能力。

OC的runtime可以将我们的程序在运行期进行一系列控制,表象看起来如同我们可以动态修改正在运行的程序。我将其视为OC语法的封装 -> C高级API的转化魔法,因为在最终,我们的程序还是会被翻译成是C(以及C++)的样式。在C的层面上,我们或许能够忽略runtime这种说法,毕竟C几乎可以做任何事情。

可以说,如果你了解runtime的设计理念,你将可以亲手用C实现一个类,包含一些最基本的面相对象的特性。runtime也是开源的,有兴趣不妨学习一下。

我们平时在学习OC时,可能都听说过Category的作用,可以拆分代码,增加方法等等。不过在一般意义下无法增加实例变量,这可能会阻碍我们实现一些有趣的idea,但是runtime可以非常简单地跨过这个限制,将我们带入OC特性的更深层次。

本文将通过一个非常简单的Demo,来演示runtime中关联对象的作用。我们修改UIAlertView,给它增加一个传入ActionBlock的方法,我们可以直接在ActionBlock中编写逻辑代码,避免了在相关protocol的方法中进行操作的繁杂。虽然UIAlertView在iOS9.0后被UIAlertController代替,但却非常适合用于教学演示。

好书推荐

《Effective Objective-C 2.0》是一本非常适合深入学习OC内涵的书,很多开发中的疑惑都可以在书中找到较为科学的解答。不过,这本书需要一定的iOS开发积累,可能不适合初学者。

代码地址

https://github.com/kimihe/KMiOSLib/tree/master/ObjcRuntimeResearch/UIAlertViewMagic

原理详解

思路

我们的目的很明确,给UIAlertView增加可以传入逻辑代码块的ActionBlock接口,这样我们就不需要把这些代码写在相关protocol的方法中了,使代码更加集中,便于理解和管理。我们的思路如下:

  • 通过Category来扩充这个UIAlertView类。
  • 遵循“勿在分类中声明属性”这一原则,不声明ActionBlock的@property,而是直接提供一个setup方法。
  • 通过runtime的objc_associatedObject来“变相”给分类增加实例变量,即把我们要增加的实例变量(ActionBlock)关联到UIAlerView分类

实现

我们新增一个分类UIAlertView+ActionBlock,在头文件中声明我们的ActionBlock类型,并增加一个传block的方法。

#import <UIKit/UIKit.h>

typedef void(^ActionBlock)(UIAlertView*, NSInteger);

@interface UIAlertView (ActionBlock) <UIAlertViewDelegate>

/**
 设置一个ActionBlock

 @param action 需要传入的block
 */
- (void)setupActionBlock:(ActionBlock)action;

@end

在实现文件中我们只需要实现两个模块,一是完成关联对象,二是在何时的时机调用外部传入的ActionBlock。

完成关联对象

在我们添加的方法中,利用runtime完成关联对象,变相存储外部传入的block,如下:

static const void *KMAlertViewKey = "KMAlertViewKey";
...
- (void)setupActionBlock:(ActionBlock)action
{
    objc_setAssociatedObject(self, KMAlertViewKey, action, OBJC_ASSOCIATION_COPY_NONATOMIC);
    self.delegate = self;
}
...

代码就只有两行,第一行是设置关联对象,把传入的block(action)关联到self(UIAlerView分类),其中的KMAlertViewKey是一个唯一区分标识符,类似于字典的键,以此来寻找我们关联的对象。OBJC_ASSOCIATION_COPY_NONATOMIC是内存管理语义,我们强调:block通过copy存放在堆上。

第二行重新覆盖delegate,将其引导至本实现文件中,从而实现protocol的方法,并适时进行ActionBlock的调用。

调用ActionBlock

经过上述的delegate重定向,我们可以拦截相关方法,并在其中调用ActionBlock,完成外部传入的逻辑代码,如下:

- (void)alertView:(UIAlertView *)alertView clickedButtonAtIndex:(NSInteger)buttonIndex
{
    ActionBlock action = objc_getAssociatedObject(self, KMAlertViewKey);
    action(alertView, buttonIndex);
}

和设置关联对象一样,代码的第一行,我们取出分类关联的ActionBlock。然后在代码的第二行进行调用。

使用演示

ViewController.m中进行使用,代码如下:

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    
    UIAlertView *alert = [[UIAlertView alloc]initWithTitle:@"Title" message:@"Message" delegate:self cancelButtonTitle:@"Cancel" otherButtonTitles:@"OK", nil];
    [alert setupActionBlock:^(UIAlertView *alertView, NSInteger buttonIndex) {
        NSLog(@"You did click button index %ld", (long)buttonIndex);
    }];
    [alert show];
}

注意,我们在生成一个alert时会声明其delegate,但是当执行到后续的setupActionBlock:方法时,我们其实会覆盖这个delegate,将其引导至新增的分类中,所以在使用时,我们可以完全不编写相关的protocol方法,而是直接在block中传入逻辑代码。

运行一下,点击alert的OK按钮,控制台输出符合预期:

2016-12-26 16:05:53.776 UIAlertViewMagic[2082:70283] You did click button index 1

总结

本文通过给UIAlertView增加一个actionBlock回调,演示了OC runtime的“关联对象”(objc_associatedObject)的功能。算是对OC runtime的涉猎。

要点

  • iOS9.0后,你应该使用UIAlertController,弃用UIAlerView!
  • 代码主要讲解了如何使用runtime的objc_associatedObject,模拟部分UIAlertController的功能,使用了category来增加一个方法,但在实际开发中,还是建议通过继承使用子类来实现。毕竟category中增加实例变量属于一种trick技巧。
  • 我们需要一个内部block来存储外部传进来的action,但是category无法在一般意义上增加实例变量, 因此可以使用runtime魔法实现。
  • 我们依旧遵照“勿在分类中声明属性”这一原则,不声明void (^block)(UIAlertView*, NSInteger)的@property,直接提供一个setup方法。

参考文献

KimiTalk
Web note ad 1