iOS下Runtime的API使用

前言
网上关于runtime的资源也有很多,类和方法具体的实现等等,我就不再重述了。我将通过使用一些runtime提供的api来说明runtime的部分功能。

源码中大段的英文注释说明我就不贴了,我根据我的理解简述参数、返回值和注意点

代码地址

一、获取已注册(已定义类)的列表

OBJC_EXPORT int objc_getClassList(Class *buffer, int bufferCount)
OBJC_AVAILABLE(10.0, 2.0, 9.0, 1.0);

参数

buffer : 一个Class类型的数组的指针;执行这个函数后,这个数组里的指针各指向一个class的定义,如果bufferCount比总数小,那数组中的指针个数就以bufferCount为准。你可以传入一个NULL,来获取所有类定义

bufferCount: 你已经分配在内存空间的指针的个数。如果这个值比已注册类的值小,这个函数会返回一个任意已注册类的子集。

返回值: 一个已注册类的总数

注意点:通过这个函数你不能确保返回的类的数目 就是所有继承NSObject的类的数目

这个类返回的是个数目,但是如果我们要拿到每个类呢,或者是某个类的所有子类呢?
我们先来尝试获取NSObject的所有子类
由于这个函数执行后可以获取到每个class的定义,那么我们可以先申请一块内存,存放所有class的定义,然后再统统塞到一个NSArray里就可以获取到所有类的定义了。

先定义一个Class数组的指针,以及两个整型变量:

Class *class = NULL;
int count, size;

接下来申请内存,存放所有类定义的指针,这里要做一次do循环,原因是你不能确保你一次申请的内存空间足够。

do
{
        //  先通过传入NULL和0来取出所有类的个数
        count = objc_getClassList(NULL, 0);  
        //  重新开辟一块内存,尺寸是 类指针的大小*总数
        class = (__unsafe_unretained Class *)realloc(class, count *sizeof(*class));  
        //  再取一次已分配在内存中的指针的个数
        size = objc_getClassList(class, count);
} while(size != count);    // 判断已分配的数量是否等于count,如果不等于就再来一次

//  经过几次验证 这个do循环一般只执行一次就命中了。

接下来我们要做的是拿到Class数组中的指针,和NSObject做比较,再存入想获取的数组中。因为注意点中也说了,这些并不都是继承NSObject的类。比如NSLeafProxy,什么鬼,反正我没用过。

    NSMutableArray *array = [NSMutableArray array];
    for(int i = 0; i < count; i++)
    {
        // 拿到一个候选者
        Class candidate = class[i];
        // 设置一个superclass,先是等于候选者本身
        Class superclass = candidate;
        // 当这个superclass为空跳出循环
        while(superclass)
        {
            // 循环内我们判断这个superclass是否是NSObject class
            if(superclass == [NSObject class])
            {
                // 如果是则把候选者添加到数组中,跳出循环
                [array addObject: candidate];
                break;
            }
            // 如果不是,我们去获取到他的父类后再进入循环做判断
            superclass = class_getSuperclass(superclass);
        }
    }

最后必须记得,释放掉Class这个数组所分配的内存空间

free(class);

如果我们想查找我们自己定义的类的子类,那么我们可以通过修改if的判断条件即可。

if (superclass == [自定义类 class])

测试:有一个继承自NSObject的类CowObject,有两个继承自Cow的类,Bull和Buffalo,将函数中的自定义类换成CowObject,数组内容如图:

161210_01.png

需要注意的一点,这个方法在查找子类的过程中,会先查到所有已定义的类,所以是个相对消耗比较大的操作。我在我们的项目中测试了一下,还算在可接受范围内。具体消耗的时间,要看项目大小,建议看官最好自己测试一把。

二、创建一个子类

OBJC_EXPORT Class objc_allocateClassPair(Class superclass, const char *name,  size_t extraBytes) 
OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0);

参数

superclass : 你所要创建的子类的爸爸,如果传nil,将创建一个rootClass

name : 你所要创建的子类的类名

extraBytes : 需要额外分配的字节数,通常应该传个0

返回值: 返回一个新的类,可能是nil,比如你传的类名已经被使用了

注意点: 通过这个函数创建一个新的类,之后你需要调用其他的方法来创建类里的方法和变量,当你创建完整个类,需要调用objc_registerClassPair方法。之后这个新的类就可以使用了。你可以通过调用object_getClass(newClass)来获取newClass的元类。实例方法和实例变量需要添加到newClass本身,而类方法需要添加到newClass的元类,也就是metaClass。
还有一点要注意的,通过这个函数来创建的类,则需要调用void objc_disposeClassPair(Class cls)函数来销毁这个类。

这个函数的使用就比较简单了:

+ (Class)createSubClassWithName:(NSString *)className ofSuperClass:(Class)superClass
{
    // className需要转换成C字符串
    Class subClass = objc_allocateClassPair(superClass, [className UTF8String], 0);
    // 注册刚才创建的类
    objc_registerClassPair(subClass);

    if (subClass) return subClass;
    else return nil;
}

测试:
还是第一个实验中的类,在CowObject中添加一个实例方法yell。调用上面代码块中的方法创建一个CowObject的子类,并向这个子类发送yell消息。结果正常执行yell方法。

三、获取某一个类的所有实例方法

OBJC_EXPORT Method *class_copyMethodList(Class cls, unsigned int *outCount) 

参数

cls : 你要获取方法列表的类

outCount : 输出方法个数

返回值: 返回一个method数组

注意点: 这个方法会返回指定类中,所有的实例方法,包括你重写的方法,比如你重写了description方法,或者init方法。并且,还包括这个类中的所有属性的getter&setter方法。
如果你想获取一个类中所有的类方法,你传入的cls应该是一个元类,可以这样用:

class_copyMethodList(object_getClass(cls), &count)

如果你想获取的方法,可能是由superclass来实现的,那你获取方法的时候要用
class_getInstanceMethod 或者 class_getClassMethod

实现也很简单:

+ (NSArray *)obtainMethodList:(Class)currentClass
{
    unsigned int methodCount = 0;
    NSMutableArray *methodArr = [NSMutableArray array];
    // 这个方法会返回指定类中,所有实例方法,包括重写的方法,例如你重写了init;
    // 并包括所有属性的getter&setter方法
    Method *methods = class_copyMethodList(currentClass, &methodCount);
    for (int i = 0; i < methodCount; i++)
    {
        Method temp = methods[i];
        // 这里我们用了method_getName方法来获取这个方法SEL
        SEL sel = method_getName(temp);
        NSString *methodName = NSStringFromSelector(sel);
        [methodArr addObject:methodName];
    }
    // 必须要手动释放掉之前创建的methods数组
    free(methods);

    return [methodArr copy];
}

测试

实现一个类,该类包含一个属性、新增一个实例方法,并重写了一个实例方法

#import "TestMethod.h"

@interface TestMethod ()

@property (nonatomic, assign) Method method;

@end

@implementation TestMethod

- (instancetype)initWithMethod:(Method)method
{
    self = [super init];
    if (self)
    {
        _method = method;
    }
    return self;
}

- (NSString *)description
{
    SEL selName = method_getName(_method);
    return NSStringFromSelector(selName);
}

@end

如果正常,方法列表中应该包含:属性的setter&getter,加上新增和重写的,一共是4个方法。我们用实现的方法调用这个类来试一下:

NSArray *methodList = [Tools obtainMethodList:[TestMethod class]];
NSLog(@"methodList: %@", methodList);

输出结果:


methodList.png

总结:
runtime给我们提供了很多很灵活的方法,但是用好这些方法也要非常小心,有时候结果会是非常出乎意料的。个人对底层也比较感兴趣,但是水平有限,所以还是希望大家能多多指出不足,互相交流,共同进步!

参考
Mike Ash的runtime代码(MRC环境)
runtime源码

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

推荐阅读更多精彩内容