美文网首页
iOS下Runtime的API使用

iOS下Runtime的API使用

作者: Mad_Mark | 来源:发表于2016-12-10 23:05 被阅读154次

    前言
    网上关于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源码

    相关文章

      网友评论

          本文标题:iOS下Runtime的API使用

          本文链接:https://www.haomeiwen.com/subject/fixumttx.html