C++ 中的Singleton 類的實現

摘要：ANSI C++ 中的 Singleton 實現說難不難，說容易也不容易，很多人寫 ANSI C++ 的 Singleton class 都有錯誤。這篇文章討論怎樣在 ANSI c++ 中寫 Singleton class, 希望對大家有協助。

《設計模式》中把 Singleton 寫成返回指標：

class Singleton{ public: static Singleton* Instance(); protected: Singleton(); private: static Singleton* _instance; };

相應的實現 cpp 檔案是：

Singleton* Singleton::_instance; Singleton* Singleton::Instance(){ if( _instance == 0){ _instance = new Singleton; }; return _instance; }

將建構函式設計成 protected 的目的是防止在 class 外面 new ，有人可能會設計成 private ，如果考慮到有可能會繼承這個類的話，還是將建構函式設計成 protected 比較好，還需要加一個 virtual 解構函式。為了防止別人複製 Singleton 對象：

Singleton* pSingleton = Singleton::Instance(); Singleton s1 = *pSingleton; Singleton s2 = *pSingleton; 需要將拷貝構造(copy constructor)函數變成 private。

但是這裡存在的問題是，什麼時候刪除 Singleton 對象？按照 C++ 的一個基本原則，對象在哪裡建立就在哪裡銷毀，這裡還應該放一個 destroy 方法來刪除 Singleton 對象。如果忘了刪除就比較麻煩。Instance 函數還存在多線程同時訪問的加鎖問題。如果把 Instance 函數開始和結尾放上加鎖和解鎖，整個函數效能會下降很多。這不是一個好的設計。
有一個小小的改動，可以避免忘了刪除 Singleton 對象帶來記憶體泄露的問題。那就是用 std:auto_ptr 來包含 Singleton 對象,定義一個class static member auto_ptr 對象，在析構的靜態 auto_ptr 變數的時候時候自動刪除 Singleton 對象。為了不讓使用者 delete Singleton 對象，需要將解構函式由 public 變成 protected。以下是標頭檔 SingletonAutoPtr.h ：

#include using namespace std; class CSingletonAutoPtr { private: static auto_ptr m_auto_ptr;

static CSingletonAutoPtr* m_instance; protected: CSingletonAutoPtr(); CSingletonAutoPtr(const CSingletonAutoPtr&); virtual ~CSingletonAutoPtr(); //allow auto_ptr to delete, using protected ~CSingletonAutoPtr() friend class auto_ptr; public: static CSingletonAutoPtr* GetInstance(); void Test(); };

對應的 SingletonAutoPtr.cpp 如下：

#include "SingletonAutoPtr.h" #include //initial static member vars here CSingletonAutoPtr* CSingletonAutoPtr::m_instance = NULL; auto_ptr CSingletonAutoPtr::m_auto_ptr; ///////////////////////////////////////// // Construction/Destruction ///////////////////////////////////////// CSingletonAutoPtr::CSingletonAutoPtr() { cout << "CSingletonAutoPtr::CSingletonAutoPtr()" << endl; //put single object into auto_ptr object m_auto_ptr = auto_ptr(this); } CSingletonAutoPtr::~CSingletonAutoPtr() { cout << "CSingletonAutoPtr::~CSingletonAutoPtr()" << endl; } CSingletonAutoPtr* CSingletonAutoPtr::GetInstance() { //begin lock //.... if(m_instance == NULL) m_instance = new CSingletonAutoPtr(); //end lock //... return m_instance;

} void CSingletonAutoPtr::Test() { cout << "CSingletonAutoPtr::Test()" << endl; }

調用方法：

CSingletonAutoPtr* pSingleton = CSingletonAutoPtr::GetInstance(); pSingleton->Test();

寫一個 C++ 中的 Singleton 需要這麼費勁，大大出乎我們的意料。有很多人從未用過 auto_ptr，而且 std:auto_ptr 本身就並不完美，它是基於對象所有權機制的，相比之下，Apache Log4cxx 中有一個 auto_ptr, 是基於對象計數的，更為好用。只是為了用一個好的 auto_ptr 而不得不用 log4cxx , 對於很多項目來說，也不太好。當然了，ANSI C++ 的 STL 中 std:auto_ptr 對於寫上面的例子已經足夠用了。

另外一個思路是，把 GetInstance 函數設計成 static member 可能更好，因為一般來說，Singleton 對象都不大，static member 雖然必須一直佔用記憶體，問題不大。這裡的解構函式必須設成 public 了。以下是標頭檔 SingleStaticObj.h

class CSingletonStaticObj { private: static CSingletonStaticObj m_instance; protected: CSingletonStaticObj(); CSingletonStaticObj(const CSingletonStaticObj&); public: virtual ~CSingletonStaticObj(); //must public static CSingletonStaticObj& GetInstance(); void Test(); }; 對應的 SingleStaticObj.cpp 檔案為： #include "SingletonStaticObj.h" #include #include

using namespace std; CSingletonStaticObj CSingletonStaticObj::m_instance; CSingletonStaticObj::CSingletonStaticObj() { cout << "CSingletonStaticObj::CSingletonStaticObj()" << endl; } CSingletonStaticObj::~CSingletonStaticObj() { cout << "CSingletonStaticObj::~CSingletonStaticObj()" << endl; } CSingletonStaticObj& CSingletonStaticObj::GetInstance() { return m_instance; } void CSingletonStaticObj::Test() { cout << "CSingletonStaticObj::Test()" << endl; }

調用方法：

CSingletonStaticObj& singleton = CSingletonAutoPtr::GetInstance(); singleton.Test();

從代碼量來說，似乎使用 static member ref 更為簡單。我更偏向於用這種方法。

但是，並不是所有情況下面都適合用 static member singleton。比如說，GetInstance 需要動態決定返回不同的 instance 的時候，就不能用。舉例來說，FileSystem::GetInstance, 在 windows 下面運行可能需要返回 new WinFileSystem, Linux/Unix 下面運行可能需要返回 new LinuxFileSystem，這個時候還是需要用上面的 auto_ptr 包含 singleton 指標的方法。