黑魔法__attribute__((cleanup))

转载自:孙源sunnyxx的技术博客系列
http://blog.sunnyxx.com/2014/09/15/objc-attribute-cleanup/

2014年9月15日

编译器属性__attribute__用于向编译器描述特殊的标识、检查或优化，几个常用的用法看《mattt大神的文章》就好。今天发现一个名为cleanup的黑魔法属性，简单介绍下。

---

基本用法

__attribute__((cleanup(...)))，用于修饰一个变量，在它的作用域结束时可以自动执行一个指定的方法，如：

// 指定一个cleanup方法，注意入参是所修饰变量的地址，类型要一样
// 对于指向objc对象的指针(id *)，如果不强制声明__strong默认是__autoreleasing，造成类型不匹配
static void stringCleanUp(__strong NSString **string) {
 NSLog(@"%@", *string);
}
// 在某个方法中：
{
 __strong NSString *string __attribute__((cleanup(stringCleanUp))) = @"sunnyxx";
} // 当运行到这个作用域结束时，自动调用stringCleanUp

所谓作用域结束，包括大括号结束、return、goto、break、exception等各种情况。
当然，可以修饰的变量不止NSString，自定义Class或基本类型都是可以的：

// 自定义的Class
static void sarkCleanUp(__strong Sark **sark) {
 NSLog(@"%@", *sark);
}
__strong Sark *sark __attribute__((cleanup(sarkCleanUp))) = [Sark new];
// 基本类型
static void intCleanUp(NSInteger *integer) {
 NSLog(@"%d", *integer);
}
NSInteger integer __attribute__((cleanup(intCleanUp))) = 1;

假如一个作用域内有若干个cleanup的变量，他们的调用顺序是先入后出的栈式顺序；
而且，cleanup是先于这个对象的dealloc调用的。

进阶用法

既然__attribute__((cleanup(...)))可以用来修饰变量，block当然也是其中之一，写一个block的cleanup函数非常有趣：

// void(^block)(void)的指针是void(^*block)(void)
static void blockCleanUp(__strong void(^*block)(void)) {
 (*block)();
}

于是在一个作用域里声明一个block：

{
 // 加了个`unused`的attribute用来消除`unused variable`的warning
 __strong void(^block)(void) __attribute__((cleanup(blockCleanUp), unused)) = ^{
 NSLog(@"I'm dying...");
 };
} // 这里输出"I'm dying..."

这里不得不提万能的Reactive Cocoa中神奇的@onExit方法，其实正是上面的写法，简单定义个宏：

#define onExit\
 __strong void(^block)(void) __attribute__((cleanup(blockCleanUp), unused)) = ^

用这个宏就能将一段写在前面的代码最后执行：

{
 onExit {
 NSLog(@"yo");
 };
} // Log "yo"

这样的写法可以将成对出现的代码写在一起，比如说一个lock：

NSRecursiveLock *aLock = [[NSRecursiveLock alloc] init];
[aLock lock];
// 这里
//     有
//        100多万行
[aLock unlock]; // 看到这儿的时候早忘了和哪个lock对应着了

用了onExit之后，代码更集中了：

NSRecursiveLock *aLock = [[NSRecursiveLock alloc] init];
[aLock lock];
onExit {
 [aLock unlock]; // 妈妈再也不用担心我忘写后半段了
};
// 这里
//    爱多少行
//           就多少行

还是那句老话：剩下的就全靠想象力了。