【翻译】Method Swizzling

原文地址：Method Swizzling
翻译对比地址：Method Swizzling

如果你只需要按下按钮就能毁灭整个世界，
你会不会去做这件事？
如果你可以让所有人变得贫穷以此来让你变得富有，
你会不会去做这件事？
如果你可以只看着所有人工作而自己只需要躺着，
你是否愿意？
如果你能够得到所有人的爱而不用给予别人爱，
你是否愿意？
这样我们将不能了解自己，也不知道我们要做什么。。
如果你拥有这些力量，你会怎么做？
The Flaming Lips, “The Yeah Yeah Yeah Song (With All Your Power)”

在上周的文章associated objects中, 我们开始探索Objective-C的runtime中的黑魔法。这周，我们更进一步，来讨论runtime中最富有争议的黑魔法--method swizzing。

method swizzing 是改变一个已经存在的方法的实现的方式。它的原理是Objective-C可以在runtime中改变类的dispatch table中Selector与其实现的对应关系，进而实现改变一个方法的实现。
例如，如果我们想要实现统计某个用户在某个App下展示的ViewController的次数。
我们可以在每个ViewController的viewDidAppear方法里添加统计代码，但是这样会产生大量的重复的代码。子类化是另一个可能的选择，但是这需要为UIViewController、 UITableViewController,、UINavigationController等ViewController都写一个子类，这也会产生代码重复的问题。
幸运的是，还有另一个种方法来实现这个需求：使用method swizzing来写一个分类。下面是实现的代码：

#import 

@implementation UIViewController (Tracking)

+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        Class class = [self class];

        SEL originalSelector = @selector(viewWillAppear:);
        SEL swizzledSelector = @selector(xxx_viewWillAppear:);

        Method originalMethod = class_getInstanceMethod(class, originalSelector);
        Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);

        // When swizzling a class method, use the following:
        // Class class = object_getClass((id)self);
        // ...
        // Method originalMethod = class_getClassMethod(class, originalSelector);
        // Method swizzledMethod = class_getClassMethod(class, swizzledSelector);

        BOOL didAddMethod =
            class_addMethod(class,
                originalSelector,
                method_getImplementation(swizzledMethod),
                method_getTypeEncoding(swizzledMethod));

        if (didAddMethod) {
            class_replaceMethod(class,
                swizzledSelector,
                method_getImplementation(originalMethod),
                method_getTypeEncoding(originalMethod));
        } else {
            method_exchangeImplementations(originalMethod, swizzledMethod);
        }
    });
}

#pragma mark - Method Swizzling

- (void)xxx_viewWillAppear:(BOOL)animated {
    [self xxx_viewWillAppear:animated];
    NSLog(@"viewWillAppear: %@", self);
}

@end

在计算机科学中，指针交换（？）是基于名字或位置来引用的交换。

现在，当有一个UIViewController或者其子类的调用了viewDidAppear方法，都会打印出日志。引入行为到ViewController 的生命周期，响应事件，视图绘制或者基础网络栈中都是使用method swizzing来方便的实现一些需求的一些例子。还有很多适合method swizzing技术的场景，这显然会让开发者的技术越来越成熟。

+load vs +initialize

方法交换最好在+load方法中完成。
有两个方法是Objective-C的runtime机制对每个类都一定会自动调用的，+load会在类被第一次加载时被调用，而+initialize方法只会在应用中第一次调用关于这个类的方法前或生成这个类的实例的时候。两个都是可选择实现或不实现的，系统只会当方法被实现时才会执行。
因为 method swizzing会影响全局，所以避免竞争的可能是非常重要的。+load一定是在类被初始化的时候被调用，这提供了一点系统级别改变的统一性。相比之下，+initialize不能保证它什么时候会被执行----事实上，如果应用中没有给这个类发过消息，这个方法就永远不会被调用。

dispatch_once

swizzing 代码一定要放在dispatch_once中。
由于同样的原因，method swizzing会影响全局，我们要在runtime中使用一切可能的预防措施。原子性就是一个预防措施，这能够保证代码即使在不同线程中也只会被执行一次，GCD的方法dispatch_once提供了这两种重要的功能，这个方法应该被作为一个标准使用方法当遇到method swizzing的时候，因为这是“单次初始化”的。

Selectors, Methods, & Implementations

在Objective-C中，selectors, methods, and implementations 对应runtime中的不同部分。但是一般来说，这些在消息发送的过程中都是可以交换的。
下面是这些概念在Objective-C Runtime Reference 中的解释：

• Selector (typedef struct objc_selector *SEL): Selectors are used to represent the name of a method at runtime. A method selector is a C string that has been registered (or “mapped”) with the Objective-C runtime. Selectors generated by the compiler are automatically mapped by the runtime when the class is loaded .

• Method (typedef struct objc_method *Method): An opaque type that represents a method in a class definition.
• Implementation (typedef id (*IMP)(id, SEL, ...)): This data type is a pointer to the start of the function that implements the method. This function uses standard C calling conventions as implemented for the current CPU architecture. The first argument is a pointer to self (that is, the memory for the particular instance of this class, or, for a class method, a pointer to the metaclass). The second argument is the method selector. The method arguments follow.

理解这些概念之间的关系的最好方式如下：一个类（class）维护一个dispatch table来处理在runtime时发送来的消息；这个表中的每个入口都是一个方法（method），它用一个名字Selector（SEL）来对应一个实现（IMP），即一个C语言代码块的指针。
交换一个方法就是通过改变类的dispatch table来让一个已经存在的selector对应另一个实现，同时把原来的方法实现对应到另一个selector。

Invoking _cmd

下面的代码初看上去会造成循环初始化

- (void)xxx_viewWillAppear:(BOOL)animated {
    [self xxx_viewWillAppear:animated];
    NSLog(@"viewWillAppear: %@", NSStringFromClass([self class]));
}

但是，这样的结果并没有出现。因为在交换的过程中，xxx_viewWillAppear:animated方法的实现已经被替换为UIViewController的-viewWillAppear:方法原来的实现。一个好的程序员会本能的觉得在方法中调用自己是不可行的，但在这种情况下，它能够起到作用，只要我们知道它真实是怎么运行的。但是，如果我们在这个方法中调用viewWillAppear:，就会造成循环初始化的问题。因为这个方法的实现在运行时会被替换为viewWillAppear:方法的实现。

记得给你自己的swizzinged方法添加前缀，在Catalog中最好也这样做。

一些思考

Swizzing因为它不可预测的行为和难以预料的结果被大家认为是一种邪恶的技术。虽然它不是最安全的事情，但是如果你遵循下面预防措施那它基本就是安全的：

• 记得调用原方法除非你有很好的理由不去调用。APIs 提供了输入输出的规则，而在输入输出中间的方法实现就是一个看不见的黑盒。交换了方法实现并且一些回调方法不会调用原生方法的实现这可能会造成底层实现的崩溃。
• 避免方法名冲突。为分类的方法加前缀，一定要确保调用了原生方法的所有地方不会因为你交换了方法的实现而出现意想不到的结果。
• 理解你写的代码。只是简单的拷贝粘贴交换方法实现的代码而不去理解实现原理不仅会让 App 很脆弱，并且浪费了学习 Objective-C 运行时的机会。阅读 Objective-C Runtime Reference 并且浏览 能够让你更好理解实现原理。
• 谨慎使用。只是简单的拷贝粘贴交换方法实现的代码而不去理解实现原理不仅会让 App 很脆弱，并且浪费了学习 Objective-C 运行时的机会。阅读 Objective-C Runtime Reference 并且浏览 能够让你更好理解实现原理。

害怕直接使用method swizzing会出错？Jonathan ‘Wolf’ Rentzsch
提供了一个经过测试的的库JRSwizzle来帮你处理所有该避免的坑，其也支持pod来使用。

就像associated objects一样，method swizzing 是一个强大的技术但是应该被谨慎使用。