ARC和Non-ARC下的单例模式

原文：http://www.cocoachina.com/industry/20130510/6168.html

http://www.justinyan.me/post/1306

单例模式
iOS SDK中也有许多类使用了单例模式，例如，UIApplication：当程序启动的时候，会调用UIApplicationMain方法，在该方法中，会实例化一个UIApplication对象，之后在程序中的任意地方调用sharedApplication方法都将返回一个与当前应用程序相关的UIApplication实例（UIApplicationMain方法中创建的UIApplication单例）。

什么时候使用单例模式？

在程序中，单例模式经常用于只希望一个类只有一个实例，而不运行一个类还有两个以上的实例。当然，在iOS SDK中，根据特定的需求，有些类不仅提供了单例访问的接口，还为开发者提供了实例化一个新的对象接口，例如，NSFileManager可以通过defaultManager方法返回相同的一个NSFileManager对象。如果需要新的一个NSFileManager实例对象，可以通过init方法。

iOS中单例模式的实现

iOS中单例模式的实现方式一般分为两种：Non-ARC(非ARC)和ARC+GCD。

1.Non-ARC(非ARC)
非ARC的实现方法如下所示：

BVNonARCSingleton.h

@interface BVNonARCSingleton : NSObject
 
@property  ( nonatomic, retain) NSString  *tempProperty;
+ (BVNonARCSingleton *)sharedInstance; 
@end

BVNonARCSingleton.m

@implementation BVNonARCSingleton

static BVNonARCSingleton *sharedInstance = nil;
// 获取一个sharedInstance实例，如果有必要的话，实例化一个
+ (BVNonARCSingleton *)sharedInstance {
   if (sharedInstance == nil) {
        sharedInstance = [[super allocWithZone:NULL] init];
    }
    return sharedInstance;
}

// 当第一次使用这个单例时，会调用这个init方法。
- (id)init
{
    self = [super init];

    if (self) {
        // 通常在这里做一些相关的初始化任务
    }

    return self;
}

// 这个dealloc方法永远都不会被调用--因为在程序的生命周期内容，该单例一直都存在。（所以该方法可以不用实现）
-(void)dealloc
{
    [super dealloc];
}
// 通过返回当前的sharedInstance实例，就能防止实例化一个新的对象。
+ (id)allocWithZone:(NSZone*)zone {
    return [[self sharedInstance] retain];
}

// 同样，不希望生成单例的多个拷贝。
- (id)copyWithZone:(NSZone *)zone {
    return self;
}

// 什么也不做——该单例并不需要一个引用计数（retain counter）
- (id)retain {
    return self;
}
// 替换掉引用计数——这样就永远都不会release这个单例。
- (NSUInteger)retainCount {
    return NSUIntegerMax;
}

// 该方法是空的——不希望用户release掉这个对象。
- (oneway void)release {

}

//除了返回单例外，什么也不做。
- (id)autorelease {
    return self;
}
 
@end

实际上上面的代码苹果官网也有提供：Creating a Singleton Instance，只不过没有给出头文件的定义。上面用非ARC实现单例的方法是线程不安全的，如果有多个线程同时调用sharedInstance方法获取一个实例，而sharedInstance方法需要花费1-2秒钟的时间，那么BVNonARCSingleton的init方法就可能会被多次调用，也就是不同线程获得的BVNonARCSingleton有可能不是同一个实例。怎么解决线程的不安全呢？答案是使用@synchronized来创建互斥锁即可。

// 保证在实例化的时候是线程安全的（当然，该方法不能保证该单例中所有方法的调用都是线程安全的）

@synchronized (self)
{
   if(sharedInstance == nil)
    {
       sharedInstance = [[super allocWithZone:NULL] init];
    }
}

通过上面的代码就能保存线程安全。
提醒：在iOS中，一般不建议使用非ARC来实现单例模式。更好的方法是使用ARC+GCD来实现。

2.ARC+GCD
通过ARC+GCD的方法来实现单例模式的非常简单的。下面先来看看具体实现：

BVARCSingleton.h

@interface BVARCSingleton : NSObject
@property  ( nonatomic, weak) NSString  *tempProperty;
+ (BVARCSingleton *)sharedInstance;
@end

BVARCSingleton.m

@implementation BVARCSingleton
+ (BVARCSingleton *) sharedInstance
{
    static  BVARCSingleton *sharedInstance = nil ;
    static  dispatch_once_t onceToken;  // 锁
    dispatch_once (&amp; onceToken, ^ {     // 最多调用一次
       sharedInstance = [[self  alloc] init];
    });
    return  sharedInstance;
}

// 当第一次使用这个单例时，会调用这个init方法。
- (id)init
{
    self = [super init];

    if (self) {
        // 通常在这里做一些相关的初始化任务
    }
 
    return self;
}
@end

在上面的代码中，调用Grand Central Dispatch (GCD)中的dispatch_once方法就可以确保BVARCSingleton只被实例化一次。并且该方法是线程安全的，我们不用担心在不同的线程中，会获得不同的实例。（当然，该方法同样不能保证该单例中所有方法的调用都是线程安全的）。

当然，在ARC中，不用GCD也是可以做到线程安全的，跟之前非ARC代码中使用@synchronized一样，如下代码：

 // 不使用GCD，通过@synchronized
@synchronized (self)
{
   if(sharedInstance == nil)
    {
        sharedInstance = [[self alloc] init];
    }
}

为了简化使用ARC+GCD来创建单例，可以定义下面这样的一个宏：

#define DEFINE_SHARED_INSTANCE_USING_BLOCK(block) 
static dispatch_once_t onceToken = 0; 
__strong static id sharedInstance = nil; 
dispatch_once(&onceToken, ^{ 
sharedInstance = block(); 
}); 
return sharedInstance;

实例化的实现方法如下所示：

+ (BVARCSingleton *) sharedInstance
{
    DEFINE_SHARED_INSTANCE_USING_BLOCK(^{
        return [[self alloc] init];
    });
}

单例的使用

单例的使用方法很简单，在代码中的任意位置，如下使用即可：

在BVAppDelegate.m中添加头文件：
#import "BVNonARCSingleton.h"
#import "BVARCSingleton.h"

如下使用方法：

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [BVNonARCSingleton sharedInstance].tempProperty = @"非ARC单例的实现";
    NSLog(@"%@", [BVNonARCSingleton sharedInstance].tempProperty);
 
    [BVARCSingleton sharedInstance].tempProperty = @"ARC单例的实现";
    NSLog(@"%@", [BVARCSingleton sharedInstance].tempProperty);

    return YES;
}

运行程序，会在控制台窗口输出如下内容：
1.2013-05-09 16:44:07.649 SingletonPattern[5159:c07] 非ARC单例的实现
2.2013-05-09 16:44:33.204 SingletonPattern[5159:c07] ARC单例的实现

alloc和allocwithzone

一、问题起源

一切起源于Apple官方文档里面关于单例(Singleton)的示范代码:Creating a Singleton Instance.

主要的争议集中在下面这一段：

static MyGizmoClass *sharedGizmoManager = nil;
+ (MyGizmoClass*)sharedManager
{
    if (sharedGizmoManager == nil) {
        sharedGizmoManager = [[super allocWithZone:NULL] init];
    }
 
    return sharedGizmoManager;
}
 
+ (id)allocWithZone:(NSZone *)zone
{
    return [[self sharedManager] retain];
}

其中：

sharedGizmoManager = [[super allocWithZone:NULL] init];

这段有另一个版本，不使用 allocWithZone 而是直接 alloc，如下：

sharedGizmoManager = [[super alloc] init];

这就引发了一个讨论，为什么要覆盖allocWithZone方法，到底 alloc 和 allocWithZone 有啥区别呢？

PS：关于ObjC单例的实现，@Venj 的这篇博文有比较详细的讨论，包括了线程安全的考虑，有兴趣的童鞋可以围观一下。

二、allocWithZone

首先我们知道，我们需要保证单例类只有一个唯一的实例，而平时我们在初始化一个对象的时候， [[Class alloc] init]，其实是做了两件事。 alloc 给对象分配内存空间，init是对对象的初始化，包括设置成员变量初值这些工作。而给对象分配空间，除了alloc方法之外，还有另一个方法： allocWithZone.

在NSObject 这个类的官方文档里面，allocWithZone方法介绍说，该方法的参数是被忽略的，正确的做法是传nil或者NULL参数给它。而这个方法之所以存在，是历史遗留原因。

Do not override allocWithZone: to include any initialization code. Instead, class-specific versions of init… methods.

This method exists for historical reasons; memory zones are no longer used by Objective-C.

文档里面提到，memory zone已经被弃用了，只是历史原因才保留这个接口。详细是什么历史原因我没找到，不过后面介绍的内容会稍微涉及到。

而实践证明，使用alloc方法初始化一个类的实例的时候，默认是调用了 allocWithZone 的方法。于是覆盖allocWithZone方法的原因已经很明显了：为了保持单例类实例的唯一性，需要覆盖所有会生成新的实例的方法，如果有人初始化这个单例类的时候不走[[Class alloc] init] ，而是直接 allocWithZone，那么这个单例就不再是单例了，所以必须把这个方法也堵上。allocWithZone的答案到此算是解决了，但是，问题是无止境的。

这里引出了另外一个问题： What the hell is Memory Zone?

三、NSZone

Apple官方文档里面就简单的几句，吝啬得很：

NSZone
 
Used to identify and manage memory zones.
 
typedef struct _NSZone NSZone;
 
Availability
 
Available in OS X v10.0 and later.
 
Declared In
 
NSZone.h

CocaDev的wiki就写得详细的多了，原文地址在这里：http://cocoadev.com/wiki/NSZone

大意上是说NSZone是Apple用来分配和释放内存的一种方式，它不是一个对象，而是使用C结构存储了关于对象的内存管理的信息。基本上开发者是不需要去理会这个东西的，cocoa Application使用一个系统默认的NSZone来对应用的对象进行管理。那么在什么时候你会想要有一个自己控制的NSZone呢？当默认的NSZone里面管理了大量的对象的时候。这种时候，大量对象的释放可能会导致内存严重碎片化，cocoa本身有做过优化，每次alloc的时候会试图去填满内存的空隙，但是这样做的话时间的开销很大。于是乎，你可以自己创建一个NSZone，这样当你有大量的alloc请求的时候就全部转移到指定的NSZone里面去，减少了大量的时间开销。而且，使用NSZone还可以一口气把你创建的zone里面的东西都清除掉，省掉了大量的时间去一个个dealloc对象。

总的来说，当你需要创建大量的对象的时候，使用NSZone还是能节省一些时间的，不过前提是你得知道怎么去用它。这篇wiki里面也写了NSZone的用法，感兴趣的童鞋可以看看，不过另一篇2002年的文章就说开发者已经不能创建一个真正的NSZone了（看来也许这就是历史原因了），只能创建main zone的一个child zone。文章在这里：http://www.cocoabuilder.com/archive/cocoa/65056-what-an-nszone.html#65056 Timothy J.wood 的回答。

Timothy还讲到如果可以使用NSZone的话，多个对象在同一时间alloc可以减少分页使用，而且在同一个时间dealloc可以减少内存碎片。想必后来Apple在这方面是做了处理了，对开发者透明，无需开发者自己去做。

四、结论

allocWithZone不被Apple鼓励使用，基本上多数时候程序员也不需要自己去管理自己的zone。当然多了解一些东西总是好的嘛。