C#中的Singleton模式
前言
Singleton是二十三個設計模式中比較重要也比較經常使用的模式。但是這個模式雖然簡單,實現起來也會有一些小坑,讓我們一起來看看吧!
實現思路
首先我們看看這個設計模式的UML類圖。
很清晰的可以看到,有三點是需要我們在實現這個模式的時候注意的地方。
- 私有化的構造器
- 全局唯一的靜態實例
- 能夠返回全局唯一靜態實例的靜態方法
其中,私有化構造器是防止外部用戶創建新的實例而靜態方法用於返回全局唯一的靜態實例供用戶使用。原理清楚了,接下來我們看看一些典型的實現方式和其中的暗坑。
實現方法
最簡單的實現方法
最簡單的實現方法自然就是按照UML類圖直接寫一個類,我們看看代碼。
class Program
{
static void Main(string[] args)
{
var single1 = Singleton.Instance;
var single2 = Singleton.Instance;
Console.WriteLine(object.ReferenceEquals(single1, single2));
Console.ReadLine();
}
}
class Singleton
{
private static Singleton _Instance = null;
private Singleton()
{
Console.WriteLine("Created");
}
public static Singleton Instance
{
get
{
if (_Instance == null)
{
_Instance = new Singleton();
}
return _Instance;
}
}
public void DumbMethod()
{
}
}
這段代碼忠實的實現了UML類圖裏面的一切,查看輸出結果,
證實了Singleton確實起了作用,多次調用僅僅產生了一個實例,似乎這麼寫就可以實現這個模式了。但是,真的會那麼簡單嗎?
如果多線程亂入?
現在我們給剛剛的例子加點調料,假設多個對實例的調用,並不是簡單的,彬彬有禮的順序關係,二是以多線程的方式調用,那麼剛剛那種實現方法,還能從容應對嗎?讓我們試試。把Main函數裏面的調用改成這樣。
static void Main(string[] args)
{
int TOTAL = 10000;
Task[] tasks = new Task[TOTAL];
for (int i = 0; i < TOTAL; i++)
{
tasks[i] = Task.Factory.StartNew(() =>
{
Singleton.Instance.DumbMethod();
});
}
Task.WaitAll(tasks);
Console.ReadLine();
}
通過Factory創造出1萬個Task,幾乎同時去請求這個單例,看看輸出。
咦,我們剛剛寫的Singleton模式失效了,這個類被創造了5次(這段代碼運行多次,這個數字不一定相同),一定是多線程搞的鬼,我們剛剛寫的代碼沒有辦法應對多線程,換句話說,是非線程安全的(thread-safe),那有沒有辦法來攻克這個難關呢?
線程安全的單例模式
Lock版本
提到線程安全,很多同學第一反應就是用lock,不錯,lock是個可行的辦法,讓我們試試。添加一個引用類型的對象作為lock對象,修改代碼如下(什麼?你問我為什必須是引用類型的對象而不能是值類型的對象?因為lock的時候,如果對象是值類型,那麼lock僅僅鎖住了它的一個副本,另外一個線程可以暢通無阻的再次lock,這樣lock就失去了阻塞線程的意義)
private static object _SyncObj = new object();
public static Singleton Instance
{
get
{
lock (_SyncObj)
{
if (_Instance == null)
{
_Instance = new Singleton();
}
return _Instance;
}
}
}
運行一下,輸出
只有一個實例創建,證明Lock起作用了,這個模式可行!不過有些不喜歡用Lock的同學可能要問,還有沒有其他辦法呢?答案是有的。
靜態構造器版本
回想一下,C#中的類靜態構造器,只會在這個類第一次被使用的時候調用一次,天然的線程安全,那我們試試不用Lock使用類靜態構造器?修改Singleton類如下:
class Singleton
{
private static Singleton _Instance = null;
private Singleton()
{
Console.WriteLine("Created");
}
static Singleton()
{
_Instance = new Singleton();
}
//private static object _SyncObj = new object();
public static Singleton Instance
{
get { return _Instance; }
}
public void DumbMethod()
{
}
}
去掉了Lock,添加了一個類靜態構造器,試一試。
完美!對於不喜歡用Lock(在這個例子中,實例只會創建一次但是之後的所有線程都要先排隊Lock再進入Critical code進行檢查,效率比較低下)的同學,類靜態構造器提供了一種很好的選擇。
不過俗話說,人心苦不足 , 我們總是追求卓越。這個版本比Lock版本似乎更好一點,那還有沒有更好的版本呢?有的。
Lazy版本
從net 4.0開始,C#開始支持延遲初始化,通過Lazy關鍵字,我們可以聲明某個對象為僅僅當第一次使用的時候,再初始化,如果一直沒有調用,那就不初始化,省去了一部分不必要的開銷,提升了效率。如果你不熟悉Lazy或者想更多了解它,請參考。我們今天關注的重點在於,Lazy也是天生線程安全的,所以我們嘗試用它來實現Singleton模式?修改代碼如下:
class Singleton
{
private static Lazy<Singleton> _Instance = new Lazy<Singleton>(() => new Singleton());
private Singleton()
{
Console.WriteLine("Created");
}
public static Singleton Instance
{
get
{
return _Instance.Value;
}
}
public void DumbMethod()
{
}
}
輸出結果中可以看到,我們達到了想要的效果:
在上面的代碼中,私有變量_Instance現在是被聲明為延遲初始化,這樣不但天然實現了線程安全,同時在沒有調用Instance靜態方法的時候(也即沒有調用_Instance.Value),初始化不會發生,這樣就提高了效率。
總結
Singleton模式很常見,實現起來也很簡單,只是要小心線程安全。以上三種方法都可以實現線程安全的Singleton模式。如果net 版本在4.0之上,建議使用Lazy版本,畢竟對比Lock版本,Lazy版本可以免去實現手動Lock之苦,對比Static版本,又有延遲初始化的性能優勢,何樂而不為呢?