Swift中編寫單例的正確方式


在之前的帖子里聊過狀態(tài)管理有多痛苦,有時(shí)這是不可避免的后德。一個(gè)狀態(tài)管理的例子大家都很熟悉部宿,那就是單例。使用Swift時(shí)探遵,有許多方法實(shí)現(xiàn)單例窟赏,這是個(gè)麻煩事,因?yàn)槲覀儾恢滥膫€(gè)最合適箱季。這里我們來回顧一下單例的歷史涯穷,看一看在Swift中如何正確地實(shí)現(xiàn)單例。

如果你想直接看看Swift中單例的正確實(shí)現(xiàn)方式藏雏,直接跳到帖子最后即可拷况。

圖片-1

往事回憶之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)則需要牢記:

  1. 單例必須是唯一的(要不怎么叫單例?) 在程序生命周期中只能存在一個(gè)這樣的實(shí)例病瞳。單例的存在使我們可以全局訪問狀態(tài)揽咕。例如:

NSNotificationCenter, UIApplicationNSUserDefaults

  1. 為保證單例的唯一性套菜,單例類的初始化方法必須是私有的亲善。這樣就可以避免其他對(duì)象通過單例類創(chuàng)建額外的實(shí)例。

  2. 考慮到規(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
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 use dispatch_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()
}
圖片-3

到此為止蒿偎,我們已經(jīng)做了許多研究工作。這個(gè)帖子的靈感來源于我們?cè)贑apital One的一次對(duì)話:結(jié)對(duì)編程review代碼的過程中怀读,我們?cè)噲D找到在App中使用Swift編寫正確诉位、一致的單例方法。我們知道編寫單例的正確方法菜枷,但是無法用理論來證明苍糠。沒有足夠的文檔支持,想證明方法的正確是徒勞的啤誊。在網(wǎng)上或博客圈中沒有足夠多的信息的話岳瞭,這只能是一家之言,大家都知道如果網(wǎng)上查不到信息蚊锹,就不會(huì)相信瞳筏。這點(diǎn)讓我很難過。

圖片-4

我搜索了許多信息牡昆,甚至翻到了google搜索結(jié)果的10多頁姚炕,還是一無所獲。難道沒有人發(fā)帖證明單行單利方法的正確性?可能有人發(fā)過柱宦,但是太難被發(fā)現(xiàn)了些椒。

因此我決定將各種單例都寫一變,然后在運(yùn)行時(shí)加入斷點(diǎn)來觀測(cè)掸刊。

分析了每個(gè)stack trace的記錄后免糕,我發(fā)現(xiàn)了有趣的東西——證據(jù)!

來看看截圖:

使用全局單例方法


圖片-5

使用單行單例方法

圖片-6

第一張圖片展示了使用全局實(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ò)誤:

圖片-7

就是這樣,我們的單行單例洪唐,非常完美钻蹬!

結(jié)論

這里回復(fù)一下jtbandes在“top rated answer to swift singletons on Stack Overflow”這個(gè)帖子中的問題:我也找不到哪里有文檔證明let語句可以帶來線程安全性的好處。我記得在去年參加WWDC的時(shí)候有類似的說法凭需,沒辦法保證讀者或各位Googler也偶遇到這個(gè)說法问欠。希望這個(gè)帖子能幫助大家理解為什么單行單例在Swift中是正確的方法桂敛。

CocoaChina 譯文

THE RIGHT WAY TO WRITE A SINGLETON (原文)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市溅潜,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌薪伏,老刑警劉巖滚澜,帶你破解...
    沈念sama閱讀 206,378評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異嫁怀,居然都是意外死亡设捐,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,356評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門塘淑,熙熙樓的掌柜王于貴愁眉苦臉地迎上來萝招,“玉大人,你說我怎么就攤上這事存捺』闭樱” “怎么了?”我有些...
    開封第一講書人閱讀 152,702評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵捌治,是天一觀的道長(zhǎng)岗钩。 經(jīng)常有香客問我,道長(zhǎng)肖油,這世上最難降的妖魔是什么兼吓? 我笑而不...
    開封第一講書人閱讀 55,259評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮森枪,結(jié)果婚禮上视搏,老公的妹妹穿的比我還像新娘。我一直安慰自己县袱,他們只是感情好浑娜,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,263評(píng)論 5 371
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著式散,像睡著了一般棚愤。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上杂数,一...
    開封第一講書人閱讀 49,036評(píng)論 1 285
  • 那天宛畦,我揣著相機(jī)與錄音,去河邊找鬼揍移。 笑死次和,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的那伐。 我是一名探鬼主播踏施,決...
    沈念sama閱讀 38,349評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼石蔗,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了畅形?” 一聲冷哼從身側(cè)響起养距,我...
    開封第一講書人閱讀 36,979評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎日熬,沒想到半個(gè)月后棍厌,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,469評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡竖席,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,938評(píng)論 2 323
  • 正文 我和宋清朗相戀三年耘纱,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片毕荐。...
    茶點(diǎn)故事閱讀 38,059評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡束析,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出憎亚,到底是詐尸還是另有隱情员寇,我是刑警寧澤,帶...
    沈念sama閱讀 33,703評(píng)論 4 323
  • 正文 年R本政府宣布第美,位于F島的核電站丁恭,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏斋日。R本人自食惡果不足惜牲览,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,257評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望恶守。 院中可真熱鬧第献,春花似錦、人聲如沸兔港。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,262評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽衫樊。三九已至飒赃,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間科侈,已是汗流浹背载佳。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留臀栈,地道東北人蔫慧。 一個(gè)月前我還...
    沈念sama閱讀 45,501評(píng)論 2 354
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像权薯,于是被迫代替她去往敵國(guó)和親姑躲。 傳聞我的和親對(duì)象是個(gè)殘疾皇子睡扬,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,792評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容

  • 往事回憶之ObjC單例Swift是Objective-C的一種自然演變,它用如下的方式實(shí)現(xiàn)單例: 在這個(gè)現(xiàn)成方案中...
    王小賓閱讀 3,145評(píng)論 0 5
  • 在之前的帖子里聊過狀態(tài)管理有多痛苦黍析,有時(shí)這是不可避免的卖怜。一個(gè)狀態(tài)管理的例子大家都很熟悉,那就是單例阐枣。使用Swift...
    Tank丶Farmer閱讀 6,351評(píng)論 0 5
  • 在使用swift編程語言進(jìn)行iOS應(yīng)用開發(fā)的時(shí)候侮繁,我們常常借助單例來進(jìn)行狀態(tài)管理,但由于實(shí)現(xiàn)單例的方法很多如孝,問題就...
    突然自我閱讀 607評(píng)論 0 0
  • 雖然入坑時(shí)曾經(jīng)用Swift2.0寫過4個(gè)多月代碼宪哩,后來換公司項(xiàng)目又用OC了,現(xiàn)在打算用Swift寫代碼了. OC...
    plantseeds閱讀 9,962評(píng)論 0 5
  • 盡管 Grand Central Dispatch (GCD)已經(jīng)存在一段時(shí)間了第晰,但并非每個(gè)人都知道怎么使用它锁孟。這...
    coderFamer閱讀 7,362評(píng)論 1 16