你真的能寫好一個單例麼？

AlexLee002發表於2019-04-14

單例可能是 iOS 開發者最熟悉設計模式之一了。我們的專案裡頭也使用了很多單例?。最近為了解決專案中單例的 bug 而花費了兩天多的時間，發現用 ObjC 寫好一個單例真的不容易！

V1.0

可能有很多人不服氣，單例麼，有什麼難的，一個簡單的 dispatch_once 不就解決了麼！比如下邊的程式碼：

@implementation SingletonClass
+ (instancetype)sharedInstance {
    static SingletonClass *instance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        instance = [[self alloc] init];
    });
    return instance;
}
//...
@end
複製程式碼

可能大部分人的單例都是這麼實現的，貌似也沒啥問題，通過[SingletonClass sharedInstance] 獲取到的的確都是同一個例項。但是有沒有例外情況呢？

比如SingletonClass這個類需要託管到其他框架，那麼其他框架生成例項的時候，為了通用，一般都會通過[[SingletonClass alloc] init]來初始化；
專案中的單例類又沒有明顯標識，長的和其他類差不多，那麼會不會有某些同事"誤用" [[SingletonClass alloc] init]來初始化呢？畢竟你又沒有規定不讓用。

那麼問題來了，執行下邊程式碼：

NSLog(@"1: %p", [SingletonClass sharedInstance]);
NSLog(@"2: %p", [SingletonClass sharedInstance]);
NSLog(@"3: %p", [[SingletonClass alloc] init]);
NSLog(@"4: %p", [[SingletonClass alloc] init]);
複製程式碼

輸出結果：

2019-04-12 18:44:51.147445+0800 TestProj[92371:7344641] 1: 0x600002a0c360
2019-04-12 18:44:51.147553+0800 TestProj[92371:7344641] 2: 0x600002a0c360
2019-04-12 18:44:51.147630+0800 TestProj[92371:7344641] 3: 0x600002a1e700
2019-04-12 18:44:51.147737+0800 TestProj[92371:7344641] 4: 0x600002a11060
複製程式碼

可以看出， 1和2是一樣的，但是和3， 4都不一樣，所以這種方案不完善。

弊端：沒有保證無論用何種初始化方法，都應該只有一個例項。

V2.0

在很久很久以前， iOS的蠻荒時代，那時候還沒有 swift, 蘋果還把 Objective-C 叫“小甜甜”。在蘋果網站上，曾經有一份OC實現單例的 sample code(現在沒有了，連結失效了，現在只有 swift 的，畢竟現在的小甜甜是 swift)。費了老大的勁，終於從一些別人的歷史文章裡邊找到了和當年蘋果差不多的實現：

static SingletonClass *sharedInstance = nil;

@implementation SingletonClass
#pragma mark Singleton Methods
+ (id)sharedInstance {
  @synchronized(self) {
      if(sharedInstance == nil)
          sharedInstance = [[super allocWithZone:NULL] init];
  }
  return sharedInstance;
}
+ (id)allocWithZone:(NSZone *)zone {
  return [[self sharedInstance] retain];
}
- (id)copyWithZone:(NSZone *)zone {
  return self;
}
- (id)retain {
  return self;
}
- (unsigned)retainCount {
  return UINT_MAX; //denotes an object that cannot be released
}
- (oneway void)release {
  // never release
}
- (id)autorelease {
  return self;
}
- (void)dealloc {
  // Should never be called, but just here for clarity really.
  [someProperty release];
  [super dealloc];
}
@end
複製程式碼

這個還是 MRC 的，那時候也還沒有 dispatch_once。改寫成 ARC 之後測試看看：

2019-04-12 21:59:16.844126+0800 TestProj[6248:7514391] 1: 0x600002afc430
2019-04-12 21:59:16.844285+0800 TestProj[6248:7514391] 2: 0x600002afc430
2019-04-12 21:59:16.844402+0800 TestProj[6248:7514391] 3: 0x600002afc430
2019-04-12 21:59:16.844499+0800 TestProj[6248:7514391] 4: 0x600002afc430
複製程式碼

OK! 完美！

且慢~~ 在用到專案中的時候，還是有問題。原來專案中有單例繼承的情況?（關於單例是否可以繼承，以及什麼場景下用單例繼承，這是另外一個爭論話題~）。那就寫個子類繼承單例，測試一下吧：

@interface SingletonClassSon : SingletonClass
@end
@implementation SingletonClassSon
@end

/// test case:
NSLog(@"01: %@", [SingletonClass sharedInstance]);
NSLog(@"02: %@", [[SingletonClass alloc] init]);
    
NSLog(@"11: %@", [SingletonClassSon sharedInstance]);
NSLog(@"12: %@", [[SingletonClassSon alloc] init]);
複製程式碼

執行結果如下：

2019-04-12 22:10:47.305874+0800 TestProj[6737:7524929] 01: <SingletonClass: 0x60000166ca20>
2019-04-12 22:10:47.306011+0800 TestProj[6737:7524929] 02: <SingletonClass: 0x60000166ca20>
2019-04-12 22:10:47.306110+0800 TestProj[6737:7524929] 11: <SingletonClass: 0x60000166ca20>
2019-04-12 22:10:47.306191+0800 TestProj[6737:7524929] 12: <SingletonClass: 0x60000166ca20>
複製程式碼

WTF？爹還是爹，兒子不見了？原因是子類呼叫的是父類的sharedInstance方法，直接返回父類的例項了，子類根本沒有被 alloc！

修改一下，給兒子把方法補全：

@interface SingletonClassSon : SingletonClass
@end
@implementation SingletonClassSon
#pragma mark Singleton Methods
+ (id)sharedInstance {
    static SingletonClassSon *sharedInstance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        sharedInstance = [[super allocWithZone:NULL] init];
    });
    return sharedInstance;
}
+ (id)allocWithZone:(NSZone *)zone {
    return [self sharedInstance];
}
- (id)copyWithZone:(NSZone *)zone {
    return self;
}
@end
複製程式碼

繼續執行原來的 test case, 崩了：

呼叫棧如下，很明顯子類的 sharedInstance 方法發生了遞迴呼叫，導致dispatch_once死鎖了：

弊端：無法實現單例繼承

V3.0

仔細觀察上個版本的崩潰堆疊，發現問題所在就是 allocWithZone:的實現！把兩個類的allocWithZone: 修改如下：

/// 父類
+ (id)allocWithZone:(NSZone *)zone {
    if (self == SingletonClass.class) {
        return [self sharedInstance];
    }
    return [super allocWithZone:zone];
}

/// 子類
+ (id)allocWithZone:(NSZone *)zone {
    if (self == SingletonClassSon.class) {
        return [self sharedInstance];
    }
    return [super allocWithZone:zone];
}
複製程式碼

執行測試用例：

2019-04-12 22:46:44.697281+0800 TestProj[8125:7555154] 01: <SingletonClass: 0x6000014b7830>
2019-04-12 22:46:44.697575+0800 TestProj[8125:7555154] 02: <SingletonClass: 0x6000014b7830>
2019-04-12 22:46:44.698047+0800 TestProj[8125:7555154] 11: <SingletonClassSon: 0x6000014b7840>
2019-04-12 22:46:44.698309+0800 TestProj[8125:7555154] 12: <SingletonClassSon: 0x6000014b7840>
複製程式碼

??? 大功告成~~~

放到專案中跑起來，貌似隱約感覺不對~~~ 有些單例中的狀態怎麼被reset 了？新增一些生命週期方法，加上日誌測試。。。原來問題在-init上！

分別給父類和子類新增如下 -init方法：

- (instancetype)init {
    self = [super init];
    NSLog(@"%@ call %s", self, __PRETTY_FUNCTION__);
    return self;
}
複製程式碼

繼續執行測試用例, 輸出如下：

2019-04-12 22:46:44.697151+0800 TestProj[8125:7555154] <SingletonClass: 0x6000014b7830> call -[SingletonClass init]
2019-04-12 22:46:44.697281+0800 TestProj[8125:7555154] 01: <SingletonClass: 0x6000014b7830>
2019-04-12 22:46:44.697398+0800 TestProj[8125:7555154] <SingletonClass: 0x6000014b7830> call -[SingletonClass init]
2019-04-12 22:46:44.697575+0800 TestProj[8125:7555154] 02: <SingletonClass: 0x6000014b7830>
2019-04-12 22:46:44.697881+0800 TestProj[8125:7555154] <SingletonClassSon: 0x6000014b7840> call -[SingletonClass init]
2019-04-12 22:46:44.697959+0800 TestProj[8125:7555154] <SingletonClassSon: 0x6000014b7840> call -[SingletonClassSon init]
2019-04-12 22:46:44.698047+0800 TestProj[8125:7555154] 11: <SingletonClassSon: 0x6000014b7840>
2019-04-12 22:46:44.698138+0800 TestProj[8125:7555154] <SingletonClassSon: 0x6000014b7840> call -[SingletonClass init]
2019-04-12 22:46:44.698213+0800 TestProj[8125:7555154] <SingletonClassSon: 0x6000014b7840> call -[SingletonClassSon init]
2019-04-12 22:46:44.698309+0800 TestProj[8125:7555154] 12: <SingletonClassSon: 0x6000014b7840>
複製程式碼

一眼就能看到，只要用 alloc + init 的方式獲取單例例項， -init方法都會被執行一次，單例中的狀態也就會丟失了~。

弊端：無法保證初始化方法不可重入。

V4.0

我們在專案中，為了減少重複程式碼，把單例的實現寫成一個模板，只需要把這個巨集新增到類實現中，就能把這個類變成單例。詳情可以參考我很久很久以前的文章。

如何保證初始化方法不可重入呢？這個問題我想了好久，貌似除了在-init方法中新增初始化標記，沒有其他辦法了。但是如何在 -init中新增標記呢？我能想到的辦法有倆：

通過 method swizzle 替換單例的-init方法。我們可以給每個單例增加一個 category, 然後在 category 中實現+load方法(不用擔心會覆蓋主類中的+load，每個 category 都可以新增自己的+load方法，而且這些+load方法都會被執行)，在這裡替換掉-init。
模板中實現 -init, 就可以增加這個標記了，然後定義一個新的初始化方法 -singletonInit, 在 -init 中呼叫就可以了。外部單例類只需要實現這個 -singletonInit就可以了。

經過仔細考慮，我最後選擇了方案二，主要是 method swizzle 風險不太可控，方案二雖然保守，但是比較可靠。

修改一下單例 -init方法實現：

// 父類， 子類也類似
static SingletonClass *instance_SingletonClass = nil;
- (instancetype)init {
    static dispatch_semaphore_t semaphore;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        semaphore = dispatch_semaphore_create(1);
    });
    
    SingletonClass *strongRef = instance_SingletonClass;
    dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
    if (strongRef.class != self.class) {
        self = [super init];
        if (self.class == SingletonClass.class) {
            SEL sel = NSSelectorFromString(@"singletonInit");
            if ([self respondsToSelector:sel]) {
                [self performSelector:sel];
            }
            instance_SingletonClass = self;
        }
    }
    dispatch_semaphore_signal(semaphore);
    return self;
}

- (void)singletonInit {
    NSLog(@"caller: %@; SingletonClass customic init", self);
}
複製程式碼

繼續執行測試用例, 結果如下：

2019-04-13 13:04:35.396087+0800 TestProj[11692:7647465] caller: <SingletonClass: 0x600002c681d0>; SingletonClass customic init
2019-04-13 13:04:35.396231+0800 TestProj[11692:7647465] 01: <SingletonClass: 0x600002c681d0>
2019-04-13 13:04:35.396312+0800 TestProj[11692:7647465] 02: <SingletonClass: 0x600002c681d0>
2019-04-13 13:04:35.396402+0800 TestProj[11692:7647465] caller: <SingletonClassSon: 0x600002c63280>; SingletonClassSon customic init
2019-04-13 13:04:35.396473+0800 TestProj[11692:7647465] 11: <SingletonClassSon: 0x600002c63280>
2019-04-13 13:04:35.396561+0800 TestProj[11692:7647465] 12: <SingletonClassSon: 0x600002c63280>
複製程式碼

這次好像沒問題了，不會重複執行-init方法了。可是子類的初始化貌似不太對？因為我們現在修改了-init方法，真正的類的初始化是在-init裡的-singletonInit裡邊進行的，因此子類的初始化也必須呼叫父類的方法，這樣才能保證完全初始化。所以我們必須在-singletonInit中呼叫 super 方法。可是問題來了， -singletonInit是需要開發者自己實現的，怎麼保證開發者不會忘記新增[super singletonInit]呢？大家可能會想起，在 xcode 中寫 viewController 的時候，-viewWillAppear:等方法，如果不寫 supper 呼叫，就會出編譯警告，提示你必須呼叫 super 方法。這就是利用了 llvm 的編譯屬性，蘋果已經把它封裝成一個巨集：NS_REQUIRES_SUPER。所以我們繼續新增如下程式碼：

/// .h
@interface NSObject (SingletonInit)
- (void)singletonInit NS_REQUIRES_SUPER;
@end

/// .m
@implementation NSObject (SingletonInit)
- (void)singletonInit {}
@end
複製程式碼

然後在每個單例的 -singletonInit 中新增[super singletonInit];, 執行測試用例，輸出如下:

2019-04-13 13:40:57.294312+0800 TestProj[12932:7675173] caller: <SingletonClass: 0x6000028874f0>; SingletonClass customic init
2019-04-13 13:40:57.294442+0800 TestProj[12932:7675173] 01: <SingletonClass: 0x6000028874f0>
2019-04-13 13:40:57.294569+0800 TestProj[12932:7675173] 02: <SingletonClass: 0x6000028874f0>
2019-04-13 13:40:57.294653+0800 TestProj[12932:7675173] caller: <SingletonClassSon: 0x600002898240>; SingletonClass customic init
2019-04-13 13:40:57.294724+0800 TestProj[12932:7675173] caller: <SingletonClassSon: 0x600002898240>; SingletonClassSon customic init
2019-04-13 13:40:57.294810+0800 TestProj[12932:7675173] 11: <SingletonClassSon: 0x600002898240>
2019-04-13 13:40:57.294879+0800 TestProj[12932:7675173] 12: <SingletonClassSon: 0x600002898240>
複製程式碼

事情貌似都解決了, 嗯~~ 好像又看到了一個新概念weak singleton。修改成 wean 單例模式：

// static SingletonClass *instance_SingletonClass = nil;
static __weak SingletonClass *instance_SingletonClass = nil;
複製程式碼

執行下邊的測試用例：

    id obj = [SingletonClass sharedInstance];
    NSLog(@"01: %@", obj);
    NSLog(@"02: %@", [[SingletonClass alloc] init]);

    obj = [SingletonClass sharedInstance];
    NSLog(@"11: %@", obj);
    NSLog(@"12: %@", [[SingletonClass alloc] init]);

    obj = nil;
    obj = [SingletonClass sharedInstance];
    NSLog(@"21: %@", obj);
    NSLog(@"22: %@", [[SingletonClass alloc] init]);
複製程式碼

結果如下:

2019-04-14 13:24:21.327596+0800 TestProj[36068:8203530] 01: <SingletonClass: 0x600002c8b2b0>
2019-04-14 13:24:21.327725+0800 TestProj[36068:8203530] 02: <SingletonClass: 0x600002c8b2b0>
2019-04-14 13:24:21.327950+0800 TestProj[36068:8203530] 11: <SingletonClass: 0x600002c8b2b0>
2019-04-14 13:24:21.328037+0800 TestProj[36068:8203530] 12: <SingletonClass: 0x600002c8b2b0>
2019-04-14 13:24:21.328366+0800 TestProj[36068:8203530] 21: (null)
2019-04-14 13:24:21.328617+0800 TestProj[36068:8203530] 22: (null)
複製程式碼

物件被釋放之後，再也不能繼續建立單例了，得到的都是nil。原因就是， dispatch_once，得換個方法。

弊端：不支援 weak 單例

V5.0

我們把+sharedInstance裡邊的dispatch_once換成dispatch_semaphore：

+ (id)sharedInstance {
    __block SingletonClass *strongRef = instance_SingletonClass;
    if (strongRef == nil) {
        static dispatch_semaphore_t lock;
        static dispatch_once_t onceToken;
        dispatch_once(&onceToken, ^{
            lock = dispatch_semaphore_create(1);
        });
        dispatch_semaphore_wait(lock, DISPATCH_TIME_FOREVER);
        if (instance_SingletonClass == nil) {
            strongRef = [[super allocWithZone:NULL] init];
            instance_SingletonClass = strongRef;
        } else {
            strongRef = instance_SingletonClass;
        }
        dispatch_semaphore_signal(lock);
    }
    return strongRef;
}
複製程式碼

輸出如下:

2019-04-14 13:29:20.280302+0800 TestProj[36272:8208680] 01: <SingletonClass: 0x600003824970>
2019-04-14 13:29:20.280400+0800 TestProj[36272:8208680] 02: <SingletonClass: 0x600003824970>
2019-04-14 13:29:20.280486+0800 TestProj[36272:8208680] 11: <SingletonClass: 0x600003824970>
2019-04-14 13:29:20.280594+0800 TestProj[36272:8208680] 12: <SingletonClass: 0x600003824970>
2019-04-14 13:29:20.280871+0800 TestProj[36272:8208680] 21: <SingletonClass: 0x600003824970>
2019-04-14 13:29:20.281358+0800 TestProj[36272:8208680] 22: <SingletonClass: 0x600003824970>
複製程式碼

至此，我們得到了一個基本完整ObjC單例實現，我們用巨集把它變成一個模板：

ALSingletonTemplate.h


#ifndef ALSingletonTemplate_H
#define ALSingletonTemplate_H

/**
 * A template code for define a singleton class.
 * Example:
    <code>
    // .h file
    @interface SingletionTest : NSObject
    AS_SINGLETON
    @end
 
    // .m file
    @implementation SingletionTest
    SYNTHESIZE_SINGLETON(SingletionTest)
    // IMPORTANT: DO NOT add `-init` in you singleton class!!! you should use `-singletonInit` instead!!!
    // and DONT FORGET to add `[super singletonInit]` in you singletonInit method.
    - (void)singletonInit {
        [super singletonInit];
        // your init code here ...
    }
 
    // your code here ...
    @end
 
    // usage:
    SingletionTest *singleton = [SingletionTest sharedInstance];
    // or: SingletionTest *singleton = [[SingletionTest alloc] init];
    // or: SingletionTest *singleton = [SingletionTest new];
    </code>
 */

///////////////////////////////////////////////////////////////////////////////////////////////
/// singleton
#undef AL_AS_SINGLETON
#if __has_feature(objc_arc)
    #define AL_AS_SINGLETON             \
        + (instancetype)sharedInstance; \
        + (void)al_destroySingleton;    \
        - (void)al_destroySingleton;
#else
    #define AL_AS_SINGLETON             \
        + (instancetype)sharedInstance;
#endif

/// weak singleton; only supports ARC
#if __has_feature(objc_arc)
    #undef AL_AS_WEAK_SINGLETON
    #define AL_AS_WEAK_SINGLETON  AL_AS_SINGLETON
#endif

///////////////////////////////////////////////////////////////////////////////////////////////
#undef AL_SYNTHESIZE_SINGLETON
#if __has_feature(objc_arc)
    #undef AL_SYNTHESIZE_WEAK_SINGLETON
    #define AL_SYNTHESIZE_WEAK_SINGLETON(CLS)                               \
        static __weak CLS *__AL_SINGLETON_INSTANCE_FOR_CLASS(CLS) = nil;    \
        __AL_SYNTHESIZE_SINGLETON_ARC(CLS);

    #define AL_SYNTHESIZE_SINGLETON(CLS)                                    \
        static CLS *__AL_SINGLETON_INSTANCE_FOR_CLASS(CLS) = nil;           \
        __AL_SYNTHESIZE_SINGLETON_ARC(CLS);
#else
    #define AL_SYNTHESIZE_SINGLETON(CLS)                           \
        static CLS *__AL_SINGLETON_INSTANCE_FOR_CLASS(CLS) = nil;  \
        __AL_SYNTHESIZE_SINGLETON_MRC(CLS);
#endif

///////////////////////////////////////////////////////////////////////////////////////////////
#undef __AL_SINGLETON_SEMAPHORE_FOR_CLASS
#define __AL_SINGLETON_SEMAPHORE_FOR_CLASS(cls)   __AL_SINGLETON_MACRO_CONCAT(__al_singleton_semaphore_, cls)

#undef __AL_SYNTHESIZE_SINGLETON_COMMON
#define __AL_SYNTHESIZE_SINGLETON_COMMON(cls)                                                                        \
    +(dispatch_semaphore_t) __AL_SINGLETON_SEMAPHORE_FOR_CLASS(cls) {                                                \
        static dispatch_semaphore_t semaphore;                                                                       \
        static dispatch_once_t onceToken;                                                                            \
        dispatch_once(&onceToken, ^{                                                                                 \
            semaphore = dispatch_semaphore_create(1);                                                                \
        });                                                                                                          \
        return semaphore;                                                                                            \
    }                                                                                                                \
                                                                                                                     \
    +(instancetype) sharedInstance {                                                                                 \
        if (self != cls.class) {                                                                                     \
            printf(                                                                                                  \
                "‼️ [SINGLETON] class `%s` invokes `%s` will return the instance of `%s`, which is not the one " \
                "you expected.\n\n",                                                                                     \
                NSStringFromClass(self).UTF8String, __PRETTY_FUNCTION__, #cls);                                      \
        }                                                                                                            \
        __block cls *strongRef = __AL_SINGLETON_INSTANCE_FOR_CLASS(cls);                                             \
        if (strongRef == nil) {                                                                                      \
            dispatch_semaphore_t semaphore = [cls __AL_SINGLETON_SEMAPHORE_FOR_CLASS(cls)];                          \
            __AL_SINGLETON_SEMAPHORE_WITH_TIMEOUT(semaphore,                                                         \
                                                  if (__AL_SINGLETON_INSTANCE_FOR_CLASS(cls) == nil) {               \
                                                      strongRef = [[super allocWithZone:NULL] init];                 \
                                                      __AL_SINGLETON_INSTANCE_FOR_CLASS(cls) = strongRef;            \
                                                  } else { strongRef = __AL_SINGLETON_INSTANCE_FOR_CLASS(cls); });   \
        }                                                                                                            \
        return strongRef;                                                                                            \
    }                                                                                                                \
                                                                                                                     \
        + (id) allocWithZone : (NSZone *) zone {                                                                     \
        if (self == cls.class) {                                                                                     \
            return [self sharedInstance];                                                                            \
        }                                                                                                            \
        return [super allocWithZone:zone];                                                                           \
    }                                                                                                                \
                                                                                                                     \
    -(instancetype) init {                                                                                           \
        static dispatch_semaphore_t semaphore;                                                                       \
        static dispatch_once_t onceToken;                                                                            \
        dispatch_once(&onceToken, ^{                                                                                 \
            semaphore = dispatch_semaphore_create(1);                                                                \
        });                                                                                                          \
                                                                                                                     \
        cls *strongRef = __AL_SINGLETON_INSTANCE_FOR_CLASS(cls);                                                     \
        __AL_SINGLETON_SEMAPHORE_WITH_TIMEOUT(semaphore, if (strongRef.class != self.class) {                        \
            self = [super init];                                                                                     \
            if (self.class == cls.class) {                                                                           \
                [self singletonInit];                                                                                \
            }                                                                                                        \
        });                                                                                                          \
        return self;                                                                                                 \
    }                                                                                                                \
                                                                                                                     \
    -(id) copyWithZone : (nullable NSZone *) zone {                                                                  \
        return self;                                                                                                 \
    }                                                                                                                \
    -(id) mutableCopyWithZone : (nullable NSZone *) zone {                                                           \
        return self;                                                                                                 \
    }

///////////////////////////////////////////////////////////////////////////////////////////////
#undef __AL_SYNTHESIZE_SINGLETON_ARC
#define __AL_SYNTHESIZE_SINGLETON_ARC(cls)                                                        \
    __AL_SYNTHESIZE_SINGLETON_COMMON(cls);                                                        \
    + (void)al_destroySingleton {                                                                 \
        printf("‼️ [SINGLETON] The singleton instance `%s` will be deallocated.\n",           \
               [self description].UTF8String);                                                    \
        dispatch_semaphore_t lock = [cls __AL_SINGLETON_SEMAPHORE_FOR_CLASS(cls)];                \
        __AL_SINGLETON_SEMAPHORE_WITH_TIMEOUT(lock,                                               \
            __AL_SINGLETON_INSTANCE_FOR_CLASS(cls) = nil;                                         \
        );                                                                                        \
    }                                                                                             \
    -(void) al_destroySingleton {                                                                 \
        [self.class al_destroySingleton];                                                         \
    };

///////////////////////////////////////////////////////////////////////////////////////////////
#undef __AL_SYNTHESIZE_SINGLETON_MRC
#define __AL_SYNTHESIZE_SINGLETON_MRC(cls)              \
    __AL_SYNTHESIZE_SINGLETON_COMMON(cls);              \
                                                        \
    - (instancetype)retain { return self; }             \
    - (oneway void)release{}                            \
    - (instancetype)autorelease {  return self; }       \
    - (NSUInteger)retainCount { return NSUIntegerMax; }

///////////////////////////////////////////////////////////////////////////////////////////////

#undef __AL_SINGLETON_MACRO_CONCAT_
#define __AL_SINGLETON_MACRO_CONCAT_(a, b) a##b
#undef __AL_SINGLETON_MACRO_CONCAT
#define __AL_SINGLETON_MACRO_CONCAT(a, b) __AL_SINGLETON_MACRO_CONCAT_(a, b)

#undef __AL_SINGLETON_INSTANCE_FOR_CLASS
#define __AL_SINGLETON_INSTANCE_FOR_CLASS(cls) __AL_SINGLETON_MACRO_CONCAT(__al_singleton_instance_, cls)

///
/// execute the code statements `jobStmt` in dispatch_semaphore.
/// Try to get the semaphore in 10 secods, if failed, that may means a deadlock is occured. and you should check you code.
/// @note DO NOT return in `jobStmt`, otherwise the samaphore will not be processed correctly.
///
#undef __AL_SINGLETON_SEMAPHORE_WITH_TIMEOUT
#define __AL_SINGLETON_SEMAPHORE_WITH_TIMEOUT(sema, jobStmt)                                                        \
    if (dispatch_semaphore_wait((sema), dispatch_time(DISPATCH_TIME_NOW, (int64_t)(10.f * NSEC_PER_SEC))) == 0) {   \
        jobStmt;                                                                                                    \
        dispatch_semaphore_signal((sema));                                                                          \
    } else {                                                                                                        \
        NSAssert(NO, @"[SINGLETON] %s: timeout while waiting to acquire the lock. Deadlock may occured!", __PRETTY_FUNCTION__); \
    }

#endif // ALSingletonTemplate_H
複製程式碼

NSObject+ALSingletonInit.h

@interface NSObject (ALSingletonInit)
- (void)singletonInit NS_REQUIRES_SUPER;
@end
複製程式碼

NSObject+ALSingletonInit.m

#import "NSObject+ALSingletonInit.h"

@implementation NSObject (ALSingletonInit)
- (void)singletonInit {};
@end
複製程式碼

把這幾個檔案新增到工程中，如果某個類需要時單例，只需在檔案中簡單的新增兩行就可以：

// .h
@interface MyClass : NSObject
AL_AS_SINGLETON; // <- 標頭檔案中加入這個巨集

/// your code here ...
@end

// .m
@implementation MyClass
AL_SYNTHESIZE_SINGLETON(MyClass); // <- .m檔案中加入這個巨集

/// 需要注意的是， 初始化不能直接用 init 方法， 需要用 singletonInit
/// - (void)singletonInit {
///    /// 初始化程式碼寫這裡, 比如
///     _myIvar = xxx;
/// }

/// your code here ...
@end
複製程式碼

總結

要用 ObjC 實現一個完整的單例，需要注意以下幾點：

不管用何種初始化方式，都只能有一個例項。
alloc init必須保證“原子性”，否則在多執行緒情況下就會出現 ThreadA 執行完 alloc, 然後另外一個執行緒就有可能獲取到的是這個剛 alloc 出來還沒執行 init 的例項，導致意外情況。
int 必須保證只能執行一次。
【可選】繼承，weak 單例模式還需要另外考慮。

你真的會寫單例模式嗎？
2016-04-12
單例模式
如何寫出一個好的單例模式
2019-01-23
單例模式
一個單例還能寫出花來嗎？
2021-04-15
單例
你真的會寫單例模式嗎——Java實現
2019-02-21
單例模式Java
程式設計師築基之路——如何寫好一個單例
2017-09-20
程式設計師單例
你真的需要做一個App麼？
2015-06-30
APP
如何快速的寫一個單例
2016-09-26
單例
面試官：請寫一個你認為比較“完美”的單例
2020-05-15
面試單例
書寫一個嚴謹的單例
2018-01-19
單例
美團面試官問：寫一個你認為最好的單例模式？於是我寫了7個
2021-11-03
面試單例模式
您的單例模式，真的單例嗎？
2020-06-15
單例模式
[程式設計] 你真的會寫函式註釋？這裡給你一個答案
2023-12-04
程式設計函式
單例模式你會幾種寫法？
2018-05-16
單例模式
你的單例模式真的是執行緒安全的嗎?
2018-10-10
單例模式執行緒
你真的知道怎麼實現一個延遲佇列嗎？
2020-10-12
佇列
面試：一個單例模式，足以把你秒成渣
2020-09-26
面試單例模式
美團一面：會單例模式嗎，寫個單例看看？（8大單例模式實現方式總結）
2023-11-13
單例模式
如何寫好一個UITableView(上)
2016-04-18
UIView
你用過不寫程式碼就能完成一個簡單模組的元件麼？
2018-10-16
元件
【極客思考】設計模式：你確定你真的理解了單例模式嗎？
2020-05-27
設計模式單例
單例模式 - 只有一個例項
2017-06-07
單例模式
Ubuntu，真的有那麼好嗎？
2009-05-16
Ubuntu
寫好你的JavaScript
2017-03-02
JavaScript
如何寫好一個自定義View
2018-10-01
View
【設計模式】你的單例模式真的是生產可用的嗎？
2019-02-07
設計模式單例
花式寫單例之單例的六種寫法
2017-11-23
單例
編寫你的第一個 Android 單元測試
2019-05-21
Android
[手寫系列] 帶你實現一個簡單的Promise
2022-03-08
Promise
Python單例的一種簡單寫法
2018-11-01
Python單例
一個好的軟體測試計劃要怎麼寫？
2019-07-15
面試題：你能寫一個Vue的雙向資料繫結嗎？
2021-09-09
面試題Vue
面試題：你能寫一個 Vue 的雙向資料繫結嗎
2018-04-19
面試題Vue
ios 高效的寫好一個UI介面（一）
2016-07-28
iOSUI
單例模式(下)---聊一聊單例模式的幾種寫法
2018-09-18
單例模式
單例模式(下) - 聊一聊單例模式的幾種寫法
2018-09-18
單例模式
單例模式(下) – 聊一聊單例模式的幾種寫法
2018-12-30
單例模式
TensorFlow Research Cloud能為你帶來什麼好處？
2017-05-27
Cloud
簡單寫一個eventbus
2024-04-15