【迁移】Method Swizzling(一)

coding 的演示功能不让用,原来搭建的博客访问不了了。索性将全部博客迁移到,这篇是旧文章,欢迎大家以后来看我的博客

Time Flies,好久没写博客了,最近一直在玩设计模式,而设计模式这个东西比较大,自认为还没到将他们写出来的时候,等再过一阵吧。正好这几天看了一个好玩的小东西,觉得不错,所以分享一下。

缘起

相信大家都用过NSMutableDictionary的-setObject:forKey:方法,使用这个方法当object为nil时,将会崩溃。我们写代码时,每次都需要对nil进行判断,非常麻烦。而且有时候忘了对nil进行判断,很可能就bug留到上线。上线App中经常会遇到这种崩溃

这时候就想用一个方法,替代-setObject:forKey:,当obj为非nil时正常使用-setObject:forKey:,为nil时不执行任何操作。

对于改变一个方法的实现,有三种方案:override,caregory,swizzling

1.Override

重写是改变一个方法实现的最普遍的用法,首先创建一个CustomDictionary继承于NSMutableDictionary,然后重写-setObject:forKey:,在使用的时候我们使用CustomDictionary.

这样虽然能达到目的,但也非常麻烦,首先我们必须创建一个新的类继承于NSMutableDictionary,并对所有使用NSMutableDictionary的老代码,都得进行修改。如果团队来了新人,必须得叮嘱他不能使用NSMutableDictionary,而要用CustomDictionary......

my god,这也太麻烦了,pass~

2.Category

category是OC中非常棒的东西,传说其他语言都没有,那么让我们看看使用category怎么样?
首先category中的这个方法不能跟-setObject:forKey:重名,不然我们就没法调用系统的这个-setObject:forKey:了,所以我们命名为-safeSetObject:forKey:,在这个方法中对-setObject:forKey进行重写。

这个方案比重写好一些,至少我们不需要创建新的类,并且也完全能达到目的,不过对于老代码的修改,和对新人的嘱咐还是必不可少......

其实我们还有更完美的方案

3.Swizzling

iOS中Method Swizzling不太常见,让我们来详细看看什么是Method Swizzling。

一个方法分为2部分:方法名和方法实现,也即是SEL和IMP。一般情况每个方法都会有固定的SEL和IMP,不可分割。

每个类里面都有一个方法列表,存放着SEL和IMP的映射关系(图片来源):

【迁移】Method Swizzling(一)_第1张图片
图片

Method Swizzling就是将其中2个方法的SEL和IMP对换一下(图片来源):

【迁移】Method Swizzling(一)_第2张图片
图片

让本来调用selectorC的方法,去执行selectorN的实现。

下面我们来看一下要实现Method Swizzling,到底要做些什么?
首先需要创建一个NSMutableDictionary的category,将用来替换-setObject:forKey:的方法写进去:

@implementation NSMutableDictionary(Override)

- (void)overrideSetObject:(id)anObject forKey:(id )aKey;
{
    if (anObject) {
        /** 注意:必须调用自己的方法名 */
        [self overrideSetObject:anObject forKey:aKey]; 
    }
}

@end

大家看到这肯定会非常惊讶,在-overrideSetObject:forKey:方法中竟然调用了自己的方法名,这不是死循环了么?

不要忘了,这个方法是会Swizzling的,也就是说方法内部调用的这个方法名,会指向系统的实现。这里没看明白的朋友,可以跳过,后面我会详细给大家说清楚

方法有了,现在我们该Swizzling了。

首先要注意的是,Swizzling必须要在执行方法之前,不然方法都执行完了,再Swizzling就没意义了,其次需要看看要不要考虑多线程的问题。

一般情况下,Swizzling的代码我们都放在+load方法中,因为+load方法是在启动时执行的(-application:didFinishLaunchingWithOptions:之前),肯定会在使用之前。并且也不用考虑多线程。

void methodSwizzling(Class class,SEL originSel,SEL overrideSel)
{
    Method originMethod = class_getInstanceMethod(class, originSel);
    Method overrideMethod = class_getInstanceMethod(class, overrideSel);

    if (class_addMethod(class,
                        originSel,
                        method_getImplementation(overrideMethod),
                        method_getTypeEncoding(originMethod)))
    {
        /** case1:NSMutableDictionary中没有-setObject:forKey:的实现 */
        class_replaceMethod(class,
                            overrideSel,
                            method_getImplementation(originMethod),
                            method_getTypeEncoding(originMethod));
    }else{
        /** case2:NSMutableDictionary中有-setObject:forKey:的实现   */
        method_exchangeImplementations(originMethod, overrideMethod);
    }

}

+ (void)load
{
    /** 获取SEL和Method */
    SEL originSel = @selector(setObject:forKey:);
    SEL overrideSel = @selector(overrideSetObject:forKey:);
    
    methodSwizzling([self class], originSel, overrideSel);
}

对于Swizzling的实现,我们需要分2种case来处理:

case1:NSMutableDictionary中没有-setObject:forKey:的实现,也许-setObject:forKey:是NSMutableDictionary的父类实现的,我们没有源代码,任何情况都可能发生。这种case下。我们需要在NSMutableDictionary中插入-setObject:forKey:方法,再替换他们的IMP部分

case2:NSMutableDictionary中已经存在-setObject:forKey:的实现了,这时候我们就只需要直接替换他们的IMP就ok了

那么怎么知道NSMutableDictionary中是否已经存在-setObject:forKey:了呢?很简单。使用class_addMethod()方法将-setObject:forKey:插入其中,若原来Class未实现,则会插入成功,返回YES,否则返回NO。具体的替换操作的方法我就不详细解释了,大家看名字也应该能看明白。

有人可能会问,为什么要考虑case1这种情况呢?直接全部使用case2不行么?答案是不行!因为class_getInstanceMethod()会查找父类,若原Class未实现,则会替换掉了父类的方法。这并不是我们想要的。

这里替换掉父类的方法也许影响不大,不过为了保险起见,我们最好还是只替换掉所需Class的方法

【迁移】Method Swizzling(一)_第3张图片
swizzling_finally.jpeg

这是Swizzling之后的流程图:

  1. 外部调用-setObject:forKey:的SEL,会跳转到-overrideSetObject:forKey:的IMP
  2. 在-overrideSetObject:forKey:的IMP中我们会调用-overrideSetObject:forKey:的SEL
  3. -overrideSetObject:forKey:的SEL对应着-setObject:forKey:的IMP

这时候大家应该明白了前面提到的问题:为什么-overrideSetObject:forKey:的实现中会调用自己了吧?

But……

事情还没完,当我用上面的代码准备Swizzling的时候,结果发现Swizzling无效……
原来对于NSDictionary来说,使用的是Class Cluster(类族)。

Class clusters are a design pattern that the Foundation framework makes extensive use of. Class clusters group a number of private concrete subclasses under a public abstract superclass. The grouping of classes in this way simplifies the publicly visible architecture of an object-oriented framework without reducing its functional richness. Class clusters are based on the Abstract Factory design pattern. ---------Apple document

简单的说,类族是一种类似抽象工厂的设计模式。对外暴露是一个抽象的类,实际使用是这个抽象类的子类,如图所示,对于Number,在alloc的时候我们生成的其实是Number的子类,例如char,子类中实现了Number抽象类的方法。我们调用Number的方法,实际真正runtime的时候,其实调用的是char的方法

NSDictionary也是使用类族的模式,NSDictionary实际是一个抽象类,实际生成之后是NSDictionary的子类__NSDictionaryM

【迁移】Method Swizzling(一)_第4张图片
Swizzling_NSDictionaryM.png

所以我们对NSDictionary做Swizzling是无效的,我们真正需要的是对__NSDictionaryM做Swizzling,所以需要对Class进行修改,使用new先生成一个对象,再获取他的Class

methodSwizzling([[self new] class], originSel, overrideSel);

So……

完整代码如下所示:

@implementation NSMutableDictionary(Swizzling)

void methodSwizzling(Class class,SEL originSel,SEL overrideSel)
{
    Method originMethod = class_getInstanceMethod(class, originSel);
    Method overrideMethod = class_getInstanceMethod(class, overrideSel);

    if (class_addMethod(class,
                        originSel,
                        method_getImplementation(overrideMethod),
                        method_getTypeEncoding(originMethod)))
    {
        /** case1:NSMutableDictionary中没有-setObject:forKey:的实现 */
        class_replaceMethod(class,
                            overrideSel,
                            method_getImplementation(originMethod),
                            method_getTypeEncoding(originMethod));
    }else{
        /** case2:NSMutableDictionary中有-setObject:forKey:的实现   */
        method_exchangeImplementations(originMethod, overrideMethod);
    }

}

+ (void)load
{
    /** 获取SEL和Method */
    SEL originSel = @selector(setObject:forKey:);
    SEL overrideSel = @selector(overrideSetObject:forKey:);
    
    methodSwizzling([[self new] class], originSel, overrideSel);
}

- (void)overrideSetObject:(id)anObject forKey:(id )aKey;
{
    if (anObject) {
        /** 注意:必须调用自己的方法名 */
        [self overrideSetObject:anObject forKey:aKey];
    }
}

@end

Danger

虽然Swizzling完成了,但是由于NSDictionary是类族,我们不能确保所有生成的NSDictionary都是__NSDictionaryM,也许还有其他的类,或者在某一次升级系统之后苹果为了优化某个东西添加了另一个NSDictionary的子类,在用某种方法生成NSDictionary的时候,用的就是这个子类,而不是__NSDictionaryM。虽然这种概率不大,但是这样的风险还是有的,所以最终项目中没有使用Swizzling对-setObject:forKey:进行替换,而是使用-setValue:forKey:

Send -setObject:forKey: to the receiver, unless the value is nil, in which case send -removeObject:forKey:.
---------Apple Document

虽然这里没有使用method Swizzling,但是不可否认,method Swizzling是一个非常强大的工具

参考:

Method Replacement for Fun and Profit

Objective-C的hook方案(一): Method Swizzling

你可能感兴趣的:(【迁移】Method Swizzling(一))