Objective-C的hook方案/ Method Swizzling

Objective-C的hook方案: Method Swizzling

Method Swizzling是改變一個(gè)selector的實(shí)際實(shí)現(xiàn)的技術(shù)。通過(guò)這一技術(shù),我們可以在運(yùn)行時(shí)通過(guò)修改類的分發(fā)表中selector對(duì)應(yīng)的函數(shù),來(lái)修改方法的實(shí)現(xiàn)。

Method Swizzling 原理

在Objective-C中調(diào)用一個(gè)方法,其實(shí)是向一個(gè)對(duì)象發(fā)送消息,查找消息的唯一依據(jù)是selector的名字。利用Objective-C的動(dòng)態(tài)特性,可以實(shí)現(xiàn)在運(yùn)行時(shí)偷換selector對(duì)應(yīng)的方法實(shí)現(xiàn),達(dá)到給方法掛鉤的目的。 每個(gè)類都有一個(gè)方法列表,存放著selector的名字和方法實(shí)現(xiàn)的映射關(guān)系。IMP有點(diǎn)類似函數(shù)指針,指向具體的Method實(shí)現(xiàn)。

  • 我們可以利用 method_exchangeImplementations 來(lái)交換2個(gè)方法中的IMP;
  • 我們可以利用 class_replaceMethod 來(lái)修改類;
  • 我們可以利用 method_setImplementation 來(lái)直接設(shè)置某個(gè)方法的IMP。
    …… 歸根結(jié)底,就是偷換了selector的IMP

Method Swizzling 實(shí)踐

舉個(gè)例子:我們想跟蹤在程序中每一個(gè) viewController 展示給用戶的次數(shù):當(dāng)然,我們可以在每個(gè)viewController 的 viewDidAppear 中添加跟蹤代碼;但是這太過(guò)麻煩,需要在每個(gè)view controller中寫重復(fù)的代碼。創(chuàng)建一個(gè)子類可能是一種實(shí)現(xiàn)方式,但需要同時(shí)創(chuàng)建 UIViewController, UITableViewController, UINavigationController 及其它 UIKit中viewController 的子類,這同樣會(huì)產(chǎn)生許多重復(fù)的代碼。 這種情況下,我們就可以使用Method Swizzling,如在代碼所示:

import <objc/runtime.h>

@implementation HYHMainViewController

+ (void)load {

       static dispatch_once_t onceToken;
   dispatch_once(&onceToken, ^{

       Class class = [self class];    
 
       SEL originalSelector = @selector(viewWillAppear:);
       SEL swizzledSelector = @selector(my_viewWillAppear:);

       Method originalMethod = class_getInstanceMethod(class, originalSelector);
       Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);

        BOOL didAddMethod =
                   class_addMethod(class,
           originalSelector,
           method_getImplementation(swizzledMethod),
           method_getTypeEncoding(swizzledMethod));

       if (didAddMethod) {/ 判斷是否已經(jīng)有這個(gè)方法了

           class_replaceMethod(class,
           swizzledSelector,
           method_getImplementation(originalMethod),
           method_getTypeEncoding(originalMethod));

       } else {

           method_exchangeImplementations(originalMethod, swizzledMethod);

      }
   });
}


-(void)viewWillAppear:(BOOL)animated{

   [super viewWillAppear:animated];
   NSLog(@"??我在swiz_viewWillAppear執(zhí)行之后執(zhí)行的這段代碼");

}
@end


- (void)my_viewWillAppear:(BOOL)animated{

   //插入需要執(zhí)行的代碼
   NSLog(@"?我在viewWillAppear執(zhí)行前偷偷插入了一段代碼");
   //不能干擾原來(lái)的代碼流程,插入代碼結(jié)束后要讓本來(lái)該執(zhí)行的代碼繼續(xù)執(zhí)行
   [self my_viewWillAppear:animated];

}
 @end

打印的Log:

2016-05-25 11:22:27.028 xiaoHong[1340:58547] ?我在viewWillAppear執(zhí)行前偷偷插入了一段代碼   
2016-05-25 11:22:27.028 xiaoHong[1340:58547] ??我在swiz_viewWillAppear執(zhí)行之后執(zhí)行的這段代碼  

在這里,我們通過(guò) method swizzling 修改了 UIViewController 的@selector(viewWillAppear:)對(duì)應(yīng)的函數(shù)指針,使其實(shí)現(xiàn)指向了我們自定義的 my_viewWillAppear 的實(shí)現(xiàn)。這樣,當(dāng) UIViewController 及其子類的對(duì)象調(diào)用 viewWillAppear 時(shí),都會(huì)打印一條日志信息。

上面的例子很好地展示了使用method swizzling在一個(gè)類中注入一些我們新的操作。當(dāng)然,還有許多場(chǎng)景可以使用method swizzling,在此不多舉例。

使用 Method Swizzling 編程就好比切菜時(shí)使用鋒利的刀,一些人因?yàn)閾?dān)心切到自己所以害怕鋒利的刀具,可是事實(shí)上,使用鈍刀往往更容易出事,而利刀更為安全。 Method swizzling 可以幫助我們寫出更好的,更高效的,易維護(hù)的代碼。但是如果濫用它,也將會(huì)導(dǎo)致難以排查的bug。 在此我們說(shuō)說(shuō)使用method swizzling需要注意的一些問(wèn)題:

Swizzling應(yīng)該總是在+load中執(zhí)行

在Objective-C中,運(yùn)行時(shí)會(huì)自動(dòng)調(diào)用每個(gè)類的兩個(gè)方法。

  • +load會(huì)在類初始加載時(shí)調(diào)用,+initialize會(huì)在第一次調(diào)用類的類方法或?qū)嵗椒ㄖ氨徽{(diào)用。這兩個(gè)方法是可選的,且只有在實(shí)現(xiàn)了它們時(shí)才會(huì)被調(diào)用。由于method swizzling會(huì)影響到類的全局狀態(tài),因此要盡量避免在并發(fā)處理中出現(xiàn)競(jìng)爭(zhēng)的情況。

  • +load能保證在類的初始化過(guò)程中被加載,并保證這種改變應(yīng)用級(jí)別的行為的一致性。相比之下,+initialize在其執(zhí)行時(shí)不提供這種保證—事實(shí)上,如果在應(yīng)用中沒(méi)有給這個(gè)類發(fā)送消息,則它可能永遠(yuǎn)不會(huì)被調(diào)用。

多個(gè)有繼承關(guān)系的類的對(duì)象swizzle時(shí),先從父對(duì)象開(kāi)始。 這樣才能保證子類方法拿到父類中的被swizzle的實(shí)現(xiàn)。在+(void)load中swizzle不會(huì)出錯(cuò),就是因?yàn)閘oad類方法會(huì)默認(rèn)從父類開(kāi)始調(diào)用。

Swizzling應(yīng)該總是在dispatch_once中執(zhí)行

與上面相同,因?yàn)閟wizzling會(huì)改變?nèi)譅顟B(tài),所以我們需要在運(yùn)行時(shí)采取一些預(yù)防措施。原子性就是這樣一種措施,它確保代碼只被執(zhí)行一次,不管有多少個(gè)線程。GCD的dispatch_once可以確保這種行為,我們應(yīng)該將其作為method swizzling的最佳實(shí)踐。

選擇器、方法與實(shí)現(xiàn)

在Objective-C中,選擇器(selector)、方法(method)和實(shí)現(xiàn)(implementation)是運(yùn)行時(shí)中一個(gè)特殊點(diǎn),雖然在一般情況下,這些術(shù)語(yǔ)更多的是用在消息發(fā)送的過(guò)程描述中。 以下是Objective-C Runtime Reference中的對(duì)這幾個(gè)術(shù)語(yǔ)一些描述:

  1. Selector(typedef struct objc_selector *SEL):用于在運(yùn)行時(shí)中表示一個(gè)方法的名稱。一個(gè)方法選擇器是一個(gè)C字符串,它是在Objective-C運(yùn)行時(shí)被注冊(cè)的。選擇器由編譯器生成,并且在類被加載時(shí)由運(yùn)行時(shí)自動(dòng)做映射操作。

  2. Method(typedef struct objc_method *Method):在類定義中表示方法的類型

  3. Implementation(typedef id (*IMP)(id, SEL, …)):這是一個(gè)指針類型,指向方法實(shí)現(xiàn)函數(shù)的開(kāi)始位置。這個(gè)函數(shù)使用為當(dāng)前CPU架構(gòu)實(shí)現(xiàn)的標(biāo)準(zhǔn)C調(diào)用規(guī)范。每一個(gè)參數(shù)是指向?qū)ο笞陨淼闹羔?self),第二個(gè)參數(shù)是方法選擇器。然后是方法的實(shí)際參數(shù)。

理解這幾個(gè)術(shù)語(yǔ)之間的關(guān)系最好的方式是:一個(gè)類維護(hù)一個(gè)運(yùn)行時(shí)可接收的消息分發(fā)表;分發(fā)表中的每個(gè)入口是一個(gè)方法(Method),其中key是一個(gè)特定名稱,即選擇器(SEL),其對(duì)應(yīng)一個(gè)實(shí)現(xiàn)(IMP),即指向底層C函數(shù)的指針。 為了swizzle一個(gè)方法,我們可以在分發(fā)表中將一個(gè)方法的現(xiàn)有的選擇器映射到不同的實(shí)現(xiàn),而將該選擇器對(duì)應(yīng)的原始實(shí)現(xiàn)關(guān)聯(lián)到一個(gè)新的選擇器中。

調(diào)用_cmd
我們回過(guò)頭來(lái)看看前面新的方法的實(shí)現(xiàn)代碼:

- (void)my_viewWillAppear:(BOOL)animated {

   [self my_viewWillAppear:animated];
   NSLog(@"viewWillAppear: %@", NSStringFromClass([self class]));

}

第一眼看上去是會(huì)導(dǎo)致無(wú)限循環(huán)的。但令人驚奇的是,并沒(méi)有出現(xiàn)這種情況。在swizzling的過(guò)程中,方法中的[self my_viewWillAppear:animated]已經(jīng)被重新指定到UIViewController類的-viewWillAppear:中。在這種情況下,不會(huì)產(chǎn)生無(wú)限循環(huán)。不過(guò)如果我們調(diào)用的是[self viewWillAppear:animated],則會(huì)產(chǎn)生無(wú)限循環(huán),因?yàn)檫@個(gè)方法的實(shí)現(xiàn)在運(yùn)行時(shí)已經(jīng)被重新指定為my_viewWillAppear:了。

**注意事項(xiàng)**
Swizzling通常被稱作是一種黑魔法,容易產(chǎn)生不可預(yù)知的行為和無(wú)法預(yù)見(jiàn)的后果。雖然它不是最安全的,但如果遵從以下幾點(diǎn)預(yù)防措施的話,還是比較安全的:

  1. 總是調(diào)用方法的原始實(shí)現(xiàn)(除非有更好的理由不這么做):API提供了一個(gè)輸入與輸出約定,但其內(nèi)部實(shí)現(xiàn)是一個(gè)黑盒。Swizzle一個(gè)方法而不調(diào)用原始實(shí)現(xiàn)可能會(huì)打破私有狀態(tài)底層操作,從而影響到程序的其它部分。
  2. 避免沖突:給自定義的分類方法加前綴,從而使其與所依賴的代碼庫(kù)不會(huì)存在命名沖突。例如 - (void)my_viewWillAppear:(BOOL)animated;這樣避免了selector的命名沖突。
  3. 明白是怎么回事:簡(jiǎn)單地拷貝粘貼swizzle代碼而不理解它是如何工作的,不僅危險(xiǎn),而且會(huì)浪費(fèi)學(xué)習(xí)Objective-C運(yùn)行時(shí)的機(jī)會(huì)。閱讀Objective-C Runtime Reference和查看<objc/runtime.h>頭文件以了解事件是如何發(fā)生的。
  4. 小心操作:無(wú)論我們對(duì)Foundation, UIKit或其它內(nèi)建框架執(zhí)行Swizzle操作抱有多大信心,需要知道在下一版本中許多事可能會(huì)不一樣。

結(jié)論
如果使用恰當(dāng),Method swizzling 還是很安全的.一個(gè)簡(jiǎn)單安全的方法是,僅在load中swizzle。 和許多其他東西一樣,它也是有危險(xiǎn)性的,但理解它了也就可以正確恰當(dāng)?shù)氖褂盟恕?/p>

Method Swizzling 的封裝

//  NSObject+HYHSwizzle.m
//  xiaoHong
//  Created by 黃艷紅 on 16/5/23.
//  Copyright ? 2016年 9fbank. All rights reserved.

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

@implementation NSObject (HYHSwizzle)

+ (IMP)swizzleSelector:(SEL)origSelector withIMP:(IMP)newIMP {

     Class class = [self class];
     Method origMethod = class_getInstanceMethod(class, origSelector);

     IMP origIMP = method_getImplementation(origMethod);

          if(!class_addMethod(self, origSelector, newIMP, method_getTypeEncoding(origMethod))) {  
          
    method_setImplementation(origMethod, newIMP);  
    
   }
    return origIMP;
 }
@end
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 轉(zhuǎn)至元數(shù)據(jù)結(jié)尾創(chuàng)建: 董瀟偉,最新修改于: 十二月 23, 2016 轉(zhuǎn)至元數(shù)據(jù)起始第一章:isa和Class一....
    40c0490e5268閱讀 2,078評(píng)論 0 9
  • 我們常常會(huì)聽(tīng)說(shuō) Objective-C 是一門動(dòng)態(tài)語(yǔ)言,那么這個(gè)「動(dòng)態(tài)」表現(xiàn)在哪呢?我想最主要的表現(xiàn)就是 Obje...
    Ethan_Struggle閱讀 2,347評(píng)論 0 7
  • 繼上Runtime梳理(四) 通過(guò)前面的學(xué)習(xí),我們了解到Objective-C的動(dòng)態(tài)特性:Objective-C不...
    小名一峰閱讀 848評(píng)論 0 3
  • 這篇文章完全是基于南峰子老師博客的轉(zhuǎn)載 這篇文章完全是基于南峰子老師博客的轉(zhuǎn)載 這篇文章完全是基于南峰子老師博客的...
    西木閱讀 30,893評(píng)論 33 466
  • 前言 到了今天終于要"出院"了,要總結(jié)一下住院幾天的收獲,談?wù)凴untime到底能為我們開(kāi)發(fā)帶來(lái)些什么好處。當(dāng)然它...
    一縷殤流化隱半邊冰霜閱讀 23,599評(píng)論 56 317

友情鏈接更多精彩內(nèi)容