QSharedDataPointer Class

詳細な説明

QSharedDataPointer は、テンプレートパラメータ `T ` によって、QSharedData から派生する共有データクラスの型が指定されるテンプレートクラスです。

QSharedDataPointer<T> を使用すると、独自の暗黙的に共有されるクラスを簡単に作成できます。QSharedDataPointerはスレッドセーフな参照カウントを実装しており、再入可能クラスに QSharedDataPointer を追加しても、そのクラスが再入不可能になることはありません。

暗黙的な共有は、ポインタの速度とメモリ効率をクラスの使いやすさと組み合わせるために、多くの Qt クラスで使用されています。詳細については、「共有クラス」のページを参照してください。

Employee クラスを暗黙的に共有したい場合、手順は次のとおりです。

• Employee クラスを、QSharedDataPointer<EmployeeData> 型のデータメンバーを1つ持つように定義します。
• `QSharedData ` から派生した `EmployeeData ` クラスを定義し、通常なら `Employee ` クラスに含めるはずだったすべてのデータメンバーをこのクラスに含めます。

これを実際に示すために、暗黙的に共有されるEmployee クラスのソースコードを確認します。ヘッダーファイルでは、Employee クラスとEmployeeData クラスの2つのクラスを定義します。

#include <QSharedData>
#include <QSharedDataPointer>
#include <QString>

class EmployeeData : public QSharedData
{
public:
    EmployeeData() : id(-1) {}
    EmployeeData(const EmployeeData &other)
        : QSharedData(other), id(other.id), name(other.name) {}
    ~EmployeeData() = default;

    int id;
    QString name;
};

class Employee
{
public:
    Employee() { d = new EmployeeData; }
    Employee(int id, const QString &name) {
        d = new EmployeeData;
        setId(id);
        setName(name);
    }
    Employee(const Employee &other) = default;
    Employee &operator=(const Employee &other) = default;

    Employee(Employee &&other) = default;
    Employee &operator=(Employee &&other) = default;

    ~Employee() = default;

    void setId(int id) { d->id = id; }
    void setName(const QString &name) { d->name = name; }

    int id() const { return d->id; }
    QString name() const { return d->name; }

private:
    QSharedDataPointer<EmployeeData> d;
};

Employee クラスには、QSharedDataPointer<EmployeeData> 型のd ポインタという単一のデータメンバーがあることに注目してください。従業員データへのすべてのアクセスは、d ポインタの operator->() を経由する必要があります。書き込みアクセスについては、operator->() が自動的にdetach() を呼び出し、共有データオブジェクトの参照カウントが 1 より大きい場合は、その共有データオブジェクトのコピーを作成します。 これにより、あるEmployee オブジェクトへの書き込みが、同じEmployeeData オブジェクトを共有する他のEmployee オブジェクトに影響を与えないことが保証されます。

クラスEmployeeData は、内部で参照カウンタを提供するQSharedData を継承しています。EmployeeData には、デフォルトコンストラクタ、コピーコンストラクタ、およびデストラクタがあります。通常、暗黙的に共有されるクラスのデータクラスでは、これらを単純に実装するだけで十分です。

Employee クラスの 2 つのコンストラクタの実装も簡単です。どちらもEmployeeData の新しいインスタンスを作成し、それをd ポインタに代入します。

Employee() { d = new EmployeeData; }

Employee(int id, const QString &name) {
    d = new EmployeeData;
    setId(id);
    setName(name);
}

なお、Employee クラスには自明なコピーコンストラクタも定義されていますが、このケースでは厳密には必須ではありません。

Employee(const Employee &other) = default;
Employee &operator=(const Employee &other) = default;

Employee(Employee &&other) = default;
Employee &operator=(Employee &&other) = default;

~Employee() = default;

ここでコピーコンストラクタが厳密には必須ではないのは、クラス `EmployeeData ` がクラス `Employee ` と同じファイルに含まれているためです（employee.h ）。ただし、`QSharedData ` のプライベートなサブクラスを、`QSharedDataPointer` を含むパブリッククラスと同じファイルに含めることは一般的ではありません。 通常、QSharedData のプライベートなサブクラスは、パブリックなファイルにはインクルードされない別のファイルに配置することで、ユーザーから隠すのが一般的です。この場合、通常はクラスEmployeeData を、employee.h にはインクルードされない別のファイルに配置します。その代わりに、プライベートなサブクラスEmployeeData をemployee.h 内で次のように事前宣言します：

class EmployeeData;

もしここでそのようにしていた場合、示されているコピーコンストラクタが必要となります。コピーコンストラクタは自明なものであるため、常に含めておくのが無難でしょう。

内部的には、QSharedDataPointerは、Employee オブジェクトがコピー、代入、またはパラメータとして渡されるたびに、参照カウントを自動的にインクリメントします。また、Employee オブジェクトが削除されたり、スコープ外になったりすると、参照カウントをデクリメントします。共有されているEmployeeData オブジェクトは、参照カウントが0になった時点で自動的に削除されます。

Employee の非constメンバー関数において、dポインタが間接参照されるたびに、QSharedDataPointerは自動的にdetach()を呼び出し、関数がデータの独自のコピーに対して操作を行うようにします。

void setId(int id) { d->id = id; }

void setName(const QString &name) { d->name = name; }

なお、dポインタが複数回参照解除されることにより、メンバー関数内でdetach()が複数回呼び出された場合、detach()は、最初の呼び出し時のみ（もし呼び出されるのであれば）共有データのコピーを作成します。これは、detach()の2回目以降の呼び出しでは、参照カウントが再び1になるためです。

ただし、従業員IDと名前を受け取る2つ目のEmployee コンストラクタでは、setId()とsetName()の両方が呼び出されますが、新しく構築されたEmployeeData オブジェクトの参照カウントが1に設定されたばかりであるため、コピーオンライトは発生しません。

Employee のconstメンバ関数において、d ポインタを間接参照しても、detach()は呼び出されません。

int id() const { return d->id; }

QString name() const { return d->name; }

Employee クラスには、コピーコンストラクタや代入演算子を実装する必要はありません。C++ コンパイラが提供するコピーコンストラクタと代入演算子が、必要なメンバーごとの浅いコピーを自動的に行うためです。コピーする必要がある唯一のメンバーはd ポインタであり、これは QSharedDataPointer です。そのoperator=() は、共有されているEmployeeData オブジェクトの参照カウントを単にインクリメントするだけです。

暗黙的共有と明示的共有

暗黙的な共有は、Employee クラスには適していない可能性があります。暗黙的に共有されるEmployee クラスのインスタンスを2つ作成する簡単な例を考えてみましょう。

#include "employee.h"

int main()
{
    Employee e1(1001, "Albrecht Durer");
    Employee e2 = e1;
    e1.setName("Hans Holbein");
}

2人目の従業員 e2 が作成され、e1 がそれに割り当てられた後、e1 とe2 の両方が、従業員番号 1001 のアルブレヒト・デューラーを指すようになります。両方のEmployee オブジェクトは、参照カウントが 2 であるEmployeeData の同じインスタンスを指しています。 その後、e1.setName("Hans Holbein") が呼び出されて従業員の名前が変更されますが、参照カウントが1より大きいため、名前が変更される前にコピー・オン・ライトが実行されます。これにより、e1 とe2 は異なるEmployeeData オブジェクトを指すようになります。名前は異なりますが、どちらもIDは1001となっており、おそらくこれは意図した結果ではないでしょう。 もちろん、本当に2人目の一意な従業員を作成したいのであれば、e1.setId(1002) のままで続けても構いませんが、単に従業員の名前をすべての場所で変更したいだけなら、Employee クラス内で暗黙的な共有の代わりにexplicit sharing を使用することを検討してください。

Employee クラスでdポインタを QExplicitlySharedDataPointer<EmployeeData> として宣言すると、明示的な共有が使用され、コピーオンライト操作は自動的に実行されません（つまり、非const関数ではdetach()は呼び出されません）。 その場合、e1.setName("Hans Holbein") の実行後、従業員の名前は変更されていますが、e1とe2はどちらもEmployeeData の同じインスタンスを参照し続けているため、ID 1001の従業員は1人しか存在しません。

メンバ関数のドキュメントによると、ポインタ dは常に共有データオブジェクトへの内部ポインタを指しています。

Qtコンテナでの使用に向けたパフォーマンスの最適化

上記のEmployee クラスに類似しており、唯一のメンバとしてQSharedDataPointerまたはQExplicitlySharedDataPointer を使用している場合は、Q_DECLARE_TYPEINFO()マクロを使用して、暗黙的に共有されるクラスを移動可能な型としてマークすることを検討すべきです。これにより、Qtのコンテナクラスを使用する際のパフォーマンスとメモリ効率が向上します。