07 JANUARY 2015
上一篇介绍了Objective-C Messaging。利用 Objective-C 的 Runtime 特性，我们可以给语言做扩展，帮助解决项目开发中的一些设计和技术问题。这一篇，我们来探索一些利用 Objective-C Runtime 的黑色技巧。这些技巧中最具争议的或许就是 Method Swizzling 。
介绍一个技巧，最好的方式就是提出具体的需求，然后用它跟其他的解决方法做比较。
所以，先来看看我们的需求：对 App 的用户行为进行追踪和分析。简单说，就是当用户看到某个View或者点击某个Button的时候，就把这个事件记下来。
手动添加
最直接粗暴的方式就是在每个viewDidAppear里添加记录事件的代码。
@implementationMyViewController()- (void)viewDidAppear:(BOOL)animated{ [superviewDidAppear:animated];// Custom code// Logging[Logging logWithEventName:@“my view did appear”];}- (void)myButtonClicked:(id)sender{// Custom code// Logging[Logging logWithEventName:@“my button clicked”];}
这种方式的缺点也很明显：它破坏了代码的干净整洁。因为Logging的代码本身并不属于ViewController里的主要逻辑。随着项目扩大、代码量增加，你的ViewController里会到处散布着Logging的代码。这时，要找到一段事件记录的代码会变得困难，也很容易忘记添加事件记录的代码。
你可能会想到用继承或类别，在重写的方法里添加事件记录的代码。代码可以是长的这个样子：
@implementationUIViewController()- (void)myViewDidAppear:(BOOL)animated{ [superviewDidAppear:animated];// Custom code// Logging[Logging logWithEventName:NSStringFromClass([selfclass])];}- (void)myButtonClicked:(id)sender{// Custom code// LoggingNSString*name = [NSStringstringWithFormat:@“my buttonin%@ is clicked”, NSStringFromClass([selfclass])]; [Logging logWithEventName:name];}
Logging的代码都很相似，通过继承或类别重写相关方法是可以把它从主要逻辑中剥离出来。但同时也带来新的问题：
你需要继承UIViewController,UITableViewController,UICollectionViewController所有这些 ViewController ，或者给他们添加类别；
每个 ViewController 里的 ButtonClick 方法命名不可能都一样；
你不能控制别人如何去实例化你的子类；
对于类别，你没办法调用到原来的方法实现。大多时候，我们重写一个方法只是为了添加一些代码，而不是完全取代它。
如果有两个类别都实现了相同的方法，运行时没法保证哪一个类别的方法会给调用。
Method Swizzling
Method Swizzling 利用 Runtime 特性把一个方法的实现与另一个方法的实现进行替换。
上一篇文章有讲到每个类里都有一个 Dispatch Table ，将方法的名字（SEL）跟方法的实现（IMP，指向 C 函数的指针）一一对应。Swizzle 一个方法其实就是在程序运行时在 Dispatch Table 里做点改动，让这个方法的名字（SEL）对应到另个 IMP 。
首先定义一个类别，添加将要 Swizzled 的方法：
@implementationUIViewController(Logging)- (void)swizzled_viewDidAppear:(BOOL)animated{// call original implementation[selfswizzled_viewDidAppear:animated];// Logging[Logging logWithEventName:NSStringFromClass([selfclass])];}
代码看起来可能有点奇怪，像递归不是么。当然不会是递归，因为在 runtime 的时候，函数实现已经被交换了。调用viewDidAppear:会调用你实现的swizzled_viewDidAppear:，而在swizzled_viewDidAppear:里调用swizzled_viewDidAppear:实际上调用的是原来的viewDidAppear:。
接下来实现 swizzle 的方法 ：
@implementationUIViewController (Logging)voidswizzleMethod(Class class, SEL originalSelector, SEL swizzledSelector){// the method might not exist in the class, but in its superclassMethod originalMethod = class_getInstanceMethod(class,originalSelector); Method swizzledMethod = class_getInstanceMethod(class,swizzledSelector);// class_addMethod will fail if original method already existsBOOL didAddMethod = class_addMethod(class,originalSelector,method_getImplementation(swizzledMethod),method_getTypeEncoding(swizzledMethod));// the method doesn’t exist and we just added oneif(didAddMethod) { class_replaceMethod(class,swizzledSelector,method_getImplementation(originalMethod),method_getTypeEncoding(originalMethod)); }else{ method_exchangeImplementations(originalMethod, swizzledMethod); }}
这里唯一可能需要解释的是class_addMethod。要先尝试添加原 selector 是为了做一层保护，因为如果这个类没有实现originalSelector，但其父类实现了，那class_getInstanceMethod会返回父类的方法。这样method_exchangeImplementations替换的是父类的那个方法，这当然不是你想要的。所以我们先尝试添加orginalSelector，如果已经存在，再用method_exchangeImplementations把原方法的实现跟新的方法实现给交换掉。
最后，我们只需要确保在程序启动的时候调用swizzleMethod方法。比如，我们可以在之前UIViewController的 Logging 类别里添加+load:方法，然后在+load:里把viewDidAppear给替换掉：
@implementationUIViewController(Logging)+ (void)load{ swizzleMethod([selfclass],@selector(viewDidAppear:),@selector(swizzled_viewDidAppear:));}
一般情况下，类别里的方法会重写掉主类里相同命名的方法。如果有两个类别实现了相同命名的方法，只有一个方法会被调用。但+load:是个特例，当一个类被读到内存的时候， runtime 会给这个类及它的每一个类别都发送一个+load:消息。
其实，这里还可以更简化点：直接用新的 IMP 取代原 IMP ，而不是替换。只需要有全局的函数指针指向原 IMP 就可以。
void(gOriginalViewDidAppear)(id, SEL,BOOL);voidnewViewDidAppear(UIViewController*self, SEL _cmd,BOOLanimated) {// call original implementationgOriginalViewDidAppear(self, _cmd, animated);// Logging[Logging logWithEventName:NSStringFromClass([selfclass])];}+ (void)load{ Method originalMethod = class_getInstanceMethod(self,@selector(viewDidAppear:)); gOriginalViewDidAppear = (void*)method_getImplementation(originalMethod);if(!class_addMethod(self,@selector(viewDidAppear:), (IMP) newViewDidAppear, method_getTypeEncoding(originalMethod))) { method_setImplementation(originalMethod, (IMP) newViewDidAppear); }}
通过 Method Swizzling ，我们成功把逻辑代码跟处理事件记录的代码解耦。当然除了 Logging ，还有很多类似的事务，如 Authentication 和 Caching。这些事务琐碎，跟主要业务逻辑无关，在很多地方都有，又很难抽象出来单独的模块。这种程序设计问题，业界也给了他们一个名字 -Cross Cutting Concerns。
而像上面例子用 Method Swizzling 动态给指定的方法添加代码，以解决 Cross Cutting Concerns 的编程方式叫：Aspect Oriented Programming
Aspect Oriented Programming （面向切面编程）
Wikipedia 里对 AOP 是这么介绍的:
An aspect can alter the behavior of the base code 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).
在 Objective-C 的世界里，这句话意思就是利用 Runtime 特性给指定的方法添加自定义代码。有很多方式可以实现 AOP ，Method Swizzling 就是其中之一。而且幸运的是，目前已经有一些第三方库可以让你不需要了解 Runtime ，就能直接开始使用 AOP 。
Aspects就是一个不错的 AOP 库，封装了 Runtime ， Method Swizzling 这些黑色技巧，只提供两个简单的API：
+ (id)aspect_hookSelector:(SEL)selectorwithOptions:(AspectOptions)optionsusingBlock:(id)blockerror:(NSError**)error;-(id)aspect_hookSelector:(SEL)selectorwithOptions:(AspectOptions)optionsusingBlock:(id)blockerror:(NSError**)error;
使用 Aspects 提供的 API，我们之前的例子会进化成这个样子：
@implementationUIViewController(Logging)+ (void)load{ [UIViewControlleraspect_hookSelector:@selector(viewDidAppear:) withOptions:AspectPositionAfter usingBlock:^(id aspectInfo) {NSString*className = NSStringFromClass([[aspectInfo instance] class]); [Logging logWithEventName:className]; } error:NULL];}
你可以用同样的方式在任何你感兴趣的方法里添加自定义代码，比如 IBAction 的方法里。更好的方式，你提供一个 Logging 的配置文件作为唯一处理事件记录的地方：
@implementationAppDelegate(Logging)+ (void)setupLogging{NSDictionary*config = @{@"MainViewController": @{ GLLoggingPageImpression:@"page imp - main page", GLLoggingTrackedEvents: @[ @{ GLLoggingEventName:@"button one clicked", GLLoggingEventSelectorName:@"buttonOneClicked:", GLLoggingEventHandlerBlock: ^(id aspectInfo) { [Logging logWithEventName:@"button one clicked"]; }, }, @{ GLLoggingEventName:@"button two clicked", GLLoggingEventSelectorName:@"buttonTwoClicked:", GLLoggingEventHandlerBlock: ^(id aspectInfo) { [Logging logWithEventName:@"button two clicked"]; }, }, ], },@"DetailViewController": @{ GLLoggingPageImpression:@"page imp - detail page", } }; [AppDelegate setupWithConfiguration:config];}+ (void)setupWithConfiguration:(NSDictionary*)configs{// Hook Page Impression[UIViewControlleraspect_hookSelector:@selector(viewDidAppear:) withOptions:AspectPositionAfter usingBlock:^(id aspectInfo) {NSString*className = NSStringFromClass([[aspectInfo instance] class]); [Logging logWithEventName:className]; } error:NULL];// Hook Eventsfor(NSString*classNameinconfigs) { Class clazz = NSClassFromString(className);NSDictionary*config = configs[className];if(config[GLLoggingTrackedEvents]) {for(NSDictionary*eventinconfig[GLLoggingTrackedEvents]) { SEL selekor = NSSelectorFromString(event[GLLoggingEventSelectorName]); AspectHandlerBlock block = event[GLLoggingEventHandlerBlock]; [clazz aspect_hookSelector:selekor withOptions:AspectPositionAfter usingBlock:^(id aspectInfo) { block(aspectInfo); } error:NULL]; } } }}
然后在-application:didFinishLaunchingWithOptions:里调用setupLogging：
- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {// Override point for customization after application launch.[selfsetupLogging];returnYES;}
最后的话
利用 objective-C Runtime 特性和 Aspect Oriented Programming ，我们可以把琐碎事务的逻辑从主逻辑中分离出来，作为单独的模块。它是对面向对象编程模式的一个补充。Logging 是个经典的应用，这里做个抛砖引玉，发挥想象力，可以做出其他有趣的应用。
使用 Aspects 完整的例子可以从这里获得：AspectsDemo。
如果你有什么问题和想法，欢迎留言或者发邮件给我 peng@glowing.com 进行讨论。
网友评论