往事回憶之ObjC單例
Swift是Objective-C的一種自然演變,它用如下的方式實現單例:
@interface Kraken : NSObject
@end
@implementation Kraken
+ (instancetype)sharedInstance {
static Kraken *sharedInstance = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
sharedInstance = [[Kraken alloc] init];
});
return sharedInstance;
}
@end
在這個現成方案中,我們可以看到單例的基本結構。讓我們來約定一些規則,這樣便于更好的理解。
單例規則
關于單例,有三個重要的準則需要牢記:
- 單例必須是唯一的(要不怎么叫單例?) 在程序生命周期中只能存在一個這樣的實例。單例的存在使我們可以全局訪問狀態。例如:
NSNotificationCenter, UIApplication和NSUserDefaults。 - 為保證單例的唯一性,單例類的初始化方法必須是私有的。這樣就可以避免其他對象通過單例類創建額外的實例。
- 考慮到規則1,為保證在整個程序的生命周期中值有一個實例被創建,單例必須是線程安全的。并發有時候確實挺復雜,簡單說來,如果單例的代碼不正確,如果有兩個線程同時實例化一個單例對象,就可能會創建出兩個單例對象。也就是說,必須保證單例的線程安全性,才可以保證其唯一性。通過調用dispatch_once,即可保證實例化代碼只運行一次。
在程序中保持單例的唯一性,只初始化一次,這樣并不難。帖子的余下部分中,需要記住:單例實現要滿足隱藏的dispatch_once規則。
Swift單例
自Swift 1.0開始,創建單例有很多種方法。這些鏈接中已經有很詳盡的描述,比如
https://github.com/hpique/SwiftSingleton,http://stackoverflow.com/questions/24024549/dispatch-once-singleton-model-in-swift和
https://developer.apple.com/swift/blog/?id=7。但是誰喜歡點鏈接呢?先劇透一下吧:總共有4個版本。我們來清點一下:
1. 最丑陋方法(Swift皮,Objective-C心)
class TheOneAndOnlyKraken {
class var sharedInstance: TheOneAndOnlyKraken {
struct Static {
static var onceToken: dispatch_once_t = 0
static var instance: TheOneAndOnlyKraken? = nil
}
dispatch_once(&Static.onceToken) {
Static.instance = TheOneAndOnlyKraken()
}
return Static.instance!
}
}
這個版本是Objective-C的直接移植版。我認為它不好看是因為Swift本該更簡潔、更有描述力。不要做個搬運工,要做就做的更好。
2. 結構體方法(“新瓶裝老酒)
class TheOneAndOnlyKraken {
class var sharedInstance: TheOneAndOnlyKraken {
struct Static {
static let instance = TheOneAndOnlyKraken()
}
return Static.instance
}
}
Swift 1.0時,不支持靜態類變量,那時這個方法是不得已而為之。但使用結構體,就可以支持這個功能。因為靜態變量的限制,我們被約束在這樣的一個模型中。這比Objective-C移植版本好一些,但還不夠好。有趣的是,在Swift 1.2發布幾個月后,我還可以看到這種寫法。在那之后,反而更多了。
3.全局變量方法(“單行單例”方法)
private let sharedKraken = TheOneAndOnlyKraken()
class TheOneAndOnlyKraken {
class var sharedInstance: TheOneAndOnlyKraken {
return sharedKraken
}
}
在Swift 1.2以后,我們有了訪問權限設置(access control specifiers) 的功能和靜態類成員(static class members)。這意味著我們終于可以擺脫混亂的全局變量、全局命名空間,也不會發生命名空間沖突了。這個版本看起來更Swiftier一點。
現在,你可能會有疑問:為何看不到dispatch_once?根據Apple Swift博客中的說法,以上方法都自動滿足dispatch_once規則。這里有個帖子可以證明dispatch_once規則一直在起作用。
“全局變量(還有結構體和枚舉體的靜態成員)的Lazy初始化方法會在其被訪問的時候調用一次。類似于調用'dispatch_once'以保證其初始化的原子性。這樣就有了一種很酷的'單次調用'方式:只聲明一個全局變量和私有的初始化方法即可。”--來自Apple's Swift Blog
(“The lazy initializer for a global variable (also for static members of structs and enums) is run the first time that global is accessed, and is launched as dispatch_once
to make sure that the initialization is atomic. This enables a cool way to use dispatch_once
in your code: just declare a global variable with an initializer and mark it private.”)這就是Apple官方文檔給我們的所有信息,但這些已經足夠證明全局變量和結構體/枚舉體的靜態成員是支持”dispatch_once”特性的。現在,我們相信使用全局變量來“懶包裝”單例的初始化方法到dispatch_once代碼塊中是100%安全的。但是對于靜態類變量來說,情況又如何?
這個問題帶我們到更激動人心的思考中去:
正確的方法(也即是“單行單例法”)現在已經被證明正確。
class TheOneAndOnlyKraken {
static let sharedInstance = TheOneAndOnlyKraken()
}
到此為止,我們已經做了許多研究工作。這個帖子的靈感來源于我們在Capital One的一次對話:結對編程review代碼的過程中,我們試圖找到在App中使用Swift編寫正確、一致的單例方法。我們知道編寫單例的正確方法,但是無法用理論來證明。沒有足夠的文檔支持,想證明方法的正確是徒勞的。在網上或博客圈中沒有足夠多的信息的話,這只能是一家之言,大家都知道如果網上查不到信息,就不會相信。這點讓我很難過。
我搜索了許多信息,甚至翻到了google搜索結果的10多頁,還是一無所獲。難道沒有人發帖證明單行單利方法的正確性?可能有人發過,但是太難被發現了。
因此我決定將各種單例都寫一變,然后在運行時加入斷點來觀測。
分析了每個stack trace的記錄后,我發現了有趣的東西——證據!
來看看截圖:
使用全局單例方法
使用單行單例方法
第一張圖片展示了使用全局實例時的stack trace。標紅的地方需要注意。在調用Kraken單例之前,先調用了swift_once,接下來是swift_once_block_invoke。Apple之前在文檔中已經說過,“懶實例化”的全局變量會被自動放在dispatch_once塊中,我們可以假定說的就是這個東西。
了解了這些知識,我們來看看漂亮的單行單例方法。如圖所示,調用完全一樣。這樣,我們就有了證據證明單行單例方法是正確的。
不要忘記設置初始化方法為私有
@davedelong,Apple的Framework傳道者,善意地提醒我:必須保證init方法的私有性,只有這樣,才能保證單例是真正唯一的,避免外部對象通過訪問init方法創建單例類的其他實例。由于Swift中的所有對象都是由公共的初始化方法創建的,我們需要重寫自己的init方法,并設置其為私有的。這很簡單,而且不會破壞到我們優雅的單行單例方法。
class TheOneAndOnlyKraken {
static let sharedInstance = TheOneAndOnlyKraken()
private init() {}
//This prevents others from using the default '()' initializer for this class.
}
這樣做就可以保證編譯器在某個類嘗試使用()來初始化TheOneAndOnlyKraken時,拋出錯誤:
就是這樣,我們的單行單例,非常完美!