
本文為投稿文章,作者:劉小壯
公司年底要在新年前發佈一個版本,最近一直很忙,好久沒更新博客了。正好新版本開發得差不多,趁機總結一下。開發過程中難免會引發崩潰,甚至誘發一些老 bug 導致的崩潰,而項目龐大又不易排查,這時我便想起了之前研究過的 Method Swizzling——蘋果的這套「黑魔法」,或許能派上用場。當然,它的用武之地遠不止解決崩潰這一項。
需求場景
我們公司做導航,項目規模龐大,各個控制器的功能都已就緒。某天老板突然要求在所有頁面加上統計功能——用戶進入某頁就記錄一次。針對這樣的需求,通常會想到下面幾種做法。
手動添加
最粗暴的方式就是在每個控制器裡逐一複製粘貼統計代碼。這種方法太 Low,耗時且日後極難維護,接手的人怕是會想罵人。
繼承
利用 OOP 的繼承特性:創建一個基類,把統計方法寫在基類裡,讓其他類都繼承它。但這樣改動依然很大,定製性也差,每來一個新人都得囑咐他繼承這個基類,並不可取。
Category
我們可以為 UIViewController 建一個 Category,並在所有控制器中引入,或者乾脆放進 PCH 文件裡。用 Category 覆蓋系統方法時,系統會優先調用 Category 中的代碼:
#import "UIViewController+EventGather.h" @implementation UIViewController (EventGather) - (void)viewDidLoad { NSLog(@"頁面統計:%@", self); } @endMethod Swizzling
於是就輪到蘋果的「黑魔法」Method Swizzling 登場了,本質上它就是對 IMP 和 SEL 進行交換。
原理
Method Swizzling 發生在運行時,主要用於在運行階段交換兩個方法。它可以寫在任何位置,但只有這段代碼執行完畢後,交換才會生效。同時,它也是 iOS 中 AOP(面向切面編程)的一種實現方式。
先通過兩張圖來理解它的實現原理:

圖一

圖二
圖一中 selector2 原本對應 IMP2,為了滿足特定業務需求,我們在圖二中新增了 selector3 和 IMP3,並讓 selector2 指向 IMP3、selector3 指向 IMP2,這樣就實現了「方法互換」。
在 Objective-C 的 runtime 機制中,調用對象的方法就是給它發送消息:系統查找接收者的方法列表,從中匹配對應的 SEL,再由 SEL 找到 IMP(一個 IMP 可對應多個 SEL)並完成調用。每個類都有一張 Dispatch Table,本質上是 SEL 與 IMP(可理解為函數指針)的映射表,而 Method Swizzling 正是對這張表動手腳,讓 SEL 指向另一個 IMP。
使用方式
核心就是一個 runtime 的 C 語言 API:
OBJC_EXPORT void method_exchangeImplementations(Method m1, Method m2) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
實現思路
以頁面統計需求為例,先給 UIViewController 添加一個 Category,並在 +(void)load 方法中進行方法交換,替換方法也寫在該 Category 裡。之所以選 load,是因為它在類被加載進內存時就會調用,執行較早、無需手動觸發,而且具有唯一性,不必擔心資源爭搶。自定義方法時建議加上前綴以防命名衝突,替換方法的命名至少要在被替換的類中保持唯一。
#import "UIViewController+swizzling.h" #import @implementation UIViewController (swizzling) + (void)load { [super load]; // 通過 class_getInstanceMethod() 從當前對象的 method list 獲取 method 結構體,類方法則用 class_getClassMethod() Method fromMethod = class_getInstanceMethod([self class], @selector(viewDidLoad)); Method toMethod = class_getInstanceMethod([self class], @selector(swizzlingViewDidLoad)); /** * 我們在這裡用 class_addMethod() 做一層驗證:如果 self 沒有實現被交換的方法會導致失敗。 * 而且若 self 沒實現、父類有,就會調用父類方法,結果並非我們所想。 * 所以通過 class_addMethod() 驗證,若 self 已實現該方法,函數返回 NO,我們便可放心交換。 */ if (!class_addMethod([self class], @selector(viewDidLoad), method_getImplementation(toMethod), method_getTypeEncoding(toMethod))) { method_exchangeImplementations(fromMethod, toMethod); } } // 自定義的、與 viewDidLoad 進行交換的方法 - (void)swizzlingViewDidLoad { NSString *str = [NSString stringWithFormat:@"%@", self.class]; // 剔除系統的 UIViewController 對象 if(![str containsString:@"UI"]){ NSLog(@"統計打點 : %@", self.class); } [self swizzlingViewDidLoad]; } @end看到這裡,肯定有人會問:swizzlingViewDidLoad 裡又調用了 [self swizzlingViewDidLoad],難道不會遞歸嗎?答案是——並不會。回想圖一與圖二,Method Swizzling 的本質就是「方法互換」:假設交換 A 和 B,向 A 發消息實際執行 B,向 B 發消息則執行 A。所以當系統調用 viewDidLoad 時,真正跑的是我們的 swizzlingViewDidLoad;而在 swizzlingViewDidLoad 內部調用 [self swizzlingViewDidLoad] 時,執行的其實是系統原本的 viewDidLoad。
類簇問題
項目開發中,我們常遇到 NSArray 越界、NSDictionary 的 key/value 為 nil 等導致的崩潰,而系統不會報警告,直接崩潰。按前面的思路,我們試著對 NSArray、NSMutableArray、NSDictionary、NSMutableDictionary 等做 Method Swizzling,卻發現根本不起作用,代碼也沒寫錯,這是為什麼?
原因是 Method Swizzling 對這些類簇無效。類簇本質上是抽象工廠模式,內部有許多子類,工廠會根據不同情況創建不同對象。例如調用 NSArray 的 objectAtIndex: 時,方法內部會判斷並創建具體的抽象類來執行操作。因此我們對 NSArray 操作只是動了父類,真正幹活的另有其人,應該對它的「真身」下手。
下面實現防止 NSArray 取下標越界崩潰:
#import "NSArray+LXZArray.h" #import "objc/runtime.h" @implementation NSArray (LXZArray) + (void)load { [super load]; Method fromMethod = class_getInstanceMethod(objc_getClass("__NSArrayI"), @selector(objectAtIndex:)); Method toMethod = class_getInstanceMethod(objc_getClass("__NSArrayI"), @selector(lxz_objectAtIndex:)); method_exchangeImplementations(fromMethod, toMethod); } - (id)lxz_objectAtIndex:(NSUInteger)index { if (self.count-1 < index) { // 做一下異常處理,否則出錯了都不知道 @try { return [self lxz_objectAtIndex:index]; } @catch (NSException *exception) { // 崩潰後打印信息,方便調試 NSLog(@"---------- %s Crash Because Method %s ----------\n", class_getName(self.class), __func__); NSLog(@"%@", [exception callStackSymbols]); return nil; } @finally {} } else { return [self lxz_objectAtIndex:index]; } } @end可以看到,__NSArrayI 才是 NSArray 真正的類,而 NSMutableArray 又各不相同。可以通過 runtime 函數獲取真正的類:
objc_getClass("__NSArrayI")下面列舉一些常見類簇的「真身」:

封裝
項目中會頻繁用到 Method Swizzling,且使用時有不少注意事項,因此值得封裝,或直接採用成熟的第三方庫。這裡推薦 GitHub 上星最多的 jrswizzle,核心只有兩個類,代碼十分清爽。
#import @interface NSObject (JRSwizzle) + (BOOL)jr_swizzleMethod:(SEL)origSel_ withMethod:(SEL)altSel_ error:(NSError**)error_; + (BOOL)jr_swizzleClassMethod:(SEL)origSel_ withClassMethod:(SEL)altSel_ error:(NSError**)error_; @end // MethodSwizzle 類 #import BOOL ClassMethodSwizzle(Class klass, SEL origSel, SEL altSel); BOOL MethodSwizzle(Class klass, SEL origSel, SEL altSel);
Method Swizzling 危險嗎?
由於它直接改動類的 Dispatch Table,結果會影響當前類及其所有子類,因此有人認為這是危險技術,用不好容易埋下難以發現和調試的 bug。這個問題可以引用念茜大神的一句話:使用 Method Swizzling 編程,就像切菜時用一把鋒利的刀,有人怕切到自己而畏懼利刃,但事實上鈍刀往往更容易出事,利刀反而更安全。