Name: Singleton для Qt
Item: Singleton для Qt
Author: Автор

Каталог статей

Singleton для Qt

Иногда при разработке приложений возникает потребность в существовании некоего объекта, который должен быть доступен из многих, совершенно разных частей программы. Примером такого объекта может служить общий контейнер внутренней конфигурации программы. Кроме того, ключевой особенностью такого объекта является единственность его существования – к примеру, объект, работающий с определенным COM портом должен существовать в единственном экземпляре.

Таким образом, мы можем выделить две особенности объекта типа Singleton:

Доступность объекта из различных частей программы
Единственность существования

Специально выделяю вторую особенность, дабы подчеркнуть суть такого объекта. Первая особенность – просто «полезность», вытекающая из единственности. На практике, эти две особенности идут рядом, поэтому я не буду разделять их детали реализации.

Да, вопрос об обоснованности существования таких объектов и т.п. – это совсем другая тема и философия проектирования. Но мы сейчас не об этом.

Существует несколько подходов к реализации таких объектов. Я предлагаю один из них, которым пользуюсь уже на протяжении многих лет.

01//--------------------------------------------------------------------------
02// File: a_singleton.h
03//
04// Desc: An one-instance class
05//--------------------------------------------------------------------------
06 
07#ifndef A_SINGLETON_H
08#define A_SINGLETON_H
09 
10#include <QtGlobal>
11 
12// disable the warning regarding 'this' pointers being used in
13// base member initializer list. Singletons rely on this action
14#pragma warning(disable : 4355)
15 
16//--------------------------------------------------------------------------
17// Name: uSingleton
18// Desc: A singleton is a type of class of which only one instance may
19//      exist. This is commonly used for management classes used to
20//      control system-wide resources.
21//--------------------------------------------------------------------------
22template <class T>
23class uSingleton
24{
25public:
26 
27    // the singleton must be constructed with a reference to the controlled object
28    //----------------------------------------------------------------------
29    uSingleton(T& rObject)
30    {
31        Q_ASSERT_X(!s_pInstance, "constructor", "Only one instance of this class is permitted.");
32        s_pInstance = &rObject;
33    }
34 
35    // the singleton accessor
36    //----------------------------------------------------------------------
37    ~uSingleton()
38    {
39        Q_ASSERT_X(s_pInstance, "destructor", "The singleton instance is invalid.");
40        s_pInstance = 0;
41    }
42 
43    // the singleton accessor
44    //----------------------------------------------------------------------
45    static T& instance()
46    {
47        Q_ASSERT_X(s_pInstance, "instancing", "The singleton has not yet been created.");
48        return (*s_pInstance);
49    }
50 
51private:
52    // Data...
53    //----------------------------------------------------------------------
54    static T* s_pInstance;
55 
56    // Nonexistant Functions...
57    //----------------------------------------------------------------------
58    uSingleton(const uSingleton& Src);
59    uSingleton& operator=(const uSingleton& Src);
60 
61};
62template <class T> T* uSingleton<T>::s_pInstance = 0;
63 
64#endif // A_SINGLETON_H

Объявление класса:

01//--------------------------------------------------------------------------
02// File: usingletonuserclass.h
03//--------------------------------------------------------------------------
04 
05#ifndef USINGLETONUSERCLASS_H
06#define USINGLETONUSERCLASS_H
07 
08#include <QObject>
09 
10#include "a_singleton.h"
11 
12// Defines for geting instance
13class MyClass;
14#define MY_CLASS MyClass::instance()
15 
16//--------------------------------------------------------------------------
17// Name: MyClass
18//--------------------------------------------------------------------------
19class MyClass : public QObject, public uSingleton<MyClass>
20{
21    Q_OBJECT
22 
23public:
24    explicit MyClass(QObject* parent = 0);
25 
26    // Test function to show work with singleton
27    void testFunc() {};
28};
29 
30#endif // USINGLETONUSERCLASS_H

Не забудьте инициализировать синглетон в конструкторе:

01//--------------------------------------------------------------------------
02// MyClass singleton constructor
03//--------------------------------------------------------------------------
04MyClass::MyClass(QObject *parent)
05    : QObject(parent), uSingleton<MyClass>(*this)
06{
07    /*
08      ...
09    */
10}