objective-c Singleton 最佳实践

最近翻笔记，发现Singleton知识点漏洞太多，于是重新整理了一下（友情提示：可以配上竹仲絵里的いつも何度でも一起欣赏）。

这是一篇关于单小姐的故事。

what‘s Singleton？

首先，我们重新复习一下：what‘s Singleton？
单例模式，通常的理解就是一个实例变量只会为一个类而存在，针对这个实例变量有一个全局的入口；当第一次创建它的时候通常会采用延迟加载的方式，只会调用一次，即便后来它出了意外被销毁，也不会再重新创建。

单例的使用场景：

类只能有一个实例，并且必须从一个为数值的访问点对其访问。
这个唯一的实例只能通过子类化进行拓展，并且拓展的对象不会破坏客户端代码。

苹果提供了很多单例模式的例子，比如：[NSUserDefaults standerUserDefaults].etc，我们在实践中也经常会用到，比如登录，etc.
好了，复习一下概念，具体可以参考：
https://www.raywenderlich.com/46988/ios-design-patterns
NextStep，the point！

how to use Singleton？

由于我们不知道会什么时候、通过什么样的方式创建单例，所以我们在创建Singleton的时候，一定要考虑全面，翻阅我之前的笔记，漏洞百出，没有考虑环境，没有考虑方式，所以如果别人用我写的单例，可能会有分分钟重构代码的冲动吧，所以，作为一个coder monkey ，逻辑思维，思考方式很重要。

分享一个应该是最完整的单例创建方式：

+(instancetype)sharedSoundTool{
    static id instance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        instance = [[self alloc] init];
    });
    return instance;
}
//
 + (instancetype)allocWithZone:(struct _NSZone *)zone {
    static id instance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        instance = [super allocWithZone:zone];
    });
    return instance;
}
//
 + (id)copyWithZone:(nullable NSZone *)zone{
    return self;
}
//
#pragma mark - 在非ARC环境下，还要重写下面方法
 + (oneway void)release {
}
//
 + (instancetype)autorelease {
    return self;
}
//
 + (instancetype)retain {
    return self;
}
//
 + (NSUInteger)retainCount {
    return 1;
}

考虑的很全面，无论是ARC还是MRC，各种方式，都考虑到了。

很有意思的玩法，一行代码创建单例：

首先，先抽.h中：

#define Singleton_h(name)  +(instancetype)shared##name;

#if __has_feature(objc_arc) // arc环境
#define Singleton_m(name)  +(instancetype)shared##name{ \
static id instance = nil; \
static dispatch_once_t onceToken;\
dispatch_once(&onceToken, ^{\
instance = [[self alloc] init];\
});\
return instance;\
}\
\
+ (instancetype)allocWithZone:(struct _NSZone *)zone {\
static id instance = nil;\
static dispatch_once_t onceToken;\
dispatch_once(&onceToken, ^{\
instance = [super allocWithZone:zone];\
});\
return instance;\
}\
\
- (id)copyWithZone:(nullable NSZone *)zone{\
return self;\
}
#else // 非arc环境

#define Singleton_m(name)  +(instancetype)shared##name{ \
static id instance = nil; \
static dispatch_once_t onceToken;\
dispatch_once(&onceToken, ^{\
instance = [[self alloc] init];\
});\
return instance;\
}\
\
 + (instancetype)allocWithZone:(struct _NSZone *)zone {\
static id instance = nil;\
static dispatch_once_t onceToken;\
dispatch_once(&onceToken, ^{\
instance = [super allocWithZone:zone];\
});\
return instance;\
}\
\
 + (id)copyWithZone:(nullable NSZone *)zone{\
return self;\
}\
 + (oneway void)release {\
}\
\
 + (instancetype)autorelease {\
    return self;\
}\
\
 + (instancetype)retain {\
    return self;\
}\
\
 + (NSUInteger)retainCount {\
    return 1;\
}
#endif

然后，重点来了

在你想创建单例的.h中

#import "Singleton.h"
@interface HttpTool : NSObject

Singleton_h(HttpTool)
@end

接着，在你想创建单例的.m中

@implementation HttpTool
Singleton_m(HttpTool);
@end

Finish！很爽吧？

About thread

单例模式中需要用到dispatch_once，意义很明显，就是希望dispatch_once中参数的block在全局中只执行一次，但如果出现下面的情况，也许就有点茫然了。

- (void)foo{ 
static dispatch_once_t onceToken; 
dispatch_once(&onceToken, ^{
 [self foo]; 
}); 
// whatever...}

是的，你猜的没错，它发生死锁了，但为什么会发生死锁呢？
观察一下程序的调用栈，

Paste_Image.png

它在dispatch_once_f卡住了，查阅了相关资料，有兴趣的同学可以去看看dispatch_once_f的实现，大概就是onceToken在执行第一次block的时候，将其值由NULL指向第一次执行它的指针，在block执行完成之前，所有进来的其他的调用者都被派遣到一个叫waiter的链表里，这些调用者呢都在等待一个信号量，当block完成后，oncetoken将被置为DISPATCH_ONCE_DONE，同时也会给waiter抛出一个信号，告诉它们我已经完成啦。看到这里，估计大家明白了，foo在第二次调用的时候，它跑到了waiter链表里，等待block中自己（foo）发送一个完成的信号量，所以，它发生了死锁。

参考资料：http://stackoverflow.com/questions/19176219/why-am-i-getting-deadlock-with-dispatch-once

所以，这个故事告诉我们：单例虽好，可不要递归调用哦。