iOS开发-runtime-黑魔法Method swizzling

记得很久很久以前,啊,其实也没有很久,有一次面试,面试官问我,你懂runtime么??当时我是一个比现在还菜的菜逼,一句话给我问懵逼了,runtime是啥,我不懂啊。。。

后来面试完回来就赶快去查runtime的资料,至于runtime是什么,这里我就不多说啦,网上无数大牛总结过的东西,我也就不再班门弄斧啦,虽然这次的主题Method Swizzling也有很多大牛总结,我这篇文章呢,也就兹当做自己学习的笔记啦。

Method Swizzling 是什么

Method Swizzling是objective-c中的黑魔法,算是runtime中的一种实战使用模式,它允许我们动态的替换方法,实现Hook功能。

但是它也是一把双刃剑,用得好的人可以用它来很轻松的实现一些复杂的功能,而如果用的不好,后果就真的是毁灭性的伤害,这样的黑魔法,我们一定要尽力去掌握并驾驭它。

Method Swizzling 能做什么

说了这么多,那我们到底用它来做什么呢??? 先从名字来看,Method方法 Swizzling混合,那他的意思就是方法混合??? 好像也没有一个准确的翻译,我们就姑且翻译成方法交换吧。

也就是说把原来 A方法实现的a,原来B方法实现的b交换一下,让A来实现b的功能,让B来实现a的功能。咋一看好像没什么厉害的地方,不就是交换个方法么,有什么用呢?您先别急,往下看。

Method Swizzling 原理

ok,知道他是什么,能干什么了。接下来我们来看看他的原理吧。

虽然之前我们说Method Swizzling是一把双刃剑,用不好就容易把自己砍死,但是如果我们知道如何使用,这些就不会那么可怕了。

Method方法中,有两个关键的成员变量:SELIMP
SEL就是我们平时看到的方法的名称,比如 @selector(viewWillAppear:)
IMP是一个函数指针,指向的是方法的实现。
原则上,方法名SELIMP是一一对应的,那Method Swizzling的本质就是改变他们的对应关系,达到交换方法实现的目的。

logo
logo

Method Swizzling 实现&实践

好了,废话说了一大堆,接下来我们就来说说到底是怎么实现Method Swizzling吧。

我们用一个日常开发中都会用到的需求作为例子,平时我们可能会被产品要求在页面中添加监听事件,监听每个页面的访问,那我们需要再每个页面都添加这样的代码:

1
2
3
4
5
6
7
8
9
10
11
- (void)viewWillAppear:(BOOL)animated
{
[super viewWillAppear:animated];
[TalkingData trackPageBegin:@"P110000"];
}
- (void)viewWillDisappear:(BOOL)animated
{
[super viewWillDisappear:animated];
[TalkingData trackPageEnd:@"P110000"];
}

我们可以直接在每个页面中都添加这样的代码,简单粗暴,但是缺点也很明显,这样不仅要干很多体力活儿,还容易漏写某些页面,后期可能会被后边的程序员骂死。

或者我们写一个UIViewController的基类,让其他类都继承他,但是对于已经写好的代码,几十个类这样修改还是非常麻烦。

这时候就用到了我们的黑魔法Method Swizzling。

Method Swizzling 相关函数介绍

在真正使用黑魔法之前,我们先熟悉一下需要用到的函数:

获取一个方法名称(SEL):

1
class_getInstanceMethod

获取一个方法的实现(IMP):

1
method_getImplementation

获取一个实现编码类型

1
method_getTypeEncoding

给方法添加实现

1
class_addMethod

用一个方法实现替换另一个方法的实现

1
class_replaceMethod

交换两个方法的实现

1
method_exchangeImplementations

Method Swizzling 实现

终于到了实现的部分,好紧脏。
废话不多说直接上代码。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
+ (void)load
{
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
// 获取类方法
// Class selfClass = object_getClass([self class]);
// 获取实例方法
Class selfClass = [self class];
//获取原方法的名称和实现
SEL oriSEL = @selector(viewWillAppear:);
Method oriMethod = class_getInstanceMethod(selfClass, oriSEL);
//获取替换方法的名称和实现
SEL swizzlingSEL = @selector(swizzlingViewWillAppear:);
Method swizzlingMethod = class_getInstanceMethod(selfClass, swizzlingSEL);
//给原方法添加替换方法实现,为了避免原方法没有实现
BOOL addSucc = class_addMethod(selfClass, oriSEL, method_getImplementation(swizzlingMethod), method_getTypeEncoding(swizzlingMethod));
//成功,将原方法的实现替换到替换方法的实现
if (addSucc) {
class_replaceMethod(selfClass, swizzlingSEL, method_getImplementation(oriMethod), method_getTypeEncoding(oriMethod));
}
//失败,说明原方法已经实现,直接交换方法
else {
method_exchangeImplementations(oriMethod, swizzlingMethod);
}
});
}

另外附上替换方法的实现,这里我直接打印了类的名称,具体需要怎么做直接按需求来就行了。

1
2
3
4
5
- (void)swizzlingViewWillAppear:(BOOL)animated
{
NSLog(@"%@",self.class);
return [self swizzlingViewWillAppear:animated];
}

Method Swizzling 注意要点

功能虽然实现完了,但是这里边有几个部分我们要注意一下。

  • 1.为什么要在+load中实现?
  • 2.+load只会被调用一次,为什么还要用dispatch_once?
  • 3.为什么不直接交换方法,而是先要添加方法?
  • 4.在swizzlingViewWillAppear:方法里调用swizzlingViewWillAppear:,不会引起死循环么?

为什么要在+load中实现?

因为+load方法是在类被加载的时候调用的,与之相似的有类的+initialize方法,但是他的一种懒加载模式,当这个类或子类收到第一条消息之前才会调用他,所以+load方法是最好的实现场所。

+load只会被调用一次,为什么还要用dispatch_once?

首先我们要确认我们的Method Swizzling只实现一次,因为多次实现会反复交换方法,导致偶数次调用的实现没有交换,造成不必要的麻烦,添加dispatch_once算是添加一个双保险,因为谁知道有没有人会手动调用+load呢?

为什么不直接交换方法,而是先要添加方法?

一般情况下,我们都是为了和我们未知的系统方法添加Method Swizzling,而不是完全替换某个功能,所以我们一般都需要再自定义的实现中调用原始的实现,所以就会出现两种情况:

1.本身就有实现要替换的方法,这个时候比较简单,class_addMethod返回NO,我们直接交换方法就好。
2.本身没有实现要替换的方法,而是继承了父类的实现,class_addMethod返回YES,这个时候,我们需要使用class_getInstanceMethod函数获取到原始实现方法指向的方法,也就是父类中的实现,再通过实现class_replaceMethod来实现调用。

swizzlingViewWillAppear:方法里调用swizzlingViewWillAppear:,不会引起死循环么?

因为Method Swizzling的原理为方法互换,所以这时候用执行的swizzlingViewWillAppear:方法,实际上是执行的viewWillAppear:方法,因为我们并不知道OC的viewWillAppear:方法实现了什么内容,所以我们通过这个调用来实现系统的功能。

Demo

如果看到这里了的话,好像也没有什么必要上Demo了吧??
不过还是放上去好了, Demo地址

最后

Method Swizzling算是runtime中的一个比较好的实战使用方式,用好了的话可以解决各种各样的问题,比如数组越界崩溃等等很多问题,都可以通过他来解决,但是也不能滥用,不小心使用的话,可能真的要半夜爬起来改代码了。

参考链接

Objective-C-Method-Swizzling

iOS黑魔法-Method Swizzling

iOS runtime实战应用:Method Swizzling

Method Swizzling的各种姿势

Method Swizzling

Objective-C Method Swizzling 的最佳实践