40.用块引用其所属对象时不要出现保留环

《编写高质量iOS与OS X代码的52个有效方法》--第六章 第40条
（ps：此乃读书笔记，加深记忆，仅供大家参考）

---

第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块。

要打破保留环也很容易：要么令_netwrokFetcher实例变量不再引用获取器，要么令获取器的completionHandler属性不再持有handler块。在网络数据获取器这个例子中，应该等completion handler块执行完毕之后，再去打破保留环，以便使获取器对象在handler块执行期间保持存活状态。比方说，completion handler块的代码可以这么修改：

[_networkFetcher startWithCompletionHandler:^(NSData *data) {
    _fetchedData = data;
    _networkFetcher = nil;
}];

网络数据获取器和拥有它的EOCClass类实例之间构成了保留环

在本例中，唯有completion handler运行过后，方能解除保留环。若是completion handler一直不运行，那么保留环就无法打破，于是内存就会泄露。

像completion handler块这种写法，还可能引入另外一种形式的保留环。如果completion handler块所引用的对象最终又引用了这个块本身，那么就会出现保留环。

- (void)downloadData
{
    NSURL *url = [NSURL URLWithString:@"www.baidu.com"];
    EOCNetworkFetcher *networkFetcher = [[EOCNetworkFetcher alloc] initWithURL:url];

    [networkFetcher startWithCompletionHandler:^(NSData *data) {
        _fetchedData = data;
    }];
}

而这次比刚才那个例子更难于发觉，completion handler块其实要通过获取器对象来引用其中的URL。于是，块就要保留获取器，而获取器反过来又经由其completionHandler属性保留了这个块。回想一下，获取器对象之所以要把completionHandler块保存在属性里面，其唯一目的就是想稍后使用这个块。可是，获取器一旦运行过completion handler之后，就没有必要在保留它了。

- (void)p_requestCompleted
{
    if (_completionHandler) {
        _completionHandler(_downloadData);
        self.completionHandler = nil;
    }
}

这样一来，只要下载请求执行完毕，保留环就解除了，而获取器对象也将会在必要时为系统所回收。请注意，之所以把completion handler暴露为获取对象的公共属性，那么就不便在执行完下载请求之后直接将其清理掉了，因为既然已经把handler作为属性公布了，那就意味着调用者可以自由使用它，若是此时有在内部将其清理掉的话，则会破坏“封装语义”（encapsulation semantic）。在这种情况下要想打破保留环，只有一个办法可用，那就是强迫调用者在handler代码里自己把completionHandler属性清理干净。可这并不十分合理，因为你无法假定调用者一定会这么做，他们反过来会抱怨你没把内存泄漏问题处理好。

要点

• 如果块所捕获的对象直接或间接地保留了块本身，那么就得当心保留环问题。
• 一定要找个适当的时机解除保留环，而不能把责任推给API的调用者。