52个有效方法(40) - 用块引用其所属对象时不要出现保留环
使用块时,若不仔细思量,则很容易导致“保留环”(retain cycle)。在启动获取器时,可设置completion handler,这个块会在下载结束之后以回调方式执行。为了能在下载完成后通过p_requestCompleted方法执行调用者所指定的块这段代码需要把completion handler保存到实例变量里面。
typedef void (^EOCNetworkFetcherCompletionHandler)(NSData *data);
@interface EOCNetworkFetcher : NSObject
@property (nonatomic, strong, readonly) NSURL *url;
- (id)initWithURL:(NSURL *)url;
- (void)startWithCompletionHandler:(EOCNetworkFetcherCompletionHandler)completion;
@end
@interface EOCNetworkFetcher()
@property (nonatomic, strong, readwrite) NSURL *url;
@property (nonatomic, copy) EOCNetworkFetcherCompletionHandler completionHandler;
@property (nonatomic, strong) NSData *downloadData;
@end
@implementation EOCNetworkFetcher
- (instancetype)initWithURL:(NSURL *)url
{
if (self = [super init]) {
_url = url;
}
return self;
}
- (void)startWithCompletionHandler:(EOCNetworkFetcherCompletionHandler)completion
{
self.completionHandler = completion;
//Start the request
//Request sets downloadedData property
//When request is finished, p_requestCompleted is called
}
- (void)p_requestCompleted
{
if (_completionHandler) {
_completionHandler(_downloadData);
}
}
某个类可能会创建这种网络数据获取器对象,并用其从URL中下载数据:
@implementation ViewController
{
EOCNetworkFetcher *_networkFetcher;
NSData *_fetchedData;
}
- (void)downloadData
{
NSURL *url = [NSURL URLWithString:@"www.baidu.com"];
_networkFetcher = [[EOCNetworkFetcher alloc] initWithURL:url];
[_networkFetcher startWithCompletionHandler:^(NSData *data) {
_fetchedData = data;
}];
}
因为completion handler块要设置_fetchedData实例变量,所以它必须捕获self变量(变量捕获详见第37条)。这就是说,handler块保留了创建网络数据获取器的那个EOCClass实例。而EOCClass实例则通过strong实例变量保留了获取器,最后,获取器对象又保留了handler块。
网络数据获取器和拥有它的EOCClass类实例之间构成了保留环
要打破保留环也很容易:要么令_netwrokFetcher实例变量不再引用获取器,要么令获取器的completionHandler属性不再持有handler块。
- (void)p_requestCompleted
{
if (_completionHandler) {
_completionHandler(_downloadData);
self.completionHandler = nil;
}
}
这样一来,只要下载请求执行完毕,保留环就解除了,而获取器对象也将会在必要时为系统所回收。请注意,之所以把completion handler暴露为获取对象的公共属性,那么就不便在执行完下载请求之后直接将其清理掉了,因为既然已经把handler作为属性公布了,那就意味着调用者可以自由使用它,若是此时有在内部将其清理掉的话,则会破坏“封装语义”(encapsulation semantic)。在这种情况下要想打破保留环,只有一个办法可用,那就是强迫调用者在handler代码里自己把completionHandler属性清理干净。可这并不十分合理,因为你无法假定调用者一定会这么做,他们反过来会抱怨你没把内存泄漏问题处理好。
避免在Block里用self造成循环引用
一般来说我们总会在设置Block之后,在合适的时间回调Block,而不希望回调Block的时候Block已经被释放了,所以我们需要对Block进行copy,copy到堆中,以便后用。
当一个Block被Copy的时候,如果你在Block里进行了一些调用,那么将会有一个强引用指向这些调用方法的调用者,有两个规则:
-
如果你是通过引用来访问一个实例变量,那么将强引用至self。
-
如果你是通过值来访问一个实例变量,那么将直接强引用至这个“值”变量。
苹果官方文档里有两个例子来说明这两种情况:
dispatch_async(queue,^{
//instanceVariableisusedbyreference,astrongreferenceismadetoself
doSomethingWithObject(instanceVariable);
});
idlocalVariable=instanceVariable;
dispatch_async(queue,^{
/*
localVariableisusedbyvalue,astrongreferenceismadetolocalVariable
(nottoself)
*/
doSomethingWithObject(localVariable);
});
-
第一种情况相当于用self.xxx来访问实例变量,所以强引用指向了self。
-
第二种情况把实例变量变成了本地临时变量,强引用将直接指向这个本地的临时变量。
-
大多数情况下,我们只用处理第一种情况就行了,因为第二种情况虽然会造成循环引用,但是临时变量很快就被释放了,不会造成真正的循环引用。
处理Block里用self造成的循环引用
__weak typeof(type) 与 __strong typeof(type)。
typeof()可以根据括号里面的变量,自动识别变量类型并返回该类型。__weak弱引用,__strong强引用
- 默认使用方式
__weak __typeof__(self) weakSelf = self;
__strong __typeof__(weakSelf) strongSelf = weakSelf;
- 宏定义使用
//防止Block循环引用
#define weakSelf(object) __weak __typeof__(object) weak##_##object = object;
#define strongSelf(object) __strong __typeof__(weak##_##object) object = weak##_##object;
要点
-
如果块所捕获的对象直接或间接地保留了块本身,那么就得当心保留环问题。
-
一定要找个适当的时机解除保留环,而不能把责任推给API的调用者。