Weak Associated Object

NSObject对象绑定associated object时可以指定如下依赖关系:

  • OBJC_ASSOCIATION_ASSIGN: 弱引用
  • OBJC_ASSOCIATION_RETAIN_NONATOMIC: 强引用,非原子操作
  • OBJC_ASSOCIATION_COPY_NONATOMIC: 先copy,然后强引用
  • OBJC_ASSOCIATION_RETAIN: 强引用,原子操作
  • OBJC_ASSOCIATION_COPY: 先copy,然后强引用,原子操作

却没有提供OBJC_ASSOCIATION_WEAK这样的选项,我在开发过程中遇到这个问题,本文记录我的浅薄思考和解决方案。

若要搞清楚为啥没有OBJC_ASSOCIATION_WEAK这个选项,得理解associated object的实现原理,以及__weak的实现原理。在runtime源码(或者参考博客Objective-C Associated Objects的实现原理)和《Objective-C高级编程:iOS与OS X多线程和内存管理》中能分别找到关于这两点的答案,本文只作简单描述。

与普通的属性或实例变量不同,Objective-C在底层使用AssociationsManager统一管理各个对象的associated objects,NSObject能做的是通过static key(一般是一个固定值)去访问对应的associated object,然后在dealloc中经过如下调用栈解除对这些关联对象的引用:

dealloc
object_dispose
objc_destructInstance
_object_remove_assocations // 移除必要的associated objects

换句话说,在NSObject对象的内存空间里,并没有为associated objects分配任何变量。

weak变量相对于assign变量的最大魅力在于,若指向的对象被销毁了,前者会被Objective-C设置为nil;后者却没有这样的待遇。这个逻辑是如何实现的呢?简单来说,Runtime在底层维护一个weak表,每每分配一个weak指针并赋值有效对象的地址时,会将对象地址和weak指针地址注册到weak表中,其中对象地址作为key;当对象被废弃时,可根据对象地址快速寻找到指向它的所有weak指针,这些weak指针会被赋值0(即nil)并移出weak表。

综上,实现weak引用(而非assign引用)的前提是存在一个__weak指针指向到被引用对象的地址,只有这样,当对象被销毁时,指针才能被runtime找到然后被设置为nilNSObject对象和其associated object的关系,并不存在指针这样的中间媒介,因此只存在OBJC_ASSOCIATION_ASSIGN选项,而不存在OBJC_ASSOCIATION_WEAK选项。

如何定义Weak Associated Object

然而有时候,安全起见,我们需要在对象和associated object之间建立weak关系,而非assign关系,如何实现呢?其实也简单,话不多说,直接给出一种方案。

定义一个简单对象,该对象提供一个被weak修饰的属性:

@interface WeakAssociatedObjectWrapper : NSObject
@property (nonatomic, weak) id object;
@end
@implementation WeakAssociatedObjectWrapper
@end

需要定义weak associated object时,使用该类对象作为中转:

@interface UIView (ViewController)
@property (nonatomic, weak) UIViewController *vc;
@end
@implementation UIView (ViewController)
- (void)setVc:(UIViewController *)vc {
WeakAssociatedObjectWrapper *wrapper = [WeakAssociatedObjectWrapper new];
wrapper.object = vc;
objc_setAssociatedObject(self, @selector(vc), wrapper, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
- (UIViewController *)vc {
WeakAssociatedObjectWrapper *wrapper = objc_getAssociatedObject(self, _cmd);
return wrapper.object;
}
@end

这种实现方案非常简单直观,堪用!

如何让Weak Associated Object支持KVO

可能还有更贪心的需求:让weak associated object支持KVO。让associated object支持KVO的普通姿势是:

@implementation UIView (ViewController)
// Setter
- (void)setVc:(UIViewController *)vc {
[self willChangeValueForKey:@"vc"];
WeakAssociatedObjectWrapper *wrapper = [WeakAssociatedObjectWrapper new];
wrapper.object = vc;
objc_setAssociatedObject(self, @selector(vc), wrapper, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
[self didChangeValueForKey:@"vc"];
}
@end

但存在问题,UIView#vc是一个weak associated object,简单来说,当vc被释放时,view是得不到任何通知的。

其实,这个问题同样存在于weak property上,当弱持有的对象被释放掉时,runtime会将对应的weak指针赋值为nil;但是操作对象是实例变量本身,而非通过setter,因此无法触发KVO,故而存在逻辑漏洞。

因此,我的看法是:尽可能避免对weak property或者weak associated object进行KVO。

如果实在要这么干,肿么办?我有办法!

首先定义一个类,该类只有一个block,在dealloc中被调用。

@interface DeallocObject : NSObject
@property (nonatomic, copy) void (^deallocBlock)(void);
@end
@implementation DeallocObject
- (void)dealloc {
if (_deallocBlock) {
_deallocBlock();
}
}
@end

OK,基于该DeallocObject实现支持KVO的Setter如下:

- (void)setVc:(UIViewController *)vc {
[self willChangeValueForKey:@"vc"];
objc_setAssociatedObject(self, @selector(vc), vc, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
if (vc) {
@weakify(self, vc);
DeallocObject *dObject = [DeallocObject new];
dObject.deallocBlock = ^{
@strongify(self, vc);
if (self && self.vc == vc) {
self.vc = nil;
}
};
objc_setAssociatedObject(vc, (__bridge const void *)dObject.deallocBlock, dObject, OBJC_ASSOCIATION_RETAIN_NONATOMIC); // 这里是关键
}
[self didChangeValueForKey:@"vc"];
}

这个setter的实现,乍地一看有些复杂,其实也蛮容易掰扯清楚的。简单来说,每当在vc和view之间建立弱引用关系时,为vc创建一个新的associated object,即dObject;vc是dObject的唯一持有者,vc的dealloc触发之前,会先触发dObject的dealloc,也即触发后者的deallocBlock的调用,在该block中,通过setter将UIView#vc设为nil;即通过setter解除依赖关系。需要注意的是,每次为vc绑定associated object时,都得使用一个新的key。

这种奇技淫巧是唯一的选择吗?其不然,另一种解决方案也很容易想到,即对vc的dealloc进行swizzling,如果使用ReactiveCocoa,则更简单了:

- (void)setVc:(UIViewController *)vc
{
[self willChangeValueForKey:@"vc"];
objc_setAssociatedObject(self, @selector(vc), vc, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
if (vc) {
@weakify(self, vc);
[vc.rac_willDeallocSignal subscribeNext:^(id _) {
@strongify(self, vc);
if (self && self.vc == vc) {
self.vc = nil;
}
}];
}
[self didChangeValueForKey:@"vc"];
}

这些解决方案所使用的技术,都比较简单,只是点子没那么容易想到。

最后,仍然还是那句话:尽可能避免对weak property或weak associated object进行KVO。