C++完美实现Singleton模式

来源：互联网发布：爱淘宝红包没有了编辑：程序博客网时间：2024/04/29 16:40

Singleton模式是常用的设计模式之一，但是要实现一个真正实用的设计模式却也不是件容易的事情。
1.         标准的实现
class Singleton
{
public:
       static Singleton * Instance()
       {
              if( 0== _instance)
              {
                     _instance = new Singleton;
              }
              return _instance;
       }
protected:
       Singleton(void)
       {
       }
       virtual ~Singleton(void)
       {
       }
       static Singleton* _instance;
};
       这是教科书上使用的方法。看起来没有什么问题，其实包含很多的问题。下面我们一个一个的解决。
2.         自动垃圾回收
上面的程序必须记住在程序结束的时候，释放内存。为了让它自动的释放内存，我们引入auto_ptr改变它。
#include <memory>
#include <iostream>
using namespace std;
class Singleton
{
public:
       static Singleton * Instance()
       {
              if( 0== _instance.get())
              {
                     _instance.reset( new Singleton);
              }
              return _instance.get();
       }
protected:
       Singleton(void)
       {
              cout <<"Create Singleton"<<endl;
       }
       virtual ~Singleton(void)
       {
              cout << "Destroy Singleton"<<endl;
       }
       friend class auto_ptr<Singleton>;
       static auto_ptr<Singleton> _instance;
};
//Singleton.cpp
auto_ptr<Singleton> Singleton::_instance;
3.         增加模板
在我的一个工程中，有多个的Singleton类，对Singleton类，我都要实现上面这一切，这让我觉得烦死了。于是我想到了模板来完成这些重复的工作。
现在我们要添加本文中最吸引人单件实现：
/********************************************************************
    (c) 2003-2005 C2217 Studio
    Module:    Singleton.h
    Author:     Yangjun D.
    Created:    9/3/2005   23:17
    Purpose:    Implement singleton pattern
    History:
*********************************************************************/
#pragma once

#include <memory>
using namespace std;
using namespace C2217::Win32;

namespace C2217
{
namespace Pattern
{
template <class T>
class Singleton
{
public:
       static inline T* instance();

private:
       Singleton(void){}
       ~Singleton(void){}
       Singleton(const Singleton&){}
       Singleton & operator= (const Singleton &){}

       static auto_ptr<T> _instance;
};

template <class T>
auto_ptr<T> Singleton<T>::_instance;

template <class T>
inline T* Singleton<T>::instance()
{
       if( 0== _instance.get())
       {
              _instance.reset ( new T);
       }

       return _instance.get();
}

//Class that will implement the singleton mode,
//must use the macro in it's delare file
#define DECLARE_SINGLETON_CLASS( type ) /
       friend class auto_ptr< type >;/
       friend class Singleton< type >;
}
}

4.         线程安全
上面的程序可以适应单线程的程序。但是如果把它用到多线程的程序就会发生问题。主要的问题在于同时执行_instance.reset ( new T); 就会同时产生两个新的对象，然后马上释放一个，这跟Singleton模式的本意不符。所以，你需要更加安全的版本：
/********************************************************************
    (c) 2003-2005 C2217 Studio
    Module:    Singleton.h
    Author:     Yangjun D.
    Created:    9/3/2005   23:17
    Purpose:    Implement singleton pattern
    History:
*********************************************************************/
#pragma once

#include <memory>
using namespace std;
#include "Interlocked.h"
using namespace C2217::Win32;

namespace C2217
{
namespace Pattern
{
template <class T>
class Singleton
{
public:
       static inline T* instance();

private:
       Singleton(void){}
       ~Singleton(void){}
       Singleton(const Singleton&){}
       Singleton & operator= (const Singleton &){}

       static auto_ptr<T> _instance;
       static CResGuard _rs;
};

template <class T>
auto_ptr<T> Singleton<T>::_instance;

template <class T>
CResGuard Singleton<T>::_rs;

template <class T>
inline T* Singleton<T>::instance()
{
       if( 0 == _instance.get() )
       {
              CResGuard::CGuard gd(_rs);
              if( 0== _instance.get())
              {
                     _instance.reset ( new T);
              }
       }
       return _instance.get();
}

//Class that will implement the singleton mode,
//must use the macro in it's delare file
#define DECLARE_SINGLETON_CLASS( type ) /
       friend class auto_ptr< type >;/
       friend class Singleton< type >;
}
}
       CresGuard 类主要的功能是线程访问同步,代码如下：
/******************************************************************************
Module: Interlocked.h
Notices: Copyright (c) 2000 Jeffrey Richter
******************************************************************************/

#pragma once
///////////////////////////////////////////////////////////////////////////////

// Instances of this class will be accessed by multiple threads. So,
// all members of this class (except the constructor and destructor)
// must be thread-safe.
class CResGuard {
public:
   CResGuard() { m_lGrdCnt = 0; InitializeCriticalSection(&m_cs); }
   ~CResGuard() { DeleteCriticalSection(&m_cs); }

   // IsGuarded is used for debugging
   BOOL IsGuarded() const { return(m_lGrdCnt > 0); }

public:
   class CGuard {
   public:
      CGuard(CResGuard& rg) : m_rg(rg) { m_rg.Guard(); };
      ~CGuard() { m_rg.Unguard(); }

   private:
      CResGuard& m_rg;
   };

private:
   void Guard()   { EnterCriticalSection(&m_cs); m_lGrdCnt++; }
   void Unguard() { m_lGrdCnt--; LeaveCriticalSection(&m_cs); }

   // Guard/Unguard can only be accessed by the nested CGuard class.
   friend class CResGuard::CGuard;

private:
   CRITICAL_SECTION m_cs;
   long m_lGrdCnt;   // # of EnterCriticalSection calls
};

///////////////////////////////////////////////////////////////////////////////
5.         实用方法
比如你有一个需要实现单件模式的类，就应该这样实现：
#pragma once
#include "singleton.h"
using namespace C2217::Pattern;

class ServiceManger
{
public:
       void Run()
       {
       }
private:
       ServiceManger(void)
       {
       }
       virtual ~ServiceManger(void)
       {
       }
       DECLARE_SINGLETON_CLASS(ServiceManger);
};

typedef Singleton<ServiceManger> SSManger;

在使用的时候很简单，跟一般的Singleton实现的方法没有什么不同。
int _tmain(int argc, _TCHAR* argv[])
{
        SSManger::instance()->Run();
}

一个简单的Singleton模式的实现，可以看到C++语言背后隐藏的丰富的语意，我希望有人能实现一个更好的Singleton让大家学习。我从一开始实现Singleton类的过程，其实就是我学习C++的过程，越是深入越觉得C++了不起。

posted on 2005-09-20 22:14 天下无双阅读(530) 评论(9) 编辑收藏收藏至365Key

似乎可以这样：
template <class T>
class Singleton
{
public:
static inline T& instance()
{
static T _instance;
return _instance;
}

private:
Singleton(void);
~Singleton(void);
Singleton(const Singleton<T>&);
Singleton<T>& operator= (const Singleton<T> &);
};
回复

# re: C++完美实现Singleton模式 2005-09-21 08:52 天下无双

Cool!
比我的实现简单很多,并且也达到了同样的效果,不佩服都不行. 回复

# re: C++完美实现Singleton模式 2005-12-22 18:08 小明

mexo 说的实现方式Meyer(Effective c++)提出来的

这种方式并不是没有多线程问题的回复

# 还不够完美 2006-01-09 21:51 NoSound

mexo提出的方案的确不错，但是好象也并不完美（我不是指多线程解决方案），因为他把模板类的构造函数放在私有段里了，如果放在protected段里就好得多，因为你的类可以从模板类继承，这样就不再需要你的那个 typedef Singleton<ServiceManger> SSManger;定义了。示例如下：
template <class T>
class Singleton {
public:
static T& instance() {
static T _instance;
return _instance;
}
protected:
Singleton(void) {}
virtual ~Singleton(void) {}
Singleton(const Singleton<T>&); //不实现
Singleton<T>& operator= (const Singleton<T> &); //不实现
};
--------------------------------
下面是一个需要做为单例的类，只需从Singleton继承即可
class Test : public Singleton<Test> {
public:
void foo();
private:
Test();
~Test();
friend class Singleton<Test>;
};
----------------------
这样，别人在使用的时候，只需要写
Test::instance().foo();
而再也不需要写：
Singleton<Test>::instance().foo();
或者
typedef Singleton<Test> STest;
STest::instance().foo();
-----------------------------
回复

# re: C++完美实现Singleton模式 2006-01-17 16:22 3×7=51

我猜楼主一定没看过Andrei Alexandrescu写的Modern C++ Design 回复

# re: C++完美实现Singleton模式 2006-01-18 09:02 天下无双

我是写些Singleton的实现, 后来有机会看来你说的那本书, 感觉思想差不多,不谋而和。回复

# re: C++完美实现Singleton模式 2006-01-27 11:07 cyt

Singleton在多线程方面，还漏了一篇文章没有看：
《Double-Checked Locking,Threads,Compiler Optimizations,and More》（Scott Meyers）

主要意思就是在：_instance.reset ( new T);
在编译器优化情况下，_instance先设了指针内容，然后再进行构造函数。如果有第二个线程这时候进行访问，_instance内容为非空，于是跳过了第一个if( 0 == _instance.get() )。但实际上对象还是没有构造完整。

实际上我们多是先用
std::auto_ptr<T> _au(new T);
_instance = _au;
回复

# re: C++完美实现Singleton模式 2006-03-23 17:12 cat5

如果已经作了多线程保护，_instance.reset ( new T); 和std::auto_ptr<T> _au(new T);
_instance = _au;
不一样吗？回复

# re: C++完美实现Singleton模式 2006-03-23 18:33 cat5

Sorry，
if( 0 == _instance.get() )
{
CResGuard::CGuard gd(_rs);
if( 0== _instance.get())
{
_instance.reset ( new T);
}
如果把CResGuard::CGuard gd(_rs);放到第一句即可解决，但却带来了效率问题。这就是DCL要解决的内容

# re: C++完美实现Singleton模式 2005-09-21 00:31 mexo