面向切面编程

Aspect Oriented Programming (AOP，面向切面编程) 在 Objective-C 社区内没有那么有名，但是 AOP 在运行时可以有巨大威力。 但是因为没有事实上的标准，Apple 也没有开箱即用的提供，也显得不重要，开发者都不怎么考虑它。

引用 Aspect Oriented Programming 维基页面:

An aspect can alter the behavior of the base code (the non-aspect part of a program) by applying advice (additional behavior) at various join points (points in a program) specified in a quantification or query called a pointcut (that detects whether a given join point matches). (一个切面可以通过在多个 join points 中附加的行为来改变基础代码的行为(程序的非切面的部分) )

在 Objective-C 的世界里，这意味着使用运行时的特性来为指定的方法追加 切面 。切面所附加的行为可以是这样的：

  • 在类的特定方法调用前运行特定的代码
  • 在类的特定方法调用后运行特定的代码
  • 增加代码来替代原来的类的方法的实现

有很多方法可以达成这些目的，但是我们没有深入挖掘，不过它们主要都是利用了运行时。 Peter Steinberger 写了一个库，Aspects 完美地适配了 AOP 的思路。我们发现它值得信赖以及设计得非常优秀，所以我们就在这边作为一个简单的例子。

对于所有的 AOP库，这个库用运行时做了一些非常酷的魔法，可以替换或者增加一些方法（比 method swizzling 技术更有技巧性）

Aspect 的 API 有趣并且非常强大：

  1. + (id<AspectToken>)aspect_hookSelector:(SEL)selector
  2.                       withOptions:(AspectOptions)options
  3.                        usingBlock:(id)block
  4.                             error:(NSError **)error;
  5. - (id<AspectToken>)aspect_hookSelector:(SEL)selector
  6.                       withOptions:(AspectOptions)options
  7.                        usingBlock:(id)block
  8.                             error:(NSError **)error;

比如，下面的代码会对于执行 MyClass 类的 myMethod: (实例或者类的方法) 执行块参数。

  1. [MyClass aspect_hookSelector:@selector(myMethod:)
  2.                  withOptions:AspectPositionAfter
  3.                   usingBlock:^(id<AspectInfo> aspectInfo) {
  4.             ...
  5.         }
  6.                        error:nil];

换一句话说：任意的 MyClass 类型的对象(或者是类型本身当这个 @selector 方法为类方法时)的 @selector 方法执行完后，就会执行这个代码中块参数所提供的代码。

我们为 MyClass 类的 myMethod: 方法增加了切面。

通常 AOP 被用来实现横向切面。统计与日志就是一个完美的例子。

下面的例子里面，我们会用AOP用来进行统计。统计是iOS项目里面一个热门的特性，有很多选择比如 Google Analytics, Flurry, MixPanel, 等等.

大部分统计框架都有教程来指导如何追踪特定的界面和事件，包括在每一个类里写几行代码。

在 Ray Wenderlich 的博客里有 文章 和一些示例代码，通过在你的 view controller 里面加入 Google Analytics 进行统计。

  1. - (void)logButtonPress:(UIButton *)button {
  2.     id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker];
  3.     [tracker send:[[GAIDictionaryBuilder createEventWithCategory:@"UX"
  4.                                                           action:@"touch"
  5.                                                            label:[button.titleLabel text]
  6.                                                            value:nil] build]];
  7. }

上面的代码在按钮点击的时候发送了特定的上下文事件。但是当你想追踪屏幕的时候会变得很糟。

  1. - (void)viewDidAppear:(BOOL)animated {
  2.     [super viewDidAppear:animated];
  4.     id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker];
  5.     [tracker set:kGAIScreenName value:@"Stopwatch"];
  6.     [tracker send:[[GAIDictionaryBuilder createAppView] build]];
  7. }

对于大部分有经验的iOS工程师，这看起来不是很好的代码。我们让 view controller 变得更糟糕了。因为我们加入了统计事件的代码，但是它不是 view controller 的职能。你可以反驳，因为你通常有特定的对象来负责统计追踪，并且你将代码注入了 view controller ，但是无论你隐藏逻辑，问题仍然存在 ：你最后还是在viewDidAppear: 后插入了代码。

我们可以在类的 viewDidAppear: 方法上使用 AOP 来追踪屏幕，并且我们可以使用同样的方法在其他我们感兴趣的方法上添加事件追踪。比如当用户点击某个按钮时(比如:一般调用对应的 IBAction).

方法很简洁且不具侵入性：

  • view controller 不会被不属于它的代码污染
  • 为所有加入到我们代码的切面指定一个 SPOC 文件 (single point of customization)提供了可能
  • SPOC 应该在 App 刚开始启动的时候用来添加切面
  • 如果SPOC文件异常,至少有一个 selector 或者 类 识别不出来，应用将会在启动时崩溃(对我们来说这很酷).
  • 公司负责统计的团队通常会提供统计文档，罗列出需要追踪的事件。这个文档可以很容易映射到一个 SPOC 文件。
  • 追踪逻辑抽象化之后，扩展到很多其他统计框架会很方便
  • 对于屏幕视图，对于需要定义 selector 的方法，只需要在 SPOC 文件修改相关的类（相关的切面会加入到 viewDidAppear: 方法）。如果要同时发送屏幕视图和事件，需要（依靠统计提供方）提供一个追踪的标示或者可能还需要提供其他的元信息。

我们可能希望一个 SPOC 文件类似下面的（同样的一个 .plist 文件会适配）

  1. NSDictionary *analyticsConfiguration()
  2. {
  3.     return @{
  4.         @"trackedScreens" : @[
  5.             @{
  6.                 @"class" : @"ZOCMainViewController",
  7.                 @"label" : @"Main screen"
  8.                 }
  9.              ],
  10.         @"trackedEvents" : @[
  11.             @{
  12.                 @"class" : @"ZOCMainViewController",
  13.                 @"selector" : @"loginViewFetchedUserInfo:user:",
  14.                 @"label" : @"Login with Facebook"
  15.                 },
  16.             @{
  17.                 @"class" : @"ZOCMainViewController",
  18.                 @"selector" : @"loginViewShowingLoggedOutUser:",
  19.                 @"label" : @"Logout with Facebook"
  20.                 },
  21.             @{
  22.                 @"class" : @"ZOCMainViewController",
  23.                 @"selector" : @"loginView:handleError:",
  24.                 @"label" : @"Login error with Facebook"
  25.                 },
  26.             @{
  27.                 @"class" : @"ZOCMainViewController",
  28.                 @"selector" : @"shareButtonPressed:",
  29.                 @"label" : @"Share button"
  30.                 }
  31.              ]
  32.     };
  33. }

提及的架构托管 在 Github 的EF Education First 中.

  1. - (void)setupWithConfiguration:(NSDictionary *)configuration
  2. {
  3.     // screen views tracking
  4.     for (NSDictionary *trackedScreen in configuration[@"trackedScreens"]) {
  5.         Class clazz = NSClassFromString(trackedScreen[@"class"]);
  7.         [clazz aspect_hookSelector:@selector(viewDidAppear:)
  8.                        withOptions:AspectPositionAfter
  9.                         usingBlock:^(id<AspectInfo> aspectInfo) {
  10.             dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), 
  11.             ^{
  12.                 NSString *viewName = trackedScreen[@"label"];
  13.                 [tracker trackScreenHitWithName:viewName];
  14.                 });
  15.             }
  16.             error:nil];
  17.         }];
  19.     }
  21.     // events tracking
  22.     for (NSDictionary *trackedEvents in configuration[@"trackedEvents"]) {
  23.         Class clazz = NSClassFromString(trackedEvents[@"class"]);
  24.         SEL selektor = NSSelectorFromString(trackedEvents[@"selector"]);
  26.         [clazz aspect_hookSelector:selektor
  27.                        withOptions:AspectPositionAfter
  28.                         usingBlock:^(id<AspectInfo> aspectInfo) {
  29.             dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), 
  30.                     ^{
  31.                         UserActivityButtonPressedEvent *buttonPressEvent = \
  32.                         [UserActivityButtonPressedEvent \
  33.                                 eventWithLabel:trackedEvents[@"label"]];
  34.                         [tracker trackEvent:buttonPressEvent];
  35.                     });
  36.                 }
  37.             error:nil];
  38.         }];
  40.     }
  41. }