單例模式保證一個類別在整個程式運行期間只有一個實例,而且這個實例容易取得。它同時達到兩個目的:控制實例數量、節省系統資源。
適用場景很明確——某份資源需要在整個 App 中共享,而且只需要初始化一次。舉例來說,你寫了一個音樂播放器 NYPlayer,直覺上它就是「只該有一個」的東西:多個實例不僅難以指定要操作哪一個,重複播放還會衍生各種 bug。這時候單例就是最直接的答案。
思路是在 .m 裡保留一個 static 的全域實例,然後覆寫 allocWithZone: 與提供一個類方法作為對外入口。static 讓變數在整個生命週期都存在,也不會被外部直接看到。
static id _instance;
+ (id)allocWithZone:(struct _NSZone *)zone {
if (_instance == nil) {
@synchronized(self) { // 避免頻繁加鎖
if (_instance == nil) { // 避免重複建立
_instance = [super allocWithZone:zone];
}
}
}
return _instance;
}
之所以要覆寫這個方法,是因為呼叫 [類名 alloc] 時內部會走到 allocWithZone: 去配置記憶體。若不加保護,兩個執行緒同時進入就會配置出兩個實例——這裡的雙重檢查加鎖就是為了避免此事。
+ (instancetype)sharedMusicTool {
static id _instance;
if (_instance == nil) {
@synchronized(self) {
if (_instance == nil) {
_instance = [[self alloc] init];
}
}
}
return _instance;
}
- (id)copyWithZone:(struct _NSZone *)zone {
return _instance; // 複製仍回傳同一個物件
}
沒有 ARC 幫你管理記憶體時,必須自行實作引用計數相關方法,讓這個物件永遠不會被釋放:
- (id)retain { return self; } // 父類實作是計數 +1
- (NSUInteger)retainCount { return 1; } // 固定回傳 1
- (oneway void)release {} // 父類實作是計數 -1,這裡留空
- (id)autorelease { return self; } // 不進入自動釋放池
先認識一個宏:__has_feature(objc_arc)。ARC 與 MRC 的寫法不同,需要兩套程式碼,可以用它來判斷當前環境:
#if __has_feature(objc_arc) // ARC 版本 #else // MRC 版本 #endif
而更乾淨的做法,是把 @synchronized 換成 GCD 的一次性執行:
+ (id)allocWithZone:(struct _NSZone *)zone {
if (_instance == nil) {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
if (_instance == nil) {
_instance = [super allocWithZone:zone];
}
});
}
return _instance;
}
dispatch_once 由系統保證區塊在整個生命週期只會執行一次,而且是執行緒安全的,比自己寫雙重檢查鎖更輕巧可靠。在 Xcode 裡只要敲 dispatch_once 就有現成的樣板可以帶入。
把樣板包成宏放進專用的標頭檔,之後每個類別只要呼叫一次宏就擁有了單例能力。
// NYSingleton.h #define NYSingletonH(name) + (instancetype)shared##name;
## 是 token 串接,傳入 name 就會自動展開成 sharedXxx 這樣的方法名。
實作端的宏則依 ARC/MRC 分別定義(ARC 版包含 allocWithZone:、sharedXxx、copyWithZone:;MRC 版再多出四個記憶體管理方法),這裡以精簡形式表示:
#define NYSingletonM(name) \
static id _instance; \
+ (id)allocWithZone:(struct _NSZone *)zone { \
static dispatch_once_t onceToken; \
dispatch_once(&onceToken, ^{ _instance = [super allocWithZone:zone]; }); \
return _instance; \
} \
+ (instancetype)shared##name { \
static dispatch_once_t onceToken; \
dispatch_once(&onceToken, ^{ _instance = [[self alloc] init]; }); \
return _instance; \
} \
- (id)copyWithZone:(NSZone *)zone { return _instance; }
每個結尾的反斜線是把下一行接續進來,因為 #define 只能定義一行。
接著在 pch 檔中引入這個標頭:
#import "NYSingleton.h"
之後在 .h 與 .m 中分別呼叫 NYSingletonH 與 NYSingletonM,就能直接透過共享方法取得實例。
開發階段靠 NSLog 除錯很順手,但正式版若殘留大量日誌輸出,除了效能與隱私疑慮,也有被審核退回的風險;而要全部註解掉,往後除錯又會很痛苦。折衷做法是自訂宏,只在需要時才輸出:
#ifdef DEBUG
#define NSLog(FORMAT, ...) fprintf(stderr, "%s:%d %s\n", \
[[[NSString stringWithUTF8String:__FILE__] lastPathComponent] UTF8String], \
__LINE__, \
[[NSString stringWithFormat:FORMAT, ##__VA_ARGS__] UTF8String]);
#else
#define NSLog(FORMAT, ...) nil
#endif
把這段貼進 ProjectName-Prefix.pch,除錯時會輸出「檔名:行號 內容」格式的日誌,而 Release 版本則自動關閉輸出。原理是 Xcode 在 Debug 組態下會加上 DEBUG=1 標誌,因此 #ifdef DEBUG 自然成立;當然你也可以直接判斷數字 1。