ARC下的autorelease

发现我从接触iOS开发到现在，几乎都没有使用过autorelease这个词。在ARC内存管理方式下，就像不能发送release和retain消息一样，程序员也不能对某个对象发送autorelease消息，让我几乎忘记了它的存在。所以今天突然想起来，应该查查ARC下autorelease的正确使用姿势(¬_¬)

---

内存管理原则

在内存管理方面，cocoa设立了一些基本原则，其中有这样一条：

You own any object you create
You create an object using a method whose name begins with “alloc”, “new”, “copy”, or “mutableCopy”.

用以alloc/new/copy/mutableCopy为前缀的方法名创建的对象，是自己创建并持有的。

这条原则在ARC和MRC下都需要遵守。

比如cocoa中有很多工厂方法，它们不以alloc/new/copy/mutableCopy开头，所以按照约定，它们返回的对象不应该被持有。在MRC下，一种可能的实现方式大概是这样：

/*
 * MRC，此段代码摘抄自[《Objective-C 高级编程》](https://book.douban.com/subject/24720270/)
 */

- (id)object
{
    id obj = [[NSObject alloc] init];

    /*
     * 自己持有对象
     */

    [obj autorelease];

    /*
     * 取得对象的存在，但自己不持有对象
     */

    return obj;
}

但是在ARC中，程序员不能对一个对象发送autorelease消息，那么如何将一个对象注册到autorelease pool中，又如何遵循以上的这个原则呢？看来，开启ARC后，编译器帮助我们做了不少事情。

---

__autoreleasing修饰符

切换到ARC之后，每个指向OC对象的指针，都被赋上了所有权修饰符。一共有__strong、__weak、__unsafe_unretained和__autoreleasing这样四种所有权修饰符。

当一个对象被赋值给一个使用__autoreleasing修饰符修饰的指针时，相当于这个对象在MRC下被发送了autorelease消息，也就是说它被注册到了autorelease pool中。

全局变量和实例变量是无法用__autoreleasing来修饰的，不然编译器会报错：

而局部变量用__autoreleasing修饰后，其指向的对象，在当前autorelease pool结束之前不会被回收：

__weak NSObject *weakObj1;
__weak NSObject *weakObj2;

{
    __autoreleasing NSObject *obj1 = [[NSObject alloc] init];
    weakObj1 = obj1; //weakObj1指向的对象已被注册到autorelease pool
    
    __strong NSObject *obj2 = [[NSObject alloc] init];
    weakObj2 = obj2;//weakObj2指向的对象没有被注册到autorelease pool
}
//局部变量obj1和obj2的作用域结束，
//此时weakObj2指向的对象不再被强引用，因此被回收；
//而obj1指向的对象仍然在autorelease pool中

NSLog(@"%@", weakObj1);//输出，因为此刻weakObj1在autorelease pool中，不会因为obj1作用域的结束而被回收
NSLog(@"%@", weakObj2);//输出null

---

方法名检查

写这样一段代码：

@interface XSQObject : NSObject

+ (NSString *)newHelloWorldString;
+ (NSString *)helloWorldString;

@end

@implementation XSQObject

+ (NSString *)newHelloWorldString {
    return [[NSString alloc] initWithCString:"HelloWorld" encoding:NSUTF8StringEncoding];
}

+ (NSString *)helloWorldString {
    return [[NSString alloc] initWithCString:"HelloWorld" encoding:NSUTF8StringEncoding];
}

@end

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        
        __weak NSString *helloWorldString = [XSQObject helloWorldString];
        __weak NSString *newHelloWorldString = [XSQObject newHelloWorldString];
        //此处有warning: 
        //assigning retained object to weak variable; 
        //object will be released after assignment 

        NSLog(@"%@", helloWorldString);//输出HelloWorld
        NSLog(@"%@", newHelloWorldString);//输出null
        
    }
    return 0;
}

虽然[XSQObject helloWorldString]和[XSQObject newHelloWorldString]两个方法的实现完全一样，但是它们返回的对象被赋值给__weak指针后，前者仍然存在，而后者则被销毁了。如果再加入@autorelease块做点实验，可以发现helloWorldString指向的对象其实已被注册到autorelease pool中。

对比内存管理原则，这就像是在MRC下，不以alloc/new/copy/mutableCopy开头的方法，会对返回的对象发送autorelease消息一样。而事实上，在ARC下，编译器会检查方法名是否以alloc/new/copy/mutableCopy开头，如果不是，则自动将返回的对象注册到autorelease pool中。

更接近底层一点，其实Clang使用了一些标识来决定一个方法的返回值是否应该被持有。比如Clang文档中有这样的说明：

Methods in the alloc, copy, init, mutableCopy, and new families are implicitly marked __attribute__((ns_returns_retained)).

alloc/copy/init/mutableCopy/new家族中的方法，会被隐式标记为__attribute__((ns_returns_retained))

在一些特殊的情况下，程序员也可以手动给某些方法加上其他标记，来覆盖被编译器隐式加上的标记。

---

id *obj的传递

上面说到，编译器会检查方法名是否以alloc/new/copy/mutableCopy开头，来判断是否需要将返回的对象注册到autorelease pool中。

函数之间如果想要传递一个对象，不仅可以通过返回值，也可以通过将一个id指针作为参数的方式。在cocoa框架中，NSError的对象经常通过这种方式来传递，比如NSManagedObjectContext中的：

- (BOOL)save:(NSError **)error;

其实，这个(NSError **)error相当于(NSError * __autoreleasing *)error，编译器默认为其生成了__autoreleasing修饰符。

编译器默认生成__autoreleasing修饰符的做法，也是在贯彻内存管理原则，即确保只有通过以alloc/new/copy/mutableCopy开头的方法返回的对象才能被持有。

虽然当我们自己定义id *obj类型的参数时，也可以显式指定它的所有权修饰符为其他，并通过编译，但为了贯彻内存管理原则，还是应该将id *obj类型的参数的所有权修饰符指定为__autoreleasing。

---

参考

《Objective-C 高级编程》
Clang
Memory Management Policy
objc arc的简单探索

---

2016.03.24更新

老板看了这篇后，问我，为什么在“方法名检查”中用了initWithCString:encoding:来创建NSString对象？

哈哈，这是因为我试了别的几种创建NSString对象的方式后，发现实验结果和我预期的不符。

所以我来解释一下为什么用下面几种方法创建NSString对象，会得到与预期不符的实验结果。

1. literal

   literal，就是指用@"xxx"的方式创建一个NSString对象。然而，literal的内存管理方式有些特别。
   官方文档明确指出了使用literal创建的NSString对象在整个程序的生命周期内都是不会被销毁的：

   Objective-C string constant is created at compile time and exists throughout your program’s execution. The compiler makes such object constants unique on a per-module basis, and they’re never deallocated.

   所以如果用literal的方式来创建NSString对象，这样得到的helloWorldString和newHelloWorldString到输出这一步时都不会变成空。

2. 使用initWithString:

   既然literal没法达到预期实验效果，那用initWithString:方法应该能创建出比较正常的NSString对象了吧？
   把helloWorldString和newHelloWorldString两个方法中的语句都替换为：

return [[NSString alloc] initWithString:@"HelloWorld"];

然而运行一下发现，newHelloWorldString并没有像预期的一样被销毁。

这是什么原因呢？嗯。。如果换一种写法：

NSString *s1 = @"Hello World";
NSString *s2 = [[NSString alloc] initWithString:s1];

然后运行到这里时输出s1和s2指向的地址，发现这两个指针竟然指向同一个地址。看来initWithString:方法中可能做了某些处理？

3. 使用stringWithFormat:

   老板问我用stringWithFormat:为什么不能达到预期效果，虽然我当场有点懵逼，但是回头一想，这不是显然么。
   因为stringWithFormat:这个方法，不是以alloc/new/copy/mutableCopy开头的呀，所以它返回的对象已经被注册到了autorelease pool里呀。