Runtime之增加（五）

在前面的内容中，主要是介绍了Runtime所使用到的基础数据结构和消息转发的流程。接下来将会介绍如何在运行时对代码进行动态的修改。
这一节主要介绍添加。添加包括两类：

• 对所有的类生成的实例进行添加
• 只对特定的某一个实例进行添加

类添加就是和平时在类文件中书写的内容一样。它的作用域为所有由此类生成的实例对象。而实例添加则是指对于当个类所生成的单个实例进行添加。例如使用对于实例（instance）使用setAssociateObject来关联对象。对于这种只影响单个实例的添加，可以看成实例添加。本节只介绍类添加相关内容。

添加类

如果想要生成一个类，可以使用：

objc_allocateClassPair([NSObject class],"DynamicClass",0);
//1.添加一个协议
//2.添加属性和变量
//3.添加方法
objc_registerClassPair(DynamicClass);

动态生成一个类，仅仅只有两步：分配空间和注册。
在objc_allocateClassPair中，需要指定父类，类名和长度。实际使用过程中长度值一般都会填0。其他值我没有试过，但是根据API上的解释这个长度应该是类中所有变量的总长度。具体参考苹果API文档。
在添加完协议、属性、方法和后，需要将类注册到Runtime中去，这个时候需要使用objc_registerClassPair。

添加协议

协议的生成和类的生成步骤其实也是一样的。也是分成两步：分配空间和注册。

 Protocol *dynamicProtocol = objc_allocateProtocol("dynamicProcotol");
//1.添加方法声明，包括required和optional
//2.添加属性声明。这里实际上还是添加的方法。
 objc_registerProtocol(dynamicProtocol);

协议也可以添加属性声明和方法声明。这里需要区分一下在类中间添加属性和方法与在协议中添加有什么样的区别。

首先在讨论区别前，需要区分属性（property）、变量(variable)、合成(synthesize)这三个概念。

• 变量是指需要实际配内存的存储区域。
• 属性是用来修饰变量的内容。例如atomic,copy,strong,weak,assign等。
• 合成是指为变量生成的getter和setter方法。

对于一些老的OC教材里面能够很清晰的看到这几个的不同：

@interface MyClass:NSObject
{
  int foo;//变量
}
@property (nonatomic) int foo;//属性
@end

@implementation MyClass
@synthesize foo; //合成
@end

在对属性进行完区分以后，再来看下协议和类之间的区别：

• 在Protocol中是无法有变量和属性的，只能够有合成。而在Class中都可以有。
• Protocol中都是方法声明，没有实现。而Class中需要有方法的实现。

由此也就可以看出，Protocol就是Java中的接口，只是定下了一个标准。但标准怎么要去实现就完全靠自己了。且Protocol只能添加方法，@property实际上也只是合成了getter和setter方法的声明。

协议中添加合成方法声明

实际上是合成getter和setter方法声明。

- (void)addProperty:(NSString *)propertyName toProtocol:(Protocol *)protocol
{
    //假设添加一个@property (nonatomic,copy) NSString *propertyName;的属性
    objc_property_attribute_t type = {"T",[[NSString stringWithFormat:@"@\"%@\"",NSStringFromClass([NSString class])] UTF8String]};//T = 类型
    objc_property_attribute_t ownership0 = {"C",""};//C = copy
    objc_property_attribute_t ownership1 = {"N",""};//N = nonatomic
    objc_property_attribute_t backingivar = {"V",[[NSString stringWithFormat:@"_%@",propertyName] UTF8String]};
    objc_property_attribute_t attrArray[] = {type,ownership0,ownership1,backingivar};
    //为协议添加一个property。
    protocol_addProperty(protocol, [propertyName UTF8String], attrArray, 4, YES, YES);
}

添加了声明不能代表添加了方法。所以动态添加以后还是无法使用对应的方法。由此感觉动态添加协议有一些鸡肋。
看一下protocol_addProperty的声明：

/** 
 * Adds a property to a protocol. The protocol must be under construction. 
 * 
 * @param proto The protocol to add a property to.
 * @param name The name of the property.
 * @param attributes An array of property attributes.
 * @param attributeCount The number of attributes in \e attributes.
 * @param isRequiredProperty YES if the property (accessor methods) is not optional. 
 * @param isInstanceProperty YES if the property (accessor methods) are instance methods. 
 *  This is the only case allowed fo a property, as a result, setting this to NO will 
 *  not add the property to the protocol at all. 
 */
OBJC_EXPORT void
protocol_addProperty(Protocol * _Nonnull proto, const char * _Nonnull name,
                     const objc_property_attribute_t * _Nullable attributes,
                     unsigned int attributeCount,
                     BOOL isRequiredProperty, BOOL isInstanceProperty)
    OBJC_AVAILABLE(10.7, 4.3, 9.0, 1.0, 2.0);

最后的两个参数时是否是required和是否是instanceProperty。

协议中添加方法声明

//在协议中添加方法声明
- (void)addMethod:(NSString *)methodName toProtocol:(Protocol *)protocol
{
    //1.相当于添加方法声明，不需要方法的实现。
    //最后两个参数是：是否是require方法，是否是实例方法。
    protocol_addMethodDescription(protocol, @selector(methodName), "v@:", YES, YES);
}

和前面添加属性也感觉差不多。也是仅仅只有一个声明，没有实现。所以如果在由其对应类中间直接使用相关方法将会奔溃。如果要使用，还是必须要类中间添加方法。

添加属性

按照前面的内容可以知道变量、属性、合成三者的区别。在Runtime中，你需要分别添加这三个部分。

添加变量

- (BOOL)addVariable:(NSString *)varibleName toClass:(Class)class
{
    BOOL success;
    //1.添加指针类型的变量
    success =class_addIvar(class,[varibleName UTF8String],sizeof(NSString*),log2(sizeof(NSString *)),@encode(NSString *));
    //2.添加基础类型的变量:int ,double, float等
    //添加 int basicVariable;变量
    return success && class_addIvar(class,"basicVariable",sizeof(int),sizeof(int),@encode(int));
}

现在我们再来看一下class_addIvar定义：

/** 
 * Adds a new instance variable to a class.
 * 
 * @return YES if the instance variable was added successfully, otherwise NO 
 *         (for example, the class already contains an instance variable with that name).
 *
 * @note This function may only be called after objc_allocateClassPair and before objc_registerClassPair. 
 *       Adding an instance variable to an existing class is not supported.
 * @note The class must not be a metaclass. Adding an instance variable to a metaclass is not supported.
 * @note The instance variable's minimum alignment in bytes is 1<

在添加变量的时候，一定需要注意添加基础变量和添加id类型的变量是不同的。主要不同是在参数alignment上。基础变量直接传sizeof即可，而类型变量需要传入log2(sizeof)的值。

添加属性

//动态添加一个属性
- (BOOL)addProperty:(NSString *)propertyName toClass:(Class )class
{
    //假设添加一个@property (nonatomic,copy) NSString *propertyName;
    objc_property_attribute_t type = {"T",[[NSString stringWithFormat:@"@\"%@\"",NSStringFromClass([NSString class])] UTF8String]};//T = 类型
    objc_property_attribute_t ownership0 = {"C",""};//C = copy
    objc_property_attribute_t ownership1 = {"N",""};//N = nonatomic
    objc_property_attribute_t backingivar = {"V",[[NSString stringWithFormat:@"_%@",propertyName] UTF8String]};
    objc_property_attribute_t attrArray[] = {type,ownership0,ownership1,backingivar};
    return class_addProperty(class, [propertyName UTF8String], attrArray, 4);
}

和在协议中添加属性的方式一样。

添加方法

无论是getter、setter方法还是普通方法，它们的添加方式都是相同的。具体的例子：

//C语言方法
void dynamicMethod(id class,SEL cur,id para){
    if ([para isKindOfClass:[NSString class]]){
        NSLog(@"这是一个动态添加的方法,参数为：%@",(NSString *)para);
    }
}

- (void)addMethod:(NSString *)methodName toClass:(Class)class
{
    //1.在添加一个方法之前，必要要能够知道函数地址和函数签名。
    //如果没有函数地址和签名，就没办法添加方法。因为方法是依靠IMP执行的。
    class_addMethod(class, @selector(methodName), (IMP)dynamicMethod, "v@:@");
}

在看一下定义：

/** 
 * 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 _Nullable cls, SEL _Nonnull name, IMP _Nonnull imp, 
                const char * _Nullable types) 
    OBJC_AVAILABLE(10.5, 2.0, 9.0, 1.0, 2.0);

types类型 = 返回值类型编码 + self编码 + cmd编码 +参数类型1编码 + 参数类型2编码 ...
self编码固定为@，cmd编码固定为：。所以第一二位其实是固定的。

---

参考：

• Objective-C Runtime