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
解析:在上面的代码中有三个关键点需要引起我们的注意:
为什么是在 +load 方法中实现 Method Swizzling 的逻辑,而不是其他的什么方法,比如 +initialize 等;
为什么 Method Swizzling 的逻辑需要用 dispatch_once 来进行调度;
为什么需要调用 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 等博客。