在之前的帖子里聊過狀態(tài)管理有多痛苦,有時(shí)這是不可避免的后德。一個(gè)狀態(tài)管理的例子大家都很熟悉部宿,那就是單例。使用Swift時(shí)探遵,有許多方法實(shí)現(xiàn)單例窟赏,這是個(gè)麻煩事,因?yàn)槲覀儾恢滥膫€(gè)最合適箱季。這里我們來回顧一下單例的歷史涯穷,看一看在Swift中如何正確地實(shí)現(xiàn)單例。
如果你想直接看看Swift中單例的正確實(shí)現(xiàn)方式藏雏,直接跳到帖子最后即可拷况。
往事回憶之ObjC單例
Swift是Objective-C的一種自然演變,它用如下的方式實(shí)現(xiàn)單例:
@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
在這個(gè)現(xiàn)成方案中掘殴,我們可以看到單例的基本結(jié)構(gòu)赚瘦。讓我們來約定一些規(guī)則,這樣便于更好的理解奏寨。
單例規(guī)則
關(guān)于單例起意,有三個(gè)重要的準(zhǔn)則需要牢記:
- 單例必須是唯一的(要不怎么叫單例?) 在程序生命周期中只能存在一個(gè)這樣的實(shí)例病瞳。單例的存在使我們可以全局訪問狀態(tài)揽咕。例如:
NSNotificationCenter
, UIApplication
和NSUserDefaults
。
為保證單例的唯一性套菜,單例類的初始化方法必須是私有的亲善。這樣就可以避免其他對(duì)象通過單例類創(chuàng)建額外的實(shí)例。
考慮到規(guī)則1逗柴,為保證在整個(gè)程序的生命周期中值有一個(gè)實(shí)例被創(chuàng)建蛹头,單例必須是線程安全的。并發(fā)有時(shí)候確實(shí)挺復(fù)雜,簡(jiǎn)單說來渣蜗,如果單例的代碼不正確屠尊,如果有兩個(gè)線程同時(shí)實(shí)例化一個(gè)單例對(duì)象,就可能會(huì)創(chuàng)建出兩個(gè)單例對(duì)象袍睡。也就是說知染,必須保證單例的線程安全性,才可以保證其唯一性斑胜。通過調(diào)用
dispatch_once
绍申,即可保證實(shí)例化代碼只運(yùn)行一次浴骂。
在程序中保持單例的唯一性,只初始化一次,這樣并不難乡翅。帖子的余下部分中岭妖,需要記着迥ā:?jiǎn)卫龑?shí)現(xiàn)要滿足隱藏的dispatch_once
規(guī)則酪碘。
Swift單例
自Swift 1.0開始,創(chuàng)建單例有很多種方法么夫。這些鏈接中已經(jīng)有很詳盡的描述者冤,比如
但是誰喜歡點(diǎn)鏈接呢?先劇透一下吧:總共有4個(gè)版本档痪。我們來清點(diǎn)一下:
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!
}
}
這個(gè)版本是Objective-C的直接移植版。我認(rèn)為它不好看是因?yàn)镾wift本該更簡(jiǎn)潔腐螟、更有描述力愿汰。不要做個(gè)搬運(yùn)工,要做就做的更好乐纸。
2. 結(jié)構(gòu)體方法(“新瓶裝老酒)
class TheOneAndOnlyKraken {
class var sharedInstance: TheOneAndOnlyKraken {
struct Static {
static let instance = TheOneAndOnlyKraken()
}
return Static.instance
}
}
Swift 1.0時(shí)衬廷,不支持靜態(tài)類變量,那時(shí)這個(gè)方法是不得已而為之汽绢。但使用結(jié)構(gòu)體吗跋,就可以支持這個(gè)功能。因?yàn)殪o態(tài)變量的限制宁昭,我們被約束在這樣的一個(gè)模型中跌宛。這比Objective-C移植版本好一些,但還不夠好久窟。有趣的是秩冈,在Swift 1.2發(fā)布幾個(gè)月后本缠,我還可以看到這種寫法斥扛。在那之后,反而更多了。
3. 全局變量方法(“單行單例”方法)
private let sharedKraken = TheOneAndOnlyKraken()
class TheOneAndOnlyKraken {
class var sharedInstance: TheOneAndOnlyKraken {
return sharedKraken
}
}
在Swift 1.2以后稀颁,我們有了訪問權(quán)限設(shè)置(access control specifiers) 的功能和靜態(tài)類成員(static class members)芬失。這意味著我們終于可以擺脫混亂的全局變量、全局命名空間匾灶,也不會(huì)發(fā)生命名空間沖突了棱烂。這個(gè)版本看起來更Swiftier一點(diǎn)。
現(xiàn)在阶女,你可能會(huì)有疑問:為何看不到dispatch_once
颊糜?根據(jù)Apple Swift博客中的說法,以上方法都自動(dòng)滿足dispatch_once
規(guī)則秃踩。這里有個(gè)帖子可以證明dispatch_once
規(guī)則一直在起作用衬鱼。
“全局變量(還有結(jié)構(gòu)體和枚舉體的靜態(tài)成員)的Lazy初始化方法會(huì)在其被訪問的時(shí)候調(diào)用一次。類似于調(diào)用
dispatch_once
以保證其初始化的原子性憔杨。這樣就有了一種很酷的'單次調(diào)用'方式:只聲明一個(gè)全局變量和私有的初始化方法即可鸟赫。”--來自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 usedispatch_once
in your code: just declare a global variable with an initializer and mark it private.”)
這就是Apple官方文檔給我們的所有信息消别,但這些已經(jīng)足夠證明全局變量和結(jié)構(gòu)體/枚舉體的靜態(tài)成員是支持dispatch_once
特性的∨自椋現(xiàn)在,我們相信使用全局變量來“懶包裝”單例的初始化方法到dispatch_once
代碼塊中是100%安全的寻狂。但是對(duì)于靜態(tài)類變量來說岁经,情況又如何?
這個(gè)問題帶我們到更激動(dòng)人心的思考中去:
正確的方法(也即是“單行單例法”)現(xiàn)在已經(jīng)被證明正確荆虱。
class TheOneAndOnlyKraken {
static let sharedInstance = TheOneAndOnlyKraken()
}
到此為止蒿偎,我們已經(jīng)做了許多研究工作。這個(gè)帖子的靈感來源于我們?cè)贑apital One的一次對(duì)話:結(jié)對(duì)編程review代碼的過程中怀读,我們?cè)噲D找到在App中使用Swift編寫正確诉位、一致的單例方法。我們知道編寫單例的正確方法菜枷,但是無法用理論來證明苍糠。沒有足夠的文檔支持,想證明方法的正確是徒勞的啤誊。在網(wǎng)上或博客圈中沒有足夠多的信息的話岳瞭,這只能是一家之言,大家都知道如果網(wǎng)上查不到信息蚊锹,就不會(huì)相信瞳筏。這點(diǎn)讓我很難過。
我搜索了許多信息牡昆,甚至翻到了google搜索結(jié)果的10多頁姚炕,還是一無所獲。難道沒有人發(fā)帖證明單行單利方法的正確性?可能有人發(fā)過柱宦,但是太難被發(fā)現(xiàn)了些椒。
因此我決定將各種單例都寫一變,然后在運(yùn)行時(shí)加入斷點(diǎn)來觀測(cè)掸刊。
分析了每個(gè)stack trace的記錄后免糕,我發(fā)現(xiàn)了有趣的東西——證據(jù)!
來看看截圖:
使用全局單例方法
使用單行單例方法
第一張圖片展示了使用全局實(shí)例時(shí)的stack trace
忧侧。標(biāo)紅的地方需要注意石窑。在調(diào)用Kraken
單例之前,先調(diào)用了swift_once
蚓炬,接下來是swift_once_block_invoke
尼斧。Apple之前在文檔中已經(jīng)說過,“懶實(shí)例化”的全局變量會(huì)被自動(dòng)放在dispatch_once
塊中试吁,我們可以假定說的就是這個(gè)東西棺棵。
了解了這些知識(shí),我們來看看漂亮的單行單例方法熄捍。如圖所示烛恤,調(diào)用完全一樣。這樣余耽,我們就有了證據(jù)證明單行單例方法是正確的缚柏。
不要忘記設(shè)置初始化方法為私有
@davedelong,Apple的Framework傳道者碟贾,善意地提醒我:必須保證init
方法的私有性币喧,只有這樣,才能保證單例是真正唯一的袱耽,避免外部對(duì)象通過訪問init
方法創(chuàng)建單例類的其他實(shí)例杀餐。由于Swift中的所有對(duì)象都是由公共的初始化方法創(chuàng)建的,我們需要重寫自己的init
方法朱巨,并設(shè)置其為私有的史翘。這很簡(jiǎn)單,而且不會(huì)破壞到我們優(yōu)雅的單行單例方法冀续。
class TheOneAndOnlyKraken {
static let sharedInstance = TheOneAndOnlyKraken()
private init() {} //This prevents others from using the default '()' initializer for this class.
}
這樣做就可以保證編譯器在某個(gè)類嘗試使用()來初始化TheOneAndOnlyKraken
時(shí)琼讽,拋出錯(cuò)誤:
就是這樣,我們的單行單例洪唐,非常完美钻蹬!
結(jié)論
這里回復(fù)一下jtbandes在“top rated answer to swift singletons on Stack Overflow”這個(gè)帖子中的問題:我也找不到哪里有文檔證明let語句可以帶來線程安全性的好處。我記得在去年參加WWDC的時(shí)候有類似的說法凭需,沒辦法保證讀者或各位Googler也偶遇到這個(gè)說法问欠。希望這個(gè)帖子能幫助大家理解為什么單行單例在Swift中是正確的方法桂敛。