使用runtime給類動態添加方法并調用 - class_addMethod

同步于博客園,鏈接戳右:http://www.cnblogs.com/chipmuck/p/5807190.html

上手開發 iOS 一段時間后,我發現并不能只著眼于完成需求,利用閑暇之余多研究其他的開發技巧,才能在有限時間內提升自己水平。當然,“其他開發技巧”這個命題對于任何一個開發領域都感覺不找邊際,而對于我來說,嘗試接觸 objc/runtime 不失為是開始深入探索 iOS 開發的第一步。

剛了解 runtime 當然要從比較簡單的 api 開始,今天就羅列整理一下 class_addMethod 的相關點:

首先從文檔開始。

/** 
  * Adds a new method to a class with a given name and implementation. 
  * 
  * @param cls The class to which to add a method. 
  * @param name A selector that specifies the name of the method being added. 
  * @param imp A function which is the implementation of the new method. The function must take at least two arguments—self and _cmd. 
  * @param types An array of characters that describe the types of the arguments to the method. 
  * 
  * @return YES if the method was added successfully, otherwise NO 
  * (for example, the class already contains a method implementation with that name). 
  * 
  * @note class_addMethod will add an override of a superclass's implementation, 
  * but will not replace an existing implementation in this class. 
  * To change an existing implementation, use method_setImplementation. 
  */
  OBJC_EXPORT BOOL class_addMethod(Class cls, SEL name, IMP imp,
                                   const char *types)       
      __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);    

大意翻譯一下,這個方法的作用是,給類添加一個新的方法和該方法的具體實現。分析一下這個方法需要的參數:

Class cls 

cls 參數表示需要添加新方法的類。

SEL name

name 參數表示 selector 的方法名稱,可以根據喜好自己進行命名。

IMP imp

imp 即 implementation ,表示由編譯器生成的、指向實現方法的指針。也就是說,這個指針指向的方法就是我們要添加的方法。

const char *types

最后一個參數 *types 表示我們要添加的方法的返回值和參數。

簡要介紹了 class_addMethod 中所需要的參數以及作用之后,我們就可以開始利用這個方法進行添加我們所需要的方法啦!在使用之前,我們首先要明確 Objective-C 作為一種動態語言,它會將部分代碼放置在運行時的過程中執行,而不是編譯時,所以在執行代碼時,不僅僅需要的是編譯器,也同時需要一個運行時環境(Runtime),為了滿足一些需求,蘋果開源了 Runtime Source 并提供了開放的 api 供開發者使用。

其次,我們需要知道在什么情況下需要調用 class_addMethod 這個方法。當項目中,需要繼承某一個類(subclass),但是父類中并沒有提供我需要的調用方法,而我又不清楚父類中某些方法的具體實現;或者,我需要為這個類寫一個分類(category),在這個分類中,我可能需要替換/新增某個方法(注意:不推薦在分類中重寫方法,而且也無法通過 super 來獲取所謂父類的方法)。大致在這兩種情況下,我們可以通過 class_addMethod 來實現我們想要的效果。

好了,說了這么多那么到底應該如何調用呢?如果不清楚使用方法,那么看說明書就是最好的方法。在 Apple 提供的文檔中就有詳細的使用方法(Objective-C Runtime Programming Guide - Dynamic Method Resolution),以下內容就以 myCar 這個類來詳細說明一下具體的使用規則:

首先,既然要給某個類添加我們的方法,就應該繼承或者給這個類寫一個分類,這里我新建一個名為「myCar」的類,作為「Car」類的分類。

#import "Car+myCar.h"

@implementation Car (myCar)

@end

我們知道,在 Objective-C 中,正常的調用方法是通過消息機制(message)來實現的,那么如果類中沒有找到發送的消息方法,系統就會進入找不到該方法的處理流程中,如果在這個流程中,我們加入我們所需要的新方法,就能實現運行過程中的動態添加了。這個流程或者說機制,就是 Objective-C 的 Message Forwarding

這個機制中所涉及的方法主要有兩個:

+ (BOOL)resolveInstanceMethod:(SEL)sel
+ (BOOL)resolveClassMethod:(SEL)sel

兩個方法的唯一區別在于需要添加的是靜態方法還是實例方法。我們就拿前者來說,既然要添加方法,我們就在「myCar」類中實現它,代碼如下:

#import "Car+myCar.h"

void startEngine(id self, SEL _cmd) { 
    NSLog(@"my car starts the engine");
}

@implementation Car (myCar)

@end

至此,我們實現了我們要添加的 startEngine 這個方法。這是一個 C 語言的函數,它至少包含了 self 和 _cmd 兩個參數(self 代表著函數本身,而 _cmd 則是一個 SEL 數據體,包含了具體的方法地址)。如果要在這個方法中新增參數呢?見如下代碼:

#import "Car+myCar.h"

void startEngine(id self, SEL _cmd, NSString *brand) { 
    NSLog(@"my %@ car starts the engine", brand);
}

@implementation Car (myCar)

@end

只要在那兩個必須的參數之后添加所需要的參數和類型就可以了,返回值同樣道理,只要把方法名之前的 void 修改成我們想要的返回類型就可以,這里我們不需要返回值。

接著,我們重載 resolveInstanceMethod: 這個函數:

#import "Car+myCar.h"
#import <objc/runtime.h>

void startEngine(id self, SEL _cmd, NSString *brand) { 
    NSLog(@"my %@ car starts the engine", brand);
}

@implementation Car (myCar)

+ (BOOL)resolveInstanceMethod:(SEL)sel { 
    if (sel == @selector(drive)) { 
        class_addMethod([self class], sel, (IMP)startEngine, "v@:@"); 
        return YES; 
    } 
    return [super resolveInstanceMethod:sel];
}

@end

解釋一下,這個函數在 runtime 環境下,如果沒有找到該方法的實現的話就會執行。第一行判斷的是傳入的 SEL 名稱是否匹配,接著調用 class_addMethod 方法,傳入相應的參數。其中第三個參數傳入的是我們添加的 C 語言函數的實現,也就是說,第三個參數的名稱要和添加的具體函數名稱一致。第四個參數指的是函數的返回值以及參數內容。

至于該類方法的返回值,在我測試的時候,無論這個 BOOL 值是多少,并不會影響我們的執行目標,一般返回 YES 即可。

如果覺得用 C 語言風格寫新函數比較不適應,那么可以改寫成以下的代碼:

@implementation Car (myCar)

+ (BOOL)resolveInstanceMethod:(SEL)sel { 
    if (sel == @selector(drive)) { 
        class_addMethod([self class], sel, class_getMethodImplementation(self, @selector(startEngine:)), "s@:@");
        return YES; 
    } 
    return [super resolveInstanceMethod:sel];
}

- (void)startEngine:(NSString *)brand { 
    NSLog(@"my %@ car starts the engine", brand);
}

@end

其中 class_getMethodImplementation 意思就是獲取 SEL 的具體實現的指針。
然后創建一個新的類「DynamicSelector」,在這個新類中我們實現對「Car」的動態添加方法。

#import "DynamicSelector.h"
#import "Car+myCar.h"

@implementation DynamicSelector

- (void)dynamicAddMethod { 
    Car *c = [[Car alloc] init]; 
    [c performSelector:@selector(drive) withObject:@"bmw"];
}

@end

注意,在這里就不能使用 [self method:] 進行調用了,因為我們添加的方法是在運行時才執行,而編譯器只負責編譯時的方法檢索,一旦對一個對象沒有檢索到它的 drive 方法,就會報錯,所以這里我們使用 performSelector:withObject: 來進行調用,保存,運行。

2016-08-26 10:50:17.207 objc-runtime[76618:3031897] my bmw car starts the engineProgram ended with exit code: 0

打印結果符合我們期望實現的目標。如果需要返回值,方法類似。

項目已上傳至 https://github.com/zhangqifan/class_addMethod 有需要的可以 clone 源碼,如需指正請 push issue。

本人原創,才疏學淺。轉載請注明鏈接。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • 轉至元數據結尾創建: 董瀟偉,最新修改于: 十二月 23, 2016 轉至元數據起始第一章:isa和Class一....
    40c0490e5268閱讀 1,767評論 0 9
  • 原文出處:南峰子的技術博客 Objective-C語言是一門動態語言,它將很多靜態語言在編譯和鏈接時期做的事放到了...
    _燴面_閱讀 1,252評論 1 5
  • 這篇文章完全是基于南峰子老師博客的轉載 這篇文章完全是基于南峰子老師博客的轉載 這篇文章完全是基于南峰子老師博客的...
    西木閱讀 30,592評論 33 466
  • 本文轉載自:http://southpeak.github.io/2014/10/25/objective-c-r...
    idiot_lin閱讀 951評論 0 4
  • 我看到一個偷窺的人。 為什么要偷窺呢? 喜歡,好奇,美麗 …… 于是,在這個下午,我也去偷窺大大的太陽 …… 若可...
    空止閱讀 989評論 0 0