Swift中編寫(xiě)單例的正確方式


在之前的帖子里聊過(guò)狀態(tài)管理有多痛苦,有時(shí)這是不可避免的。一個(gè)狀態(tài)管理的例子大家都很熟悉,那就是單例。使用Swift時(shí),有許多方法實(shí)現(xiàn)單例,這是個(gè)麻煩事,因?yàn)槲覀儾恢滥膫€(gè)最合適。這里我們來(lái)回顧一下單例的歷史,看一看在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)。讓我們來(lái)約定一些規(guī)則,這樣便于更好的理解。

單例規(guī)則

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

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

NSNotificationCenter, UIApplicationNSUserDefaults

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

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

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

Swift單例

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

但是誰(shuí)喜歡點(diǎn)鏈接呢?先劇透一下吧:總共有4個(gè)版本。我們來(lái)清點(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è)月后,我還可以看到這種寫(xiě)法。在那之后,反而更多了。

3. 全局變量方法(“單行單例”方法)
private let sharedKraken = TheOneAndOnlyKraken()
class TheOneAndOnlyKraken {
    class var sharedInstance: TheOneAndOnlyKraken {
        return sharedKraken
    }
}

在Swift 1.2以后,我們有了訪問(wèn)權(quán)限設(shè)置(access control specifiers) 的功能和靜態(tài)類成員(static class members)。這意味著我們終于可以擺脫混亂的全局變量、全局命名空間,也不會(huì)發(fā)生命名空間沖突了。這個(gè)版本看起來(lái)更Swiftier一點(diǎn)。

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

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

這個(gè)問(wèn)題帶我們到更激動(dòng)人心的思考中去:

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

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

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

圖片-4

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

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

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

來(lái)看看截圖:

使用全局單例方法


圖片-5

使用單行單例方法

圖片-6

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

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

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

@davedelong,Apple的Framework傳道者,善意地提醒我:必須保證init方法的私有性,只有這樣,才能保證單例是真正唯一的,避免外部對(duì)象通過(guò)訪問(wèn)init方法創(chuàng)建單例類的其他實(shí)例。由于Swift中的所有對(duì)象都是由公共的初始化方法創(chuàng)建的,我們需要重寫(xiě)自己的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è)類嘗試使用()來(lái)初始化TheOneAndOnlyKraken時(shí),拋出錯(cuò)誤:

圖片-7

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

結(jié)論

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

CocoaChina 譯文

THE RIGHT WAY TO WRITE A SINGLETON (原文)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

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

友情鏈接更多精彩內(nèi)容