在block中滥用weakSelf的教训

不知道从什么时候开始，我的脑子里就有一个印象：“在block中用self容易造成retain cycle，虽然有时候编译器会警告但也不能保证编译器每次都发现retain cycle，所以保险起见还是每次都用weakSelf好了(￣▽￣)”

果然这种无脑的想法会出问题(╥﹏╥)。

ps.这篇好水，因为原理什么的书里看了，但还没理解透彻到可以写出来>.<

崩溃

因为最近在做的项目中，还有一些很久以前留下来的，用MRC内存管理方式的代码。我给其中一个文件加上了类似这样的两个方法：

//MRC

- (void)alarmLater {

    __block typeof(self) weakSelf =self;

    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(10 *NSEC_PER_SEC)), dispatch_get_main_queue(), ^{

        [weakSelf alarm];

    });

}

- (void)alarm {

    NSLog(@"Hello World!");

}

因为习惯了无脑用weakSelf。MRC中，__block修饰符可以避免block对self对象的retain，所以我就这么写了。

然而运行的结果是，崩溃(╥﹏╥)

* thread #1: tid =0x22796c, 0x00000001060de80b libobjc.A.dylib`objc_msgSend +11, queue = 'com.apple.main-thread', stop reason = EXC_BAD_ACCESS (code=EXC_I386_GPFLT)

    frame #0:0x00000001060de80b libobjc.A.dylib`objc_msgSend +11

  * frame #1:0x0000000105bcaaee XSQBlockCrashDemo`__27-[XSQLaterAlarm alarmLater]_block_invoke(.block_descriptor=<unavailable>) +46 at XSQLaterAlarm.m:17

    frame #2:0x0000000108d36e5d libdispatch.dylib`_dispatch_call_block_and_release +12

    frame #3:0x0000000108d5749b libdispatch.dylib`_dispatch_client_callout +8

    frame #4:0x0000000108d3c746 libdispatch.dylib`_dispatch_after_timer_callback +334

    frame #5:0x0000000108d5749b libdispatch.dylib`_dispatch_client_callout +8

    frame #6:0x0000000108d4a8a5 libdispatch.dylib`_dispatch_source_latch_and_call +1750

    frame #7:0x0000000108d45830 libdispatch.dylib`_dispatch_source_invoke +1057

    frame #8:0x0000000108d3f111 libdispatch.dylib`_dispatch_main_queue_callback_4CF +1324

    frame #9:0x00000001065afd09 CoreFoundation`__CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE__ +9

    frame #10:0x00000001065712c9 CoreFoundation`__CFRunLoopRun +2073

    frame #11:0x0000000106570828 CoreFoundation`CFRunLoopRunSpecific +488

    frame #12:0x0000000109e09ad2 GraphicsServices`GSEventRunModal +161

    frame #13:0x00000001069fc610 UIKit`UIApplicationMain +171

    frame #14:0x0000000105bca94f XSQBlockCrashDemo`main(argc=1, argv=0x00007fff5a035650) +111 at main.m:14

    frame #15:0x0000000108d8b92d libdyld.dylib`start +1

这是因为，当block中调用到[weakSelf alarm]的时候，self已经被回收，这句话相当于访问了一个悬垂指针，导致崩溃。

为什么需要weakSelf？

有很多文档啊博客啊都解释过这个问题，简单的说：

1. block中使用的赋值给附有__strong修饰符的自动变量的对象由于被堆上的block所持有，因而可超出其变量作用域而存在。
2. 在Grand Central Dispatch的API中传递block时，栈上的block会复制到堆。

如果一个对象直接或间接持有了block，而block又持有那个对象，则会产生一个retain cycle，导致内存泄漏。所以在MRC下，可以用__block修饰符修饰block中使用的变量，而在ARC下，可以用__weak或__unsafe_unretained修饰符修饰block中使用的变量，来破坏这个retain cycle。

由于很多情况下，造成retain cycle的对象都是self，所以这些情况下，会使用weakSelf来破坏retain cycle。

然而重点是“retain cycle”，而不是“weakSelf”。

dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(10 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{ 

    [weakSelf alarm];

});

这段代码中，self并没有持有block，所以当block需要访问self的时候，使用weakSelf是多余的。

所以在这段代码中，直接在block中使用self，不会产生retain cycle，也可以让self对象一直存活到block被运行的时候。

- (void)alarmLater {

    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(10 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{

        [self alarm];

    });

}

扯点教训

因为遇到了这个bug，最近也补了点关于block的知识。看了《Objective-C高级编程》里关于block实现的那段，觉得对block的认识清晰了一些。以前一直看不懂里面成片的C代码，这次居然明白了个大概，不知道是不是我进步了一点。

无脑总是不对的。作为一个程序员，写下的每一行代码，都得清楚的知道是为什么吧。

参考

《Objective-C高级编程》

谈Objective-C Block的实现

正确使用Block避免Cycle Retain和Crash