iOS - Runtime-API

1. Runtime应用

开发过程中经常会用到Runtime，比如：

1.1 字典转模型

• 利用Runtime遍历所有的属性或者成员变量
• 利用KVC设值

1.2 替换方法实现

• class_replaceMethod
• method_exchangeImplementations

1.3 利用关联对象给分类添加属性

1.4 利用消息转发机制，解决方法找不到的异常问题

2. Runtime-API

2.1 Runtime API01 – 类

2.1.1 动态创建一个类（参数：父类，类名，额外的内存空间）

• Class objc_allocateClassPair(Class superclass, const char *name, size_t extraBytes)

2.2.1.1 示例

// 动态创建一个类
Class newClass = objc_allocateClassPair([NSObject class], "ZSXDog", 0);
id dog = [[newClass alloc] init];
NSLog(@"");

执行结果：

2.2.1 注册一个类（要在类注册之前添加成员变量）

• void objc_registerClassPair(Class cls)

2.2.2.1 示例

// 注册类
objc_registerClassPair(newClass);

2.2.3 销毁一个类

• void objc_disposeClassPair(Class cls)

2.2.4 获取isa指向的Class

• Class object_getClass(id obj)

2.2.5 设置isa指向的Class

• Class object_setClass(id obj, Class cls)

2.2.5.1 示例

ZSXPerson *person = [[ZSXPerson alloc] init];
[person run];
    
// 设置isa指向的Class
object_setClass(person, [ZSXCat class]);
[person run];

执行结果：

2.2.5.2 调试信息

2.2.6 判断一个OC对象是否为Class

• BOOL object_isClass(id obj)

2.2.6.1 示例

ZSXPerson *person = [[ZSXPerson alloc] init];
NSLog(@"%d %d %d", object_isClass(person), object_isClass([ZSXPerson class]), object_isClass(object_getClass([ZSXPerson class])));

执行结果：

2.2.7 判断一个Class是否为元类

• BOOL class_isMetaClass(Class cls)

2.2.7.1 示例

NSLog(@"%d %d", class_isMetaClass([ZSXPerson class]), class_isMetaClass(object_getClass([ZSXPerson class])));

执行结果：

2.2.8 获取父类

• Class class_getSuperclass(Class cls)

2.2 Runtime API02 – 成员变量

2.2.1 获取一个实例变量信息

• Ivar class_getInstanceVariable(Class cls, const char *name)

2.2.2 拷贝实例变量列表（最后需要调用free释放）

• Ivar *class_copyIvarList(Class cls, unsigned int *outCount)

2.2.3 设置和获取成员变量的值

• void object_setIvar(id obj, Ivar ivar, id value)
• id object_getIvar(id obj, Ivar ivar)

2.2.4 动态添加成员变量（已经注册的类是不能动态添加成员变量的）

• BOOL class_addIvar(Class cls, const char * name, size_t size, uint8_t alignment, const char * types)

2.2.5 获取成员变量的相关信息

• const char *ivar_getName(Ivar v)
• const char *ivar_getTypeEncoding(Ivar v)

2.3 Runtime API03 – 属性

2.3.1 获取一个属性

• objc_property_t class_getProperty(Class cls, const char *name)

2.3.2 拷贝属性列表（最后需要调用free释放）

• objc_property_t *class_copyPropertyList(Class cls, unsigned int *outCount)

2.3.3 动态添加属性

BOOL class_addProperty(Class cls, const char *name, const objc_property_attribute_t *attributes,
unsigned int attributeCount)

2.3.4 动态替换属性

• void class_replaceProperty(Class cls, const char *name, const objc_property_attribute_t *attributes,
  unsigned int attributeCount)

2.3.5 获取属性的一些信息

• const char *property_getName(objc_property_t property)
• const char *property_getAttributes(objc_property_t property)

2.4 Runtime API04 – 方法

2.4.1 获得一个实例方法、类方法

• Method class_getInstanceMethod(Class cls, SEL name)
• Method class_getClassMethod(Class cls, SEL name)

2.4.2 方法实现相关操作

• IMP class_getMethodImplementation(Class cls, SEL name)
• IMP method_setImplementation(Method m, IMP imp)
• void method_exchangeImplementations(Method m1, Method m2)

2.4.3 拷贝方法列表（最后需要调用free释放）

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

2.4.4 动态添加方法

• BOOL class_addMethod(Class cls, SEL name, IMP imp, const char *types)

2.4.5 动态替换方法

• IMP class_replaceMethod(Class cls, SEL name, IMP imp, const char *types)

2.4.6 获取方法的相关信息（带有copy的需要调用free去释放）

• SEL method_getName(Method m)
• IMP method_getImplementation(Method m)
• const char *method_getTypeEncoding(Method m)
• unsigned int method_getNumberOfArguments(Method m)
• char *method_copyReturnType(Method m)
• char *method_copyArgumentType(Method m, unsigned int index)

3. 示例

3.1 示例1

// 动态创建一个类
Class newClass = objc_allocateClassPair([NSObject class], "ZSXDog", 0);
// 添加成员变量
class_addIvar(newClass, "_age", 4, 1, @encode(int));
class_addIvar(newClass, "_weight", 4, 1, @encode(int));
// 动态添加方法
class_addMethod(newClass, @selector(run), (IMP)run, "v@:");
    
// 注册类
objc_registerClassPair(newClass);
    
id dog = [[newClass alloc] init];
[dog setValue:@10 forKey:@"_age"];
[dog setValue:@20 forKey:@"_weight"];
[dog run];
    
NSLog(@"%@ %@", [dog valueForKey:@"_age"], [dog valueForKey:@"_weight"]);
    
// 在不需要的时候释放
dog = nil; //需要先释放示例对象
objc_disposeClassPair(newClass); //注销类

执行结果：

3.2 示例2

@interface ZSXPerson : NSObject

@property (nonatomic, assign) int age;
@property (nonatomic, copy) NSString *name;

@end

// 获取成员变量信息
Ivar ageIvar = class_getInstanceVariable([ZSXPerson class], "_age");
NSLog(@"%s %s", ivar_getName(ageIvar), ivar_getTypeEncoding(ageIvar));
    
// 设置和获取成员变量的值
Ivar nameIvar = class_getInstanceVariable([ZSXPerson class], "_name");
    
ZSXPerson *person = [[ZSXPerson alloc] init];
object_setIvar(person, nameIvar, @"123");
//        object_setIvar(person, ageIvar, @10); //不能直接这样设置
object_setIvar(person, ageIvar, (__bridge id)(void *)10); //需要转成指针变量
    
NSLog(@"%@ %d", person.name, person.age);

执行结果：

3.3 示例3

@interface ZSXPerson : NSObject

@property (nonatomic, assign) int age;
@property (nonatomic, copy) NSString *name;

@end

// 成员列表数量
unsigned int count;
Ivar *ivars = class_copyIvarList([ZSXPerson class], &count);
// 遍历打印成员变量
for (int i = 0; i < count; i++) {
    // 取出 i 位置的成员变量
    Ivar ivar = ivars[i];
    NSLog(@"%s %s", ivar_getName(ivar), ivar_getTypeEncoding(ivar));
}

执行结果：

@oubijiexi