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 <memory> using namespace std; class csingletonautoptr { private: static auto_ptr<csingletonautoptr> 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<csingletonautoptr>; public: static csingletonautoptr* getinstance(); void test(); };
#p#对应的 singletonautoptr.cpp 如下:
#include "singletonautoptr.h" #include <iostream> //initial static member vars here csingletonautoptr* csingletonautoptr::m_instance = null; auto_ptr<csingletonautoptr> csingletonautoptr::m_auto_ptr; ///////////////////////////////////////// // construction/destruction ///////////////////////////////////////// csingletonautoptr::csingletonautoptr() { cout << "csingletonautoptr::csingletonautoptr()" << endl; //put single object into auto_ptr object m_auto_ptr = auto_ptr<csingletonautoptr>(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 对于写上面的例子已经足够用了。
#p#另外一个思路是,把 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 <string> #include <iostream> 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 指针的方法。