Objective-C 源码（四） 再次看 Method Swizzling

    Method Swizzling 的原理

    先打开 objc-private.h 文件 在 235行能够看到 Method的定义：

typedef struct method_t *Method;

    

    而后在 objc-runtime-new.h 文件中第82行能够看到：

struct method_t {
    SEL name;
    const char *types;
    IMP imp;

    struct SortBySELAddress :
        public std::binary_function<const method_t&,
                                    const method_t&, bool>
    {
        bool operator() (const method_t& lhs,
                         const method_t& rhs)
        { return lhs.name < rhs.name; }
    };
};

    从本质上讲：它就是struct method_t 类型的执行，包括了3个成员变量和一个成员函数：

    name:表示的是方法的名称，用于惟一标示该方法，好比@selector(viewWillAppear:)；

    types:标示的是方法的返回值和参数类型；

    imp:是一个函数指针，指向方法的实现；

    SortBySELAddress 是一个根据name的地址对方法进行排序的函数。

    由上面能够看出：Objective-C中的方法名是不包括参数类型的，也就是说下面2个方法在runtime看起来时同样的。

- (void)viewWillAppear:(BOOL)animated;
- (void)viewWillAppear:(NSString *)string;

    并且，实例方法和类方法由于是分别保存在类对象和元类对象中的，全部，同名字的类方法和实例方法是能够共存的。

    原则上讲：方法的名称name和方法的实现imp是一一对应的，二Method Swizzling的原理就是动态改变他们的对应关系，以达到替换方法的目的。

    讲个简单的例子，友盟统计的页面统计的时候：

- (void)viewWillAppear:(BOOL)animated {
    [super viewWillAppear:animated];
    [MobClick beginLogPageView:@"PageOne"];
}

- (void)viewWillDisappear:(BOOL)animated {
    [super viewWillDisappear:animated];
    [MobClick endLogPageView:@"PageOne"];
}

    要想偷懒解决上面的代码，正常人的作法就是定义一个BaseViewController，而后其余类都是从这个viewcontroller继承出来的，可是，确实能够很快搞定，问题是，若是是old项目要加入，并且原始项目还不是继承某个BaseViewController的话就坑爹了，可是你还要一个一个类改继承的viewcontroller，这个时候使用Method Swizzling是最佳的解决办法。

    

    Method Swizzling:   

@interface UIViewController (MRCUMAnalytics)

@end

@implementation UIViewController (MRCUMAnalytics)

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

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

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

        BOOL success = class_addMethod(class, originalSelector, method_getImplementation(swizzledMethod), method_getTypeEncoding(swizzledMethod));
        if (success) {
            class_replaceMethod(class, swizzledSelector, method_getImplementation(originalMethod), method_getTypeEncoding(originalMethod));
        } else {
            method_exchangeImplementations(originalMethod, swizzledMethod);
        }
    });
}

#pragma mark - Method Swizzling

- (void)mrc_viewWillAppear:(BOOL)animated {
    [self mrc_viewWillAppear:animated];
    [MobClick beginLogPageView:NSStringFromClass([self class])];
}

@end

    解析：在上面的代码中有三个关键点须要引发咱们的注意：    

1. 为何是在 +load 方法中实现 Method Swizzling 的逻辑，而不是其余的什么方法，好比 +initialize 等；

2. 为何 Method Swizzling 的逻辑须要用 dispatch_once 来进行调度；

3. 为何须要调用 class_addMethod 方法，而且以它的结果为依据分别处理两种不一样的状况。

    第 1 个为何：    

    +load 和 +initialize 是 Objective-C runtime 会自动调用的两个类方法。可是它们被调用的时机倒是有差异的，+load 方法是在类被加载的时候调用的，而 +initialize 方法是在类或它的子类收到第一条消息以前被调用的，这里所指的消息包括实例方法和类方法的调用。也就是说 +initialize 方法是以懒加载的方式被调用的，若是程序一直没有给某个类或它的子类发送消息，那么这个类的 +initialize 方法是永远不会被调用的。此外 +load 方法还有一个很是重要的特性，那就是子类、父类和分类中的 +load 方法的实现是被区别对待的。换句话说在 Objective-C runtime 自动调用 +load 方法时，分类中的 +load 方法并不会对主类中的 +load 方法形成覆盖。综上所述，+load 方法是实现 Method Swizzling 逻辑的最佳“场所”。

    第 2 个为何：

    咱们上面提到，+load 方法在类加载的时候会被 runtime 自动调用一次，可是它并无限制程序员对 +load 方法的手动调用。什么？你说不会有程序员这么干？那可说不定，我还见过手动调用 viewDidLoad 方法的程序员，就是介么任性。而咱们所可以作的就是尽量地保证程序可以在各类状况下正常运行。

    第 3 个为何：

    咱们使用 Method Swizzling 的目的一般都是为了给程序增长功能，而不是彻底地替换某个功能，因此咱们通常都须要在自定义的实现中调用原始的实现。因此这里就会有两种状况须要咱们分别进行处理：

    

    第 1 种状况：主类自己有实现须要替换的方法，也就是 class_addMethod 方法返回 NO 。这种状况的处理比较简单，直接交换两个方法的实现就能够了：

- (void)viewWillAppear:(BOOL)animated {
    /// 先调用原始实现，因为主类自己有实现该方法，因此这里实际调用的是主类的实现
    [self mrc_viewWillAppear:animated];
    /// 咱们增长的功能
    [MobClick beginLogPageView:NSStringFromClass([self class])];
}

- (void)mrc_viewWillAppear:(BOOL)animated {
    /// 主类的实现
}

    第 2 种状况：主类自己没有实现须要替换的方法，而是继承了父类的实现，即 class_addMethod 方法返回 YES 。这时使用 class_getInstanceMethod 函数获取到的 originalSelector 指向的就是父类的方法，咱们再经过执行 class_replaceMethod(class, swizzledSelector, method_getImplementation(originalMethod), method_getTypeEncoding(originalMethod)); 将父类的实现替换到咱们自定义的 mrc_viewWillAppear 方法中。这样就达到了在 mrc_viewWillAppear 方法的实现中调用父类实现的目的。

- (void)viewWillAppear:(BOOL)animated {
    /// 先调用原始实现，因为主类自己并无实现该方法，因此这里实际调用的是父类的实现
    [self mrc_viewWillAppear:animated];
    /// 咱们增长的功能
    [MobClick beginLogPageView:NSStringFromClass([self class])];
}

- (void)mrc_viewWillAppear:(BOOL)animated {
    /// 父类的实现
}

    参考了 leichunfeng sunny yulingtianxia 等博客。