method_swizzling

Method Swizzling

最近在研究学习runtime,其中有一个特性叫method swizzling，即方法替换。它能够让你在合适的地方更改一下方法的实现。它功能很强大，如果用好了能够带你飞，但是用不好那就是坑啊。下面就开始讲解。

Swizzling 原理

在Objective-C中调用一个方法，其实就是向一个对象发消息，查找消息的依据就是selector的名字。我们可以利用runtime的机制，获取到selector的实现地址然后进行交换，达到方法交换的目的。

每个类都有一个方法列表，存放着selector的名字和IMP实现的映射关系，IMP在runtime中就是函数的指针，指向函数的具体实现。SEL 和 Method的映射关系如下：

从图上可以看出一个Selector 对应一个 IMP,可以通过Selector 查找到IMP。

但是，现在我们要讲一个Selector指向对应IMP的指针指向其他IMP，即交换两个Selector的IMP，交换后如下：

我们可以通过Swizzling技术来实现上述的效果，也就是给给对象发送Selector C消息的时候，本来指向的是IMP C，现在让它指向IMP X的方法实现。

在+load方法中使用

Swizzling应该在+load方法中使用,因为load方法可以保证在类最开始初始化加载的时候调用。因为Swizzling method的影响是全局的，应该放在最保险的地方去处理。 +load方法能够保证在类的初始化的时候就加载，保证统一性。试想若是临时的调用一下swizzling,而没有及时的将方法给替换回来就会产生很大的影响。同时也不能在 +initialize方法中使用，因为这个方法可能一直未被使用，因为这个类可能永远不能被调用。类文件在工程中，一定会被加载，因此可以保证+load方法被调用，但是+initialize并不能保证被调用。

在Dispatch_once中保证只交换一次。

方法交换即使在多线程中应该也是调用一次，因此在Dispatch_once使用能够保证之交换一次，保证线程安全，因为我们需要将它加到Swizzling的使用安全规范中

交换IMP的方法

我们定义一个NSObject的分类，这样在Objective-C的体系下所有继承NSObject的对象都能有这个方法替换的功能。

#import "NSObject+Swizzling.h"
#import <objc/runtime.h>

@implementation NSObject (Swizzling)

+ (void)switchSelector:(SEL)originSelector withSwizzledSelector:(SEL)swizzledSelector
{
    Method originMethod = class_getInstanceMethod([self class], originSelector);
    Method swizzledMethod = class_getInstanceMethod([self class], swizzledSelector);

    BOOL notHaveMethod =  class_addMethod([self class], originSelector, method_getImplementation(swizzledMethod), method_getTypeEncoding(swizzledMethod));

    if (notHaveMethod) {
        //如果没有方法，表明添加方法成功
        class_replaceMethod([self class], swizzledSelector, method_getImplementation(originMethod), method_getTypeEncoding(originMethod));
    }else{
        //如果有方法，直接替换
        method_exchangeImplementations(originMethod, swizzledMethod);
    }
}

因为方法可能不是在这个类中，可能在父类中，因此先尝试在该类中添加该方法，如果添加成功，表明这个类没有这个方法，然后直接替换实现就可以了。如果没有添加成功，说明这个类以及有这个方法了，那就直接替换，用method_exchangeImplementations这个方法，因为这个方法是原子操作的，是线程安全的。不要用下面的方式:

IMP imp1 = method_getImplementation(m1);
IMP imp2 = method_getImplementation(m2);
method_setImplementation(m1, imp2);
method_setImplementation(m2, imp1);

你点击method_exchangeImplementations的介绍就可以看到，它的本质就是这样的方式来写的，但是它在内部做了线程安全操作。

简单使用

首先定义一个NSMutableArray的分类NSMutableArray+Swizzling,并在NSMutableArray+Swizzling.m文件中实现如下方法：

+ (void)load
{
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{

        [objc_getClass("__NSArrayM")  swizzleSelector:@selector(addObject:) withSwizzledSelector:NSSelectorFromString(@"dg_addObject:")];

    });
}

- (id)dg_addObject:(id)obj
{
    if (!obj) {
        NSLog(@"您添加的对象为nil");
        return nil;
    }
    return  [self dg_addObject:obj];

}

在+load方法中实现在dispatch_once中替换原生的addObject方法为自定义的dg_addObject方法。

NSMutableArray *tempArray = [NSMutableArray array];
[tempArray addObject:nil]; //添加nil，不会崩溃
NSLog(@"The array's last object is :%@",tempArray.lastObject);
//会发现打印结果为：
//NSArray is empty
//The array's last object is :(null)

在我们自己实现的方法中，对于如果添加尽力的对象是nil，我们不进行任何处理，只是打印log，这样就不会出现我们经常遇到的nil为空就崩的错误了。是不是很6？我们即可以做防nil操作，还可以做一些其他操作。

还有上面再替换方法的时候的调用对象为objc_getClass("__NSArrayM"),这主要原因是在Cocoa中，NSArray、NSMutableArray、NSDictionary、NSMutableDictionary等类中，真实执行操作的不是这些对象，它们的真身其实是这样的：

具体可参考类簇。

小结

Method SWizzling 是个很有意思的技术，用来能够做许多强大的功能，但是用Method Swizzling如果使用不当，也会引起很多问题。不过只有了解它的实现原理，正确的使用，还是能给我们的开发带来很大便利。

本文demo地址：runtime method swizzling

参考文献：

Runtime Method Swizzling

iOS黑魔法－Method Swizzling