阅读 1428

警惕swizzle

原文链接

不知道什么时候开始,只要使用了swizzling都能被解读成是AOP开发,开发者张口嘴就是runtime,将其高高捧起,称之为黑魔法;以项目中各种method_swizzling为荣,却不知道这种做法破坏了代码的整体性,使关键逻辑支离破碎。本文基于iOS界的毒瘤一文,从另外的角度谈谈为什么我们应当警惕

调用顺序性

调用顺序性是链接文章讲述的的核心问题,它会破坏方法的原有执行顺序,导致意料之外的错误。先从一段简单的代码聊起:

@interface SLTestObject: NSObject

@end

@implementation SLTestObject

- (instancetype)init {
    self = [super init];
    return self;
}

@end

void testIsSelectorSame() {
    Method allocate1 = class_getClassMethod([NSObject class], @selector(alloc));
    Method allocate2 = class_getClassMethod([SLTestObject class], @selector(alloc));
    
    Method initialize1 = class_getInstanceMethod([NSObject class], @selector(init));
    Method initialize2 = class_getInstanceMethod([SLTestObject class], @selector(init));
    
    assert(allocate1 == allocate2 && initialize1 != initialize2);
}
复制代码

这段代码的目的是证明一个定论:

如果子类没有重写父类声明的方法,在子类对象调用该方法时,执行的是父类实现的代码

基于这一定论,假定一个场景:现在通过无埋点方案统计用户进入和离开Controller次数:

@implementation UIViewController (SLCount)

+ (void)load {
    sl_swizzle([self class], @selector(viewWillAppear:), @selector(sl_viewWillAppearI:));
    sl_swizzle([self class], @selector(viewDidDisappear:), @selector(sl_viewDidDisappearI:));
}

- (void)sl_viewWillAppearI: (BOOL)animated {
    [SLControllerCounter countControllerEnter: [self class]];
    [self sl_viewWillAppearI: animated];
}

- (void)sl_viewDidDisappearI: (BOOL)animated {
    [SLControllerCounter countControllerLeave: [self class]];
    [self sl_viewDidDisappearI: animated];
}

@end
复制代码

由于UIViewController是所有控制器的父类,所以理论上只要swizzle这个类就能统计到所有控制器的信息。同时项目中存在一个定制的基础控制器SLBaseViewController存在这么一段代码:

@implementation SLBaseViewController (SLCount)

+ (void)load {
    sl_swizzle([self class], @selector(viewWillAppear:), @selector(sl_viewWillAppearII:));
    sl_swizzle([self class], @selector(viewDidDisappear:), @selector(sl_viewDidDisappearII:));
}

- (void)sl_viewWillAppearII: (BOOL)animated {
    [self prepareRequest];
    [self sl_viewWillAppearII: animated];
}

- (void)sl_viewDidDisappearII: (BOOL)animated {
    [self sl_viewDidDisappearII: animated];
    [self cancelAllRequests];
}

@end
复制代码

但是这两段代码却在特定的场景下发生crash,发生异常的原因在于子类在没有重写方法的情况下,子类先于父类进行了swizzle的操作。iOS使用中方法名称SEL和方法实现IMP是分开存放的,使用结构体Method将两者关联到一起:

typedef struct Method {
    SEL name;
    IMP imp;
} Method;
复制代码

交换方法会将两个method中的imp进行交换。而在理想情况下,父类先于子类完成了swizzle,原有方法保存了swizzle之后的imp,这时候子类再进行swizzle就能正确调用。下图标识了SELIMP的关联,箭头表示IMP的调用次序:

但是如果子类的swizzle发生的更早,这时候viewWillAppear对应的imp已经被修改,父类再进行swizzle的时候,调用次序已经出错:

解决方式也并不复杂,包括:

  1. swizzle之前先addMethod,保证子类不沿用父类的默认实现
  2. 每次调用通过sel去获取imp执行

具体的实现代码可以参考iOS界的毒瘤的解决方案

行为冲突

OOP的设计中,将描述对象抽象成类,将对象行为抽象成接口。从工程师的角度来说,职责单一的接口更利于迭代维护。类一旦设计好,应当不改动或者少改动接口。对于设计良好的接口来说,swizzle很可能直接破坏了整个接口的行为:

举个例子,crash防护是当下被追捧的工具,但其中KVO的防护或许是一种很烂的手段。从实现来说,为了避免KVO导致的循环引用,需要在引用关系的中间插入一个weakProxy来做防护,因此监听代码实际上可以转换成:

// 表面代码
[observedObj addObserver: self forKeyPath: keyPath options: NSKeyValueObservingOptionNew context: nil];

// 实际效果
WeakProxy *proxy = [WeakProxy new];
proxy.client = self;
[observedObj addObserver: proxy forKeyPath: keyPath options: NSKeyValueObservingOptionNew context: nil];
复制代码

为什么说这种设计很烂的?一旦客户端出现这样的代码:

- (void)dealloc {
    ......
    [observedObj removeObserver: self forKeyPath: keyPath];
}
复制代码

通常情况下,以现在的多数防护工具的实现,都会发生崩溃。对于swizzle代码外的使用者来说,或许根本不清楚observer早已发生了转移,导致了原有的正确调用出错。解决方案之一是对remove接口同样进行swizzle,使得两次调用的监听对象配套:

- (void)sl_removeObserver: (id)observer forKeyPath: (NSString *)keyPath {
    [self sl_removeObserver: observer.proxy forKeyPath: keyPath];
}
复制代码

然而这样做之后,首先KVO的行为已经被修改,接口被破坏可能导致潜在的隐患。其次,如果存在多个防护工具,如果按照weakProxy的实现,那么一旦有2个或者更多的防护时,KVO功能将失效:

OneWeakProxy *proxy = [OneWeakProxy new];
proxy.client = self;    
[observedObj addObserver: proxy forKeyPath: keyPath options: NSKeyValueObservingOptionNew context: nil];

TwoWeakProxy *proxy = [TwoWeakProxy new];
proxy.client = self;    /// self is OneWeakProxy
[observedObj addObserver: proxy forKeyPath: keyPath options: NSKeyValueObservingOptionNew context: nil];
复制代码

在第二次生成WeakProxy后并调用方法后,OneWeakProxy创建的对象被释放。如果要避免多个防护工具对流程造成干扰,还需要做更多额外的工作。况且一旦有其中一个没有完美实现,整套防护机制可能就直接崩溃失效了,因此KVO防护不见得是一种好手段

代码整体性

以上面例子来说,KVONSObject这个基类提供的能力,由于子类默认沿用父类的方法实现这一原则,这种方法的swizzle实际上影响了全部的对象,例如下面的代码实际上效果是完全一样的:

/// swizzle 1
void swizzleTableView() {
    Method ori = class_getClassMethod([UITableView class], @selector(addObserver:forKeyPath:options:context:));
    Method cus = class_getClassMethod([UITableView class], @selector(sl_addObserver:forKeyPath:options:context:));
    method_exchange(ori, cus);
}

/// swizzle 2
void swizzleObj() {
    Method ori = class_getClassMethod([NSObject class], @selector(addObserver:forKeyPath:options:context:));
    Method cus = class_getClassMethod([NSObject class], @selector(sl_addObserver:forKeyPath:options:context:));
    method_exchange(ori, cus);
}
复制代码

而第一个方法由于默认实现是NSObject的,因此一旦发生了swizzle所有的对象都会生效,这存在两个问题:

  1. UITableView对象依旧受到了KVO的拦截影响
  2. 没有sl_addObserver:forKeyPath:options:context:的对象会发生崩溃

另一方面,类的接口设计总是偏向于装扮模式的思维,不同层级的类对象在自己的方法被调用起时会执行自身特有的工作,这种设计让继承有足够的灵活性,从viewDidLoad的实现代码可见一斑:

- (void)viewDidLoad {
    [super viewDidLoad];
    /// setup work
}
复制代码

换句话说,以这种装扮模式思维来构建的代码,如果中间的一个方法被影响甚至破坏了,在中间的这个类开始往下将呈现塌式破坏,可以想象如果UIView一旦出错,应用几乎丧失展示控件的能力。但假如确实需要swizzle的中间环节,必须保证swizzle不对或者尽量少地对子类对象造成影响

关注我的公众号获取更新信息

关注下面的标签,发现更多相似文章
评论