用关联对象的方式为Category添加属性

Category是一个Objective-C语法中允许你用额外的方法扩展类的一个很不错的的特性;它通过直接为类添加方法的方式帮我们写出简洁的的代码,故被称作天生的面向对象的方法。

下面是个典型的分类方法的例子,这里我们给NSString添加了一个isNumeric方法:

@interface NSString (NumberUtils)
 
- (BOOL)isNumeric;
 
@end
 
@implementation NSString (NumberUtils)
 
- (BOOL)isNumeric
{
    NSScanner *scanner = [NSScanner scannerWithString:self];
    return [scanner scanFloat:NULL]? [scanner isAtEnd]: NO;
}
 
@end

在分类中你是可以声明新属性的,但是你不能synthesize他们。因为通过分类添加一个实例变量到一个类上在语法上是不可行的--类的内部数据结构在编译的时候已经确定了,分类是不能改变的(因为分类是在运行时的时候才被加载的)。

你可以通过getter/setter方法创造一个在语义上相似的虚拟属性,但这是不被变量支持的。例如,我们可以声明上面的isNumeric方法作为一个只读的属性,如下:

@interface NSString (NumberUtils)
 
@property (nonatomic, readonly, getter=isNumeric) BOOL numeric;
 
@end

做完之后看起来我们可以使用属性的语法去调用方法了,但是如果我们想要在类中保存额外数据的时候,我们是不可能在这个属性中取到我们想要的数据的;

假设我们有一个可以让用户标记(tag)图片的APP,且我们想要保存这个tag值作为每个UIImage对象的一部分.这个tag值可能会是一个逗号分隔的字符串。我们可以在分类中声明这个tag属性,但是如果我们不能用一个变量去保存字符串,那么getter/setter方法又该怎么用呢?

(在你提出疑问之前,我知道正确的解决这个问题的途径可能会是创建一个包含imagetag的一个封装的对象,但假设对于这个示例来说,我们可能没有时间去重构所有的image处理方法去接受一个新的对象类型,毕竟老板此时正在催你及时搞定它!)

拯救你的Runtime

Cocoa的API封装是非常强大的,强大到很多开发者不敢冒险去使用这些表层接口以下的方法,从而错过使用像runtime这样的牛X利器。runtime的其中一个优雅的特征就是它允许你使用一个称为"关联对象"的机制去扩展一个拥有额外数据的对象。

就像这个名字一样,关联对象实质就是去关联一个对象。它使用唯一的一个key值去保存和获取数据,非常像Objective-C中的字典。你可以通过下面这两个runtime函数去getset这些关联的对象,在这个被关联的对象销毁的时候,这两个函数所占的空间也会自动释放。

// Get a value associated with the object by key
id objc_getAssociatedObject(id object, const void *key)
 
// Associate a value with the object by key
void objc_setAssociatedObject(id object, const void *key, id value, objc_AssociationPolicy policy)

函数中的参数object就是那个将要被扩展的对象。参数key是唯一一个在整个进程的生命周期中存在的标识。你可以使用NSString来作为这个key值,但是如果你试图使用一个相同文本且地址不同的字符串对象去访问这个值你是不可能访问到的。一个最好的方式是去声明一个私有的静态指针变量作为这个key值的参数。

参数policy是一个定义如何将对象进行保存的常量。这很像是你用来声明属性时使用的属性修饰符atomic/nonatomicretain/copy/assign.

下面是我们如何使用关联对象方式来实现我们标记的图像分类。首先我们在分类头部文件中声明一个tag属性:

@interface UIImage (Tagged)
 
@property (nonatomic, copy) NSString *tag;
 
@end

然后我们用关联对象runtime的方法为这个属性实现settergetter方法:

#import <objc/runtime.h> 
 
static const void *ImageTagKey = &ImageTagKey;
 
@implementation UIImage (Tagged)
 
- (void)setTag:(NSSting *)tag
{
    objc_setAssociatedObject(self, ImageTagKey, tag, OBJC_ASSOCIATION_COPY_NONATOMIC);
}
 
- (NSString *)tag
{
    return objc_getAssociatedObject(self, ImageTagKey);
}
 
@end

下面是一些需要你注意的地方:

  • 我们为关联对象所使用的参数key是一个类型为static const void *的指针。我们需要对这个指针变量进行初始化,否则它的值可能会为NULL(那样作为key值就没有任何意义了),只要它是独一无二的,我们并不在乎这个指针指向的值到底是什么。为了避免分配任何不必要的额外内存空间,我们将它设置为指向自己!这个指针的值和这个指针的唯一的地址是一样的,且是唯一的(因为是static), 同时不会改变(因为是const).

  • 我们使用OBJC_ASSOCIATION_COPY_NONATOMIC为参数policy赋值。这和我们在分类头文件中声明的tag属性的属性修饰符是相对应的。我们用nonatomic是因为这是一个UIKit的类同时我们假设属性只能在主线程中被访问到。当处理的字符串或者其他有mutable子类的类时,使用copy是一个最佳的方式。

将Selector作为Key

在我们需要创建出许多的分类属性时,以上述的方式定义出许多的static const keys无疑是一件很烦人的事。还好,现在还有个不错的选择:

Objective-C中的selector其实质上也是一个常量指针。这就意味着它们很适合作为关联对象时的key值。假如你用关联对象的方式去实现一个属性,你可以使用这个属性的getter方法的方法名作为这个key.在我们上面所述的tag例子中,我们可以这样改造它:

#import <objc/runtime.h> 
 
@implementation UIImage (Tagged)
 
- (void)setTag:(NSSting *)tag
{
    objc_setAssociatedObject(self, @selector(tag), tag, OBJC_ASSOCIATION_COPY_NONATOMIC);
}
 
- (NSString *)tag
{
    return objc_getAssociatedObject(self, @selector(tag));
}
 
@end

这种方法除了使代码更简洁外,没有什么特别的优点。唯一潜在的缺点是,这种方式使的从外部获得类中相关联的对象更容易。静态key是真正的private,但@selector确是public的。鉴于我们是使用相关联的对象来实现public的属性这一情况,不管怎么看,以上都是没毛病的。

一些注意点

有一些类型的对象,你不应该试图去和其他对象进行关联:

对于值类型(不可变且用于数据传输的对象,如NSStringNSNumber, NSValue, UIColor, NSIndexPath等等),iOS中使用一种被称为de-duplication(重复数据删除)的方式来减少内存开销和提高性能。de-duplication意味着用一个实例替换多个相同的对象。对NSString而言这意味着相同的两个字符串文本即使分别被初始化,可能最终在幕后也只会映射到同一个对象。

通常情况下,de-duplication方式不会影响你编写代码,因为你不需要关心两个具有相同值的NSStringNSNumber对象是否是完全相同的对象。那是因为你总是用isEqual:方法而不是用 == 来比较两者。但当你用一个值类型如NSString真正来关联一个对象时,你会发现你关联过的字符串突然间被另一个实例对象所替换了,或者另一个没有任何联系的字符串变量已经继承了这种相同的关联。

当然在正常使用情况下你不太可能想把对象和值类型进行关联,但这还是需要你记住。

延伸阅读

更多信息请参阅苹果的Objective-C Runtime Reference

出处

本文翻译自iCarousel框架的作者Nick Lockwood的一篇写Runtime的博客Adding Properties to a Category Using Associated Objects;由于本人能力有限,不足之处还望见谅。

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

推荐阅读更多精彩内容