使用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。

本人原创,才疏学浅。转载请注明链接。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容

  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,678评论 0 9
  • 原文出处:南峰子的技术博客 Objective-C语言是一门动态语言,它将很多静态语言在编译和链接时期做的事放到了...
    _烩面_阅读 1,214评论 1 5
  • 这篇文章完全是基于南峰子老师博客的转载 这篇文章完全是基于南峰子老师博客的转载 这篇文章完全是基于南峰子老师博客的...
    西木阅读 30,537评论 33 466
  • 本文转载自:http://southpeak.github.io/2014/10/25/objective-c-r...
    idiot_lin阅读 921评论 0 4
  • 我看到一个偷窥的人。 为什么要偷窥呢? 喜欢,好奇,美丽 …… 于是,在这个下午,我也去偷窥大大的太阳 …… 若可...
    空止阅读 944评论 0 0