Swift中編寫單例的正確方式


在之前的帖子里聊過狀態(tài)管理有多痛苦,有時這是不可避免的。一個狀態(tài)管理的例子大家都很熟悉,那就是單例。使用Swift時,有許多方法實現(xiàn)單例,這是個麻煩事,因為我們不知道哪個最合適。這里我們來回顧一下單例的歷史,看一看在Swift中如何正確地實現(xiàn)單例。

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

圖片-1

往事回憶之ObjC單例

Swift是Objective-C的一種自然演變,它用如下的方式實現(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

在這個現(xiàn)成方案中,我們可以看到單例的基本結(jié)構(gòu)。讓我們來約定一些規(guī)則,這樣便于更好的理解。

單例規(guī)則

關(guān)于單例,有三個重要的準則需要牢記:

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

NSNotificationCenter, UIApplicationNSUserDefaults。

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

  2. 考慮到規(guī)則1,為保證在整個程序的生命周期中值有一個實例被創(chuàng)建,單例必須是線程安全的。并發(fā)有時候確實挺復(fù)雜,簡單說來,如果單例的代碼不正確,如果有兩個線程同時實例化一個單例對象,就可能會創(chuàng)建出兩個單例對象。也就是說,必須保證單例的線程安全性,才可以保證其唯一性。通過調(diào)用dispatch_once,即可保證實例化代碼只運行一次。

在程序中保持單例的唯一性,只初始化一次,這樣并不難。帖子的余下部分中,需要記?。簡卫龑崿F(xiàn)要滿足隱藏的dispatch_once規(guī)則。

Swift單例

自Swift 1.0開始,創(chuàng)建單例有很多種方法。這些鏈接中已經(jīng)有很詳盡的描述,比如

但是誰喜歡點鏈接呢?先劇透一下吧:總共有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
2. 結(jié)構(gòu)體方法(“新瓶裝老酒)
class TheOneAndOnlyKraken {
    class var sharedInstance: TheOneAndOnlyKraken {
        struct Static {
            static let instance = TheOneAndOnlyKraken()
        }
        return Static.instance
    }
}

Swift 1.0時,不支持靜態(tài)類變量,那時這個方法是不得已而為之。但使用結(jié)構(gòu)體,就可以支持這個功能。因為靜態(tài)變量的限制,我們被約束在這樣的一個模型中。這比Objective-C移植版本好一些,但還不夠好。有趣的是,在Swift 1.2發(fā)布幾個月后,我還可以看到這種寫法。在那之后,反而更多了。

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)。這意味著我們終于可以擺脫混亂的全局變量、全局命名空間,也不會發(fā)生命名空間沖突了。這個版本看起來更Swiftier一點。

現(xiàn)在,你可能會有疑問:為何看不到dispatch_once?根據(jù)Apple Swift博客中的說法,以上方法都自動滿足dispatch_once規(guī)則。這里有個帖子可以證明dispatch_once規(guī)則一直在起作用。

“全局變量(還有結(jié)構(gòu)體和枚舉體的靜態(tài)成員)的Lazy初始化方法會在其被訪問的時候調(diào)用一次。類似于調(diào)用dispatch_once以保證其初始化的原子性。這樣就有了一種很酷的'單次調(diào)用'方式:只聲明一個全局變量和私有的初始化方法即可。”--來自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特性的?,F(xiàn)在,我們相信使用全局變量來“懶包裝”單例的初始化方法到dispatch_once代碼塊中是100%安全的。但是對于靜態(tài)類變量來說,情況又如何?

這個問題帶我們到更激動人心的思考中去:

正確的方法(也即是“單行單例法”)現(xiàn)在已經(jīng)被證明正確。

class TheOneAndOnlyKraken {
    static let sharedInstance = TheOneAndOnlyKraken()
}
圖片-3

到此為止,我們已經(jīng)做了許多研究工作。這個帖子的靈感來源于我們在Capital One的一次對話:結(jié)對編程review代碼的過程中,我們試圖找到在App中使用Swift編寫正確、一致的單例方法。我們知道編寫單例的正確方法,但是無法用理論來證明。沒有足夠的文檔支持,想證明方法的正確是徒勞的。在網(wǎng)上或博客圈中沒有足夠多的信息的話,這只能是一家之言,大家都知道如果網(wǎng)上查不到信息,就不會相信。這點讓我很難過。

圖片-4

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

因此我決定將各種單例都寫一變,然后在運行時加入斷點來觀測。

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

來看看截圖:

使用全局單例方法


圖片-5

使用單行單例方法

圖片-6

第一張圖片展示了使用全局實例時的stack trace。標紅的地方需要注意。在調(diào)用Kraken單例之前,先調(diào)用了swift_once,接下來是swift_once_block_invoke。Apple之前在文檔中已經(jīng)說過,“懶實例化”的全局變量會被自動放在dispatch_once塊中,我們可以假定說的就是這個東西。

了解了這些知識,我們來看看漂亮的單行單例方法。如圖所示,調(diào)用完全一樣。這樣,我們就有了證據(jù)證明單行單例方法是正確的。

不要忘記設(shè)置初始化方法為私有

@davedelong,Apple的Framework傳道者,善意地提醒我:必須保證init方法的私有性,只有這樣,才能保證單例是真正唯一的,避免外部對象通過訪問init方法創(chuàng)建單例類的其他實例。由于Swift中的所有對象都是由公共的初始化方法創(chuàng)建的,我們需要重寫自己的init方法,并設(shè)置其為私有的。這很簡單,而且不會破壞到我們優(yōu)雅的單行單例方法。

class TheOneAndOnlyKraken {
    static let sharedInstance = TheOneAndOnlyKraken()
    private init() {} //This prevents others from using the default '()' initializer for this class.
}

這樣做就可以保證編譯器在某個類嘗試使用()來初始化TheOneAndOnlyKraken時,拋出錯誤:

圖片-7

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

結(jié)論

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

CocoaChina 譯文

THE RIGHT WAY TO WRITE A SINGLETON (原文)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,836評論 6 540
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,275評論 3 428
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,904評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,633評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 72,368評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,736評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,740評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,919評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,481評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 41,235評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,427評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,968評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,656評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,055評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,348評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,160評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 48,380評論 2 379

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

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