Objective-C的hook方案: Method Swizzling

Objective-C的hook方案（一）:  Method Swizzling

在没有一个类的实现源码的情况下，想改变其中一个方法的实现，除了继承它重写、和借助类别重名方法暴力抢先之外，还有更加灵活的方法吗？在Objective-C编程中，如何实现hook呢？标题有点大，计划分几篇来总结。

本文主要介绍针对selector的hook，主角被标题剧透了———— Method Swizzling 。

Method Swizzling 原理

在Objective-C中调用一个方法，其实是向一个对象发送消息，查找消息的唯一依据是selector的名字。利用Objective-C的动态特性，可以实现在运行时偷换selector对应的方法实现，达到给方法挂钩的目的。

每个类都有一个方法列表，存放着selector的名字和方法实现的映射关系。IMP有点类似函数指针，指向具体的Method实现。

我们可以利用 method_exchangeImplementations 来交换2个方法中的IMP，

我们可以利用 class_replaceMethod 来修改类，

我们可以利用 method_setImplementation 来直接设置某个方法的IMP，
……

归根结底，都是偷换了selector的IMP，如下图所示：

Method Swizzling 实践

举个例子好了，我想钩一下NSArray的lastObject 方法，只需两个步骤。

第一步：给NSArray加一个我自己的lastObject

1. #import "NSArray+Swizzle.h"  
2.   
3.   
4. @implementation NSArray (Swizzle)  
5.   
6.   
7. - (id)myLastObject  
8. {  
9.     id ret = [self myLastObject];  
10.     NSLog(@"**********  myLastObject *********** ");  
11.     return ret;  
12. }  
13. @end  

乍一看，这不递归了么？别忘记这是我们准备调换IMP的selector，[self myLastObject] 将会执行真的 [self lastObject] 。



第二步：调换IMP

1. #import <objc/runtime.h>  
2. #import "NSArray+Swizzle.h"  
3.   
4.   
5. int main(int argc, char *argv[])  
6. {  
7.     @autoreleasepool {  
8.           
9.         Method ori_Method =  class_getInstanceMethod([NSArray class], @selector(lastObject));  
10.         Method my_Method = class_getInstanceMethod([NSArray class], @selector(myLastObject));  
11.         method_exchangeImplementations(ori_Method, my_Method);  
12.           
13.         NSArray *array = @[@"0",@"1",@"2",@"3"];  
14.         NSString *string = [array lastObject];  
15.         NSLog(@"TEST RESULT : %@",string);  
16.           
17.         return 0;  
18.     }  
19. }  

控制台输出Log：

1. 2013-07-18 16:26:12.585 Hook[1740:c07] **********  myLastObject ***********   
2. 2013-07-18 16:26:12.589 Hook[1740:c07] TEST RESULT : 3  

结果很让人欣喜，是不是忍不住想给UIWebView的loadRequest: 加 TODO 了呢？ 

Method Swizzling 的封装

之前在github上找到的RNSwizzle，推荐给大家，可以搜一下。

1. //  
2. //  RNSwizzle.m  
3. //  MethodSwizzle  
4.   
5.   
6. #import "RNSwizzle.h"  
7. #import <objc/runtime.h>  
8. @implementation NSObject (RNSwizzle)  
9.   
10.   
11. + (IMP)swizzleSelector:(SEL)origSelector   
12.                withIMP:(IMP)newIMP {  
13.   Class class = [self class];  
14.   Method origMethod = class_getInstanceMethod(class,  
15.                                               origSelector);  
16.   IMP origIMP = method_getImplementation(origMethod);  
17.     
18.   if(!class_addMethod(self, origSelector, newIMP,  
19.                       method_getTypeEncoding(origMethod)))  
20.   {  
21.     method_setImplementation(origMethod, newIMP);  
22.   }  
23.     
24.   return origIMP;  
25. }  
26. @end  

Method Swizzling 危险不危险

针对这个问题，我在 stackoverflow上看到了满意的答案，这里翻译一下，总结记录在本文中，以示分享：


使用 Method Swizzling 编程就好比切菜时使用锋利的刀，一些人因为担心切到自己所以害怕锋利的刀具，可是事实上，使用钝刀往往更容易出事，而利刀更为安全。
Method swizzling 可以帮助我们写出更好的，更高效的，易维护的代码。但是如果滥用它，也将会导致难以排查的bug。 

背景

好比设计模式，如果我们摸清了一个模式的门道，使用该模式与否我们自己心里有数。单例模式就是一个很好的例子，它饱受争议但是许多人依旧使用它。Method Swizzling也是一样，一旦你真正理解它的优势和弊端，使用它与否你应该就有你自己的观点。

讨论

这里是一些 Method Swizzling的陷阱：

• Method swizzling is not atomic
• Changes behavior of un-owned code
• Possible naming conflicts
• Swizzling changes the method's arguments
• The order of swizzles matters
• Difficult to understand (looks recursive)
• Difficult to debug

我将逐一分析这些点，增进对Method Swizzling的理解的同时，并搞懂如何应对。

Method swizzling is not atomic

我所见过的使用method swizzling实现的方法在并发使用时基本都是安全的。95%的情况里这都不会是个问题。通常你替换一个方法的实现，是希望它在整个程序的生命周期里有效的。也就是说，你会把 method swizzling 修改方法实现的操作放在一个加号方法 +(void)load里，并在应用程序的一开始就调用执行。你将不会碰到并发问题。假如你在 +(void)initialize初始化方法中进行swizzle，那么……rumtime可能死于一个诡异的状态。

Changes behavior of un-owned code

这是swizzling的一个问题。我们的目标是改变某些代码。swizzling方法是一件灰常灰常重要的事，当你不只是对一个NSButton类的实例进行了修改，而是程序中所有的NSButton实例。因此在swizzling时应该多加小心，但也不用总是去刻意避免。

想象一下，如果你重写了一个类的方法，而且没有调用父类的这个方法，这可能会引起问题。大多数情况下，父类方法期望会被调用（至少文档是这样说的）。如果你在swizzling实现中也这样做了，这会避免大部分问题。还是调用原始实现吧，如若不然，你会费很大力气去考虑代码的安全问题。

Possible naming conflicts

命名冲突贯穿整个Cocoa的问题. 我们常常在类名和类别方法名前加上前缀。不幸的是，命名冲突仍是个折磨。但是swizzling其实也不必过多考虑这个问题。我们只需要在原始方法命名前做小小的改动来命名就好，比如通常我们这样命名：
 

1. @interface NSView : NSObject  
2. - (void)setFrame:(NSRect)frame;  
3. @end  
4.   
5.   
6. @implementation NSView (MyViewAdditions)  
7.   
8.   
9. - (void)my_setFrame:(NSRect)frame {  
10.     // do custom work  
11.     [self my_setFrame:frame];  
12. }  
13.   
14.   
15. + (void)load {  
16.     [self swizzle:@selector(setFrame:) with:@selector(my_setFrame:)];  
17. }  
18.   
19.   
20. @end  

这段代码运行正确，但是如果my_setFrame: 在别处被定义了会发生什么呢？

这个问题不仅仅存在于swizzling，这里有一个替代的变通方法：

1. @implementation NSView (MyViewAdditions)  
2.   
3.   
4. static void MySetFrame(id self, SEL _cmd, NSRect frame);  
5. static void (*SetFrameIMP)(id self, SEL _cmd, NSRect frame);  
6.   
7.   
8. static void MySetFrame(id self, SEL _cmd, NSRect frame) {  
9.     // do custom work  
10.     SetFrameIMP(self, _cmd, frame);  
11. }  
12.   
13.   
14. + (void)load {  
15.     [self swizzle:@selector(setFrame:) with:(IMP)MySetFrame store:(IMP *)&SetFrameIMP];  
16. }  
17.   
18.   
19. @end  

看起来不那么Objectice-C了（用了函数指针），这样避免了selector的命名冲突。 


最后给出一个较完美的swizzle方法的定义：

1. typedef IMP *IMPPointer;  
2.   
3.   
4. BOOL class_swizzleMethodAndStore(Class class, SEL original, IMP replacement, IMPPointer store) {  
5.     IMP imp = NULL;  
6.     Method method = class_getInstanceMethod(class, original);  
7.     if (method) {  
8.         const char *type = method_getTypeEncoding(method);  
9.         imp = class_replaceMethod(class, original, replacement, type);  
10.         if (!imp) {  
11.             imp = method_getImplementation(method);  
12.         }  
13.     }  
14.     if (imp && store) { *store = imp; }  
15.     return (imp != NULL);  
16. }  
17.   
18.   
19. @implementation NSObject (FRRuntimeAdditions)  
20. + (BOOL)swizzle:(SEL)original with:(IMP)replacement store:(IMPPointer)store {  
21.     return class_swizzleMethodAndStore(self, original, replacement, store);  
22. }  
23. @end  

Swizzling changes the method's arguments

我认为这是最大的问题。想正常调用method swizzling 将会是个问题。

1. [self my_setFrame:frame];  

直接调用my_setFrame: ， runtime做的是

1. objc_msgSend(self, @selector(my_setFrame:), frame);  

runtime去寻找my_setFrame:的方法实现, _cmd参数为 my_setFrame: ，但是事实上runtime找到的方法实现是原始的 setFrame: 的。

一个简单的解决办法：使用上面介绍的swizzling定义。

The order of swizzles matters

多个swizzle方法的执行顺序也需要注意。假设 setFrame: 只定义在NSView中，想像一下按照下面的顺序执行：

1. [NSButton swizzle:@selector(setFrame:) with:@selector(my_buttonSetFrame:)];  
2. [NSControl swizzle:@selector(setFrame:) with:@selector(my_controlSetFrame:)];  
3. [NSView swizzle:@selector(setFrame:) with:@selector(my_viewSetFrame:)];  

What happens when the method on NSButton is swizzled? Well most swizzling will ensure that it's not replacing the implementation of setFrame: for all views, so it will pull up the instance method. This will use the existing implementation to re-define setFrame: in the NSButton class so that exchanging implementations doesn't affect all views. The existing implementation is the one defined on NSView. The same thing will happen when swizzling on NSControl (again using the NSView implementation).

When you call setFrame: on a button, it will therefore call your swizzled method, and then jump straight to the setFrame: method originally defined on NSView. The NSControl and NSView swizzled implementations will not be called.

But what if the order were:

1. [NSView swizzle:@selector(setFrame:) with:@selector(my_viewSetFrame:)];  
2. [NSControl swizzle:@selector(setFrame:) with:@selector(my_controlSetFrame:)];  
3. [NSButton swizzle:@selector(setFrame:) with:@selector(my_buttonSetFrame:)];  

Since the view swizzling takes place first, the control swizzling will be able to pull up the right method. Likewise, since the control swizzling was before the button swizzling, the button will pull up the control's swizzled implementation of setFrame:. This is a bit confusing, but this is the correct order. How can we ensure this order of things?

Again, just use load to swizzle things. If you swizzle in load and you only make changes to the class being loaded, you'll be safe. The load method guarantees that the super class load method will be called before any subclasses. We'll get the exact right order!


这段贴了原文，硬翻译太拗口……总结一下就是： 多个有继承关系的类的对象swizzle时，从子类对象开始 。 如果先swizzle父类对象，那么后面子类对象swizzle时就无法拿到真正的原始方法实现了。 

（感谢评论中 qq373127202 的提醒，在此更正一下，十分感谢）

多个有继承关系的类的对象swizzle时，先从父对象开始。 这样才能保证子类方法拿到父类中的被swizzle的实现。在+(void)load中swizzle不会出错，就是因为load类方法会默认从父类开始调用。

Difficult to understand (looks recursive)

（新方法的实现）看起来像递归，但是看看上面已经给出的 swizzling 封装方法, 使用起来就很易读懂.
这个问题是已完全解决的了！

Difficult to debug

debug时打出的backtrace，其中掺杂着被swizzle的方法名，一团糟啊！上面介绍的swizzle方案，使backtrace中打印出的方法名还是很清晰的。但仍然很难去debug，因为很难记住swizzling影响过什么。给你的代码写好文档（即使只有你一个人会看到）。养成一个好习惯，不会比调试多线程问题还难的。

结论

如果使用恰当，Method swizzling 还是很安全的.一个简单安全的方法是，仅在load中swizzle。 和许多其他东西一样，它也是有危险性的，但理解它了也就可以正确恰当的使用它了。

（ 本博客中所有原创文章及译文均采用 知识共享署名-非商业性使用-相同方式共享 2.5 进行许可 ）