Objective-C Runtime 运行时之二：成员变量与属性

在前面一篇文章中，咱们介绍了Runtime中与类和对象相关的内容，从这章开始，咱们将讨论类实现细节相关的内容，主要包括类中成员变量，属性，方法，协议与分类的实现。

本章的主要内容将汇集在Runtime对成员变量与属性的处理。在讨论以前，咱们先介绍一个重要的概念：类型编码。

类型编码(Type Encoding)

做为对Runtime的补充，编译器将每一个方法的返回值和参数类型编码为一个字符串，并将其与方法的selector关联在一块儿。这种编码方案在其它状况下也是很是有用的，所以咱们可使用@encode编译器指令来获取它。当给定一个类型时，@encode返回这个类型的字符串编码。这些类型能够是诸如int、指针这样的基本类型，也能够是结构体、类等类型。事实上，任何能够做为sizeof()操做参数的类型均可以用于@encode()。

在Objective-C Runtime Programming Guide中的Type Encoding一节中，列出了Objective-C中全部的类型编码。须要注意的是这些类型不少是与咱们用于存档和分发的编码类型是相同的。但有一些不能在存档时使用。

注：Objective-C不支持long double类型。@encode(long double)返回d，与double是同样的。

一个数组的类型编码位于方括号中；其中包含数组元素的个数及元素类型。如如下示例：

float a[] = {1.0, 2.0, 3.0};
NSLog(@"array encoding type: %s", @encode(typeof(a)));

输出是：

2014-10-28 11:44:54.731 RuntimeTest[942:50791] array encoding type: [3f]

其它类型可参考Type Encoding，在此不细说。

另外，还有些编码类型，@encode虽然不会直接返回它们，但它们能够做为协议中声明的方法的类型限定符。能够参考Type Encoding。

对于属性而言，还会有一些特殊的类型编码，以代表属性是只读、拷贝、retain等等，详情能够参考Property Type String。

成员变量、属性

Runtime中关于成员变量和属性的相关数据结构并很少，只有三个，而且都很简单。不过还有个很是实用但可能常常被忽视的特性，即关联对象，咱们将在这小节中详细讨论。

基础数据类型

Ivar

Ivar是表示实例变量的类型，其实际是一个指向objc_ivar结构体的指针，其定义以下：

typedef struct objc_ivar *Ivar;

struct objc_ivar {
    char *ivar_name                 OBJC2_UNAVAILABLE;  // 变量名
    char *ivar_type                 OBJC2_UNAVAILABLE;  // 变量类型
    int ivar_offset                 OBJC2_UNAVAILABLE;  // 基地址偏移字节
#ifdef __LP64__
    int space                       OBJC2_UNAVAILABLE;
#endif
}

objc_property_t

objc_property_t是表示Objective-C声明的属性的类型，其实际是指向objc_property结构体的指针，其定义以下：

typedef struct objc_property *objc_property_t;

objc_property_attribute_t

objc_property_attribute_t定义了属性的特性(attribute)，它是一个结构体，定义以下：

typedef struct {
    const char *name;           // 特性名
    const char *value;          // 特性值
} objc_property_attribute_t;

关联对象(Associated Object)

关联对象是Runtime中一个很是实用的特性，不过可能很容易被忽视。

关联对象相似于成员变量，不过是在运行时添加的。咱们一般会把成员变量(Ivar)放在类声明的头文件中，或者放在类实现的@implementation后面。但这有一个缺点，咱们不能在分类中添加成员变量。若是咱们尝试在分类中添加新的成员变量，编译器会报错。

咱们可能但愿经过使用(甚至是滥用)全局变量来解决这个问题。但这些都不是Ivar，由于他们不会链接到一个单独的实例。所以，这种方法不多使用。

Objective-C针对这一问题，提供了一个解决方案：即关联对象(Associated Object)。

咱们能够把关联对象想象成一个Objective-C对象(如字典)，这个对象经过给定的key链接到类的一个实例上。不过因为使用的是C接口，因此key是一个void指针(const void *)。咱们还须要指定一个内存管理策略，以告诉Runtime如何管理这个对象的内存。这个内存管理的策略能够由如下值指定：

OBJC_ASSOCIATION_ASSIGN
OBJC_ASSOCIATION_RETAIN_NONATOMIC
OBJC_ASSOCIATION_COPY_NONATOMIC
OBJC_ASSOCIATION_RETAIN
OBJC_ASSOCIATION_COPY

当宿主对象被释放时，会根据指定的内存管理策略来处理关联对象。若是指定的策略是assign，则宿主释放时，关联对象不会被释放；而若是指定的是retain或者是copy，则宿主释放时，关联对象会被释放。咱们甚至能够选择是不是自动retain/copy。当咱们须要在多个线程中处理访问关联对象的多线程代码时，这就很是有用了。

咱们将一个对象链接到其它对象所须要作的就是下面两行代码：

static char myKey;

objc_setAssociatedObject(self, &myKey, anObject, OBJC_ASSOCIATION_RETAIN);

在这种状况下，self对象将获取一个新的关联的对象anObject，且内存管理策略是自动retain关联对象，当self对象释放时，会自动release关联对象。另外，若是咱们使用同一个key来关联另一个对象时，也会自动释放以前关联的对象，这种状况下，先前的关联对象会被妥善地处理掉，而且新的对象会使用它的内存。

id anObject = objc_getAssociatedObject(self, &myKey);

咱们可使用objc_removeAssociatedObjects函数来移除一个关联对象，或者使用objc_setAssociatedObject函数将key指定的关联对象设置为nil。

咱们下面来用实例演示一下关联对象的使用方法。

假定咱们想要动态地将一个Tap手势操做链接到任何UIView中，而且根据须要指定点击后的实际操做。这时候咱们就能够将一个手势对象及操做的block对象关联到咱们的UIView对象中。这项任务分两部分。首先，若是须要，咱们要建立一个手势识别对象并将它及block作为关联对象。以下代码所示：

- (void)setTapActionWithBlock:(void (^)(void))block
{
    UITapGestureRecognizer *gesture = objc_getAssociatedObject(self, &kDTActionHandlerTapGestureKey);

    if (!gesture)
    {
        gesture = [[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(__handleActionForTapGesture:)];
        [self addGestureRecognizer:gesture];
        objc_setAssociatedObject(self, &kDTActionHandlerTapGestureKey, gesture, OBJC_ASSOCIATION_RETAIN);
    }

    objc_setAssociatedObject(self, &kDTActionHandlerTapBlockKey, block, OBJC_ASSOCIATION_COPY);
}

这段代码检测了手势识别的关联对象。若是没有，则建立并创建关联关系。同时，将传入的块对象链接到指定的key上。注意block对象的关联内存管理策略。

手势识别对象须要一个target和action，因此接下来咱们定义处理方法：

- (void)__handleActionForTapGesture:(UITapGestureRecognizer *)gesture
{
    if (gesture.state == UIGestureRecognizerStateRecognized)
    {
        void(^action)(void) = objc_getAssociatedObject(self, &kDTActionHandlerTapBlockKey);

        if (action)
        {
            action();
        }
    }
}

咱们须要检测手势识别对象的状态，由于咱们只须要在点击手势被识别出来时才执行操做。

从上面的例子咱们能够看到，关联对象使用起来并不复杂。它让咱们能够动态地加强类现有的功能。咱们能够在实际编码中灵活地运用这一特性。

成员变量、属性的操做方法

成员变量

成员变量操做包含如下函数：

// 获取成员变量名
const char * ivar_getName ( Ivar v );

// 获取成员变量类型编码
const char * ivar_getTypeEncoding ( Ivar v );

// 获取成员变量的偏移量
ptrdiff_t ivar_getOffset ( Ivar v );

● ivar_getOffset函数，对于类型id或其它对象类型的实例变量，能够调用object_getIvar和object_setIvar来直接访问成员变量，而不使用偏移量。

关联对象

关联对象操做函数包括如下：

// 设置关联对象
void objc_setAssociatedObject ( id object, const void *key, id value, objc_AssociationPolicy policy );

// 获取关联对象
id objc_getAssociatedObject ( id object, const void *key );

// 移除关联对象
void objc_removeAssociatedObjects ( id object );

关联对象及相关实例已经在前面讨论过了，在此再也不重复。

属性

属性操做相关函数包括如下：

// 获取属性名
const char * property_getName ( objc_property_t property );

// 获取属性特性描述字符串
const char * property_getAttributes ( objc_property_t property );

// 获取属性中指定的特性
char * property_copyAttributeValue ( objc_property_t property, const char *attributeName );

// 获取属性的特性列表
objc_property_attribute_t * property_copyAttributeList ( objc_property_t property, unsigned int *outCount );

● property_copyAttributeValue函数，返回的char *在使用完后须要调用free()释放。

● property_copyAttributeList函数，返回值在使用完后须要调用free()释放。

实例

假定这样一个场景，咱们从服务端两个不一样的接口获取相同的字典数据，但这两个接口是由两我的写的，相同的信息使用了不一样的字段表示。咱们在接收到数据时，可将这些数据保存在相同的对象中。对象类以下定义：

@interface MyObject: NSObject

@property (nonatomic, copy) NSString * name;
@property (nonatomic, copy) NSString * status;

@end

接口A、B返回的字典数据以下所示：

@{@"name1": "张三", @"status1": @"start"}

@{@"name2": "张三", @"status2": @"end"}

一般的方法是写两个方法分别作转换，不过若是能灵活地运用Runtime的话，能够只实现一个转换方法，为此，咱们须要先定义一个映射字典(全局变量)

static NSMutableDictionary *map = nil;

@implementation MyObject

+ (void)load
{
    map = [NSMutableDictionary dictionary];

    map[@"name1"]                = @"name";
    map[@"status1"]              = @"status";
    map[@"name2"]                = @"name";
    map[@"status2"]              = @"status";
}

@end

上面的代码将两个字典中不一样的字段映射到MyObject中相同的属性上，这样，转换方法可以下处理：

- (void)setDataWithDic:(NSDictionary *)dic
{
    [dic enumerateKeysAndObjectsUsingBlock:^(NSString *key, id obj, BOOL *stop) {

        NSString *propertyKey = [self propertyForKey:key];

        if (propertyKey)
        {
            objc_property_t property = class_getProperty([self class], [propertyKey UTF8String]);

            // TODO: 针对特殊数据类型作处理
            NSString *attributeString = [NSString stringWithCString:property_getAttributes(property) encoding:NSUTF8StringEncoding];

            ...

            [self setValue:obj forKey:propertyKey];
        }
    }];
}

固然，一个属性可否经过上面这种方式来处理的前提是其支持KVC。

小结

本章中咱们讨论了Runtime中与成员变量和属性相关的内容。成员变量与属性是类的数据基础，合理地使用Runtime中的相关操做能让咱们更加灵活地来处理与类数据相关的工做。