QT 智能指針 QPointer QScopedPointer QSharedPointer QWeakPointer QSharedDataPointer 隱式共享 顯示共享

QPointer

QPointer 是一種受保護的指針,當其引用的對象被銷燬時,它會被自動清除(但是,銷燬引用對象還是必須手動delete)。QPointer所指向的對象必須是QObject或其派生類對象。

當多個指針指向同一個 Object 對象時,引用的對象可能被釋放掉,這時使用 QPointer 就可以安全的測試引用對象是否有效,防止發生指針空懸。

注意:Qt5 之前,QPointer 指向一個 QWidget 對象(或子類對象)時,QPointer 由 QWidget 的析構函數清除,Qt5 之後 由 QObject 的析構函數清除。在析構函數銷燬被跟蹤 QWidget 的子項之前,任何跟蹤 QWidget 的 QPointers 都不會被清除。

QPointer 提供的函數和運算符與普通指針的函數和運算符相同,但算術運算符+、-、 ++ 和 --除外(它們通常僅用於對象數組)。

創建 QPointer 指針,可以使用構造函數、用 T * 賦值或相同類型的其他 QPointer 。QPointer 比較可以使用 == 和 !=,或使用 isNull() 進行測試。可以使用 nullptr 或 *xx->member 取消引用。

QPointer 和普通指針可以混用,QPointer會自動轉換爲指針*。可以把 QPointer 對象傳遞給需要 QWidget * 參數的函數。因此,聲明函數時沒有必要用 QPointer 作爲參數,只需使用普通指針即可。

#include <QCoreApplication>
#include <QTimer>
#include <QDebug>
int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);
    QTimer *timer = new QTimer;
    // QPointer<QTimer> timer = new QTimer;
    delete timer;
    // 不使用QPointer時需要設置timer爲NULL
    // timer=NULL;
    if(timer)
    {
        qInfo()<<"timer is not null";
    }
    else
    {
        qInfo()<<"timer is null";
    }
    return a.exec();
}

不使用QPointer時,輸出“Label is not null”,原因是,delete後未置空,易造成指針懸空。使用 QPointer 時,輸出"timer is null"。
在QPointer中 .是指針的屬性,-> 是對象的屬性。

QScopedPointer

QScopedPointer 類似於 C++ 11 中的 unique_ptr 用於管理動態分配的對象的獨佔所有權,即同一時間只能有一個QScopedPointer指向該對象。

QScopedPointer使用了RAII(資源獲取即初始化)技術,當QScopedPointer被銷燬時,它將自動釋放所管理的對象的內存。QScopedPointer不支持拷貝和賦值操作,這是爲了避免在多個指針之間共享所有權的問題。如果需要在多個指針之間轉移所有權,應該使用QSharedPointer或QWeakPointer。

手動管理堆中分配的對象非常困難而且容易出錯,容易導致內存泄露。QScopedPointer是一個簡化內存管理的工具類,它通過將堆分配的空間賦值給基於棧的內存,通常稱爲RAII(resource acquisition is initialization)。
QScopedPointer保證指向的對象在當前範圍消失時自動刪除。
下面的函數分配了堆內存,使用後手動刪除。

void myFunction(bool useSubClass)
 {
     MyClass *p = useSubClass ? new MyClass() : new MySubClass;
     QIODevice *device = handsOverOwnership();

     if (m_value > 3) {
         delete p;
         delete device;
         return;
     }

     try {
         process(device);
     }
     catch (...) {
         delete p;
         delete device;
         throw;
     }

     delete p;
     delete device;
 }

使用QScopedPointer可以簡化上面的代碼:

void myFunction(bool useSubClass)
 {
     // assuming that MyClass has a virtual destructor
     QScopedPointer<MyClass> p(useSubClass ? new MyClass() : new MySubClass);
     QScopedPointer<QIODevice> device(handsOverOwnership());

     if (m_value > 3)
         return;

     process(device);
 }

編譯器爲QScopedPointer生成的代碼與手動編寫的代碼相同。delete代碼是QScopedPointer的選項之一。QScopedPointer沒有賦值構造函數或賦值操作,以便清楚的表達所有權和生命週期。
C++ 中const修飾的指針也可以使用QScopedPointer來表示。

    const QWidget *const p = new QWidget();
    // 等價於
    const QScopedPointer<const QWidget> p(new QWidget());

    QWidget *const p = new QWidget();
    // 等價於
    const QScopedPointer<QWidget> p(new QWidget());

    const QWidget *p = new QWidget();
    // 等價於
    QScopedPointer<const QWidget> p(new QWidget());

自定義清理處理器:
使用malloc分配的數組指針不能使用delete刪除,QScopedPointer的第二個模板參數可以用於自定義清理處理器。QT提供了以下自定義清理處理器:

  • QScopedPointerDeleter 默認處理器,使用delete刪除指針。
  • QScopedPointerArrayDeleter 使用delete []刪除。用於處理使用new [] 創建的指針。
  • QScopedPointerPodDeleter 使用free()刪除指針。用於處理使用malloc()創建的指針。
  • QScopedPointerDeleteLater 使用deleteLater()刪除指針。用於處理QEventLoop中使用的QObject指針。
    自定義清理處理器中必須提供一個public的靜態函數:public static function void cleanup(T *pointer)
 // QScopedPointer 使用 delete[] 刪除數據
 QScopedPointer<int, QScopedPointerArrayDeleter<int> > arrayPointer(new int[42]);

 // QScopedPointer 使用 free()釋放內存
 QScopedPointer<int, QScopedPointerPodDeleter> podPointer(reinterpret_cast<int *>(malloc(42)));

 // 該 struct 調用 "myCustomDeallocator" 刪除指針
 struct ScopedPointerCustomDeleter
 {
    static inline void cleanup(MyCustomClass *pointer)
    {
        myCustomDeallocator(pointer);
    }
 };

 // QScopedPointer 使用自定義清理處理器:
 QScopedPointer<MyCustomClass, ScopedPointerCustomDeleter> customPointer(new MyCustomClass);

QScopedPointer可以使用前置聲明的類,但是要保證QScopedPointer需要清理的時候前置聲明的類的析構函數可用。否則,編譯器將輸出析構函數不可用的警告。

 class MyPrivateClass; // 前置聲明 MyPrivateClass

class MyClass
{
private:
    QScopedPointer<MyPrivateClass> privatePtr; // QScopedPointer 使用前置聲明類

public:
    MyClass(); // OK
    inline ~MyClass() {} // VIOLATION - 析構函數不能使用inline修飾

private:
    Q_DISABLE_COPY(MyClass) // OK - 設置拷貝構造函數和賦值操作不可用,編譯器不會自動生成構造函數和賦值操作
};

成員函數

QScopedPointer::QScopedPointer(T *p = nullptr)

構造 QScopedPointer 實例,並指向p

QScopedPointer::~QScopedPointer()

銷燬QScopedPointer對象。刪除它指向的對象

T *QScopedPointer::data() const

返回QScopedPointer指向對象的值。QScopedPointer仍然指向該對象

T *QScopedPointer::get() const

與 data()功能相同

bool QScopedPointer::isNull() const

QScopedPointer指向的對象爲nullptr時返回true

void QScopedPointer::reset(T *other = nullptr)

刪除已指向的對象並指向新對象other

QScopedArrayPointer

QScopedArrayPointer 與 QScopedPointer 類似,但是刪除指針時使用的時 delete[] 操作。QScopedArrayPointer 存儲的指針指向動態分配的數組對象。如果我們指向的內存數據是一個數組,這時可以用 QScopedArrayPointer。例如:

 void foo()
 {
     QScopedArrayPointer<int> i(new int[10]);
     i[2] = 42;
     ...
     return; // 此時我們定義的 integer 數組會使用 delete[] 自動刪除
 }

QSharedPointer

QSharedPointer 相當於C++11 標準中的 shared_ptr, 用於管理動態分配的對象的共享所有權,即多個 QSharedPointer 對象可以指向同一個對象,並共享該對象的內存管理。它使用引用計數來追蹤對象的使用情況,當最後一個 QSharedPointer 對象被銷燬時,它將自動刪除它所持有的指針。由於使用了引用計數,QSharedPointer 能夠自動處理指針的生命週期,避免內存泄漏和空懸指針等問題,因此是Qt中最常用的智能指針。

需要注意的是,QSharedPointer只能管理動態分配的對象的內存。如果我們將其用於指向棧對象或全局對象,那麼它就不會自動釋放對象的內存,這可能會導致程序崩潰或內存泄漏。

創建 QSharedPointer 對象可以用普通指針、另一個 QSharedPointer 對象,也可以通過將 QWeakPointer 對象提升爲強引用來創建。

線程安全

QSharedPointer 和 QWeekPointer 是可重入類,如果不進行同步,多個線程無法同時訪問指定的 QSharedPointer 對象或 QWeakPointer 對象。

多個 QSharedPointer 和 QWeekPointer 指向同一個對象的情況下,多個線程可以安全的訪問這些 QSharedPointer 和 QWeekPointer對象。QSharedPointer 採用的引用計數機制是原子操作,不需要手動同步。但是要注意,QSharedPointer 和 QWeekPointer 所指向的對象不一定是線程安全的,需要採用線程安全和重入規則來保證 QSharedPointer 和 QWeekPointer 所指向對象的安全。

其他指針類

Qt還提供了另外兩個指針包裝類: QPointer 和 QSharedDataPointer。它們彼此不兼容,因爲每個都有其非常不同的用例。

QSharedPointer 通過外部引用計數(即放置在對象外部的引用計數器)持有共享指針,指針值在 QSharedPointer 和 QWeekPointer 的所有實例之間共享。但是,指針指向的對象不應被視爲共享的:都是同一個對象。QSharedPointer 不提供detach(隱式共享)或拷貝所引用對象的方法。

QSharedDataPointer 通過基類 QSharedData 內的引用計數持有共享數據的指針(共享數據派生自 QSharedData 類)。QSharedDataPointer 可以根據訪問類型對受保護數據執行detach(隱式共享):如果不是讀訪問,則以原子方式創建一個副本以完成操作。

QExplicitlySharedDataPointer 是 QSharedDataPointer 的一個變量,QSharedDataPointer只有在 QExplicitlySharedDataPointer::detach() 時纔會執行detach。

QScopedPointer 專爲堆內分配、刪除對象設計,它持有指向堆分配對象的指針,並在其析構函數中刪除對象。 QScopedPointer 是輕量級的,它不使用額外的結構或引用計數。

QPointer 用於持有 QObject 派生對象的指針,但是一種弱引用。QWeakPointer 具有相同的功能,但不推薦使用該功能。

可選指針跟蹤
編譯調試時可以開啓 QSharedPointer 的指針跟蹤功能。啓用後,QSharedPointer 會在全局集合中註冊它跟蹤的所有指針。這樣就可以捕獲錯誤(例如:將同一指針分配給兩個 QSharedPointer 對象)。

開啓指針跟蹤功能需要在 include QSharedPointer 前定義宏QT_SHAREDPOINTER_TRACK_POINTERS。

即使沒有啓用指針跟蹤功能進行代碼編譯,使用 QSharedPointer 跟蹤指針也是安全的。如果編譯的代碼沒有開啓指針跟蹤功能,QSharedPointer 會從跟蹤器中刪除指針。

注意,指針跟蹤功能對多重繼承或虛擬繼承有限制(此時兩個不同的指針可以引用同一對象)。在這種情況下,如果指針被強制轉換爲不同的類型並且其值發生更改,則 QSharedPointer 的指針跟蹤機制可能無法檢測到被跟蹤的對象是否爲同一對象。

QWeakPointer

QWeakPointer 是對指針的弱引用,相當於C++11 標準中的 weak_ptr。QWeakPointer 不影響指針引用計數,可以用於驗證指針是否在已另一個上下文中被刪除。QWeakPointer對象的創建只能通過QSharedPointer賦值。QWeakPointer 用於追蹤指針,但並不代表指針本身,它不保證指針對象的有效性,也不提供轉換操作。如果要訪問 QWeakPointer 追蹤的指針,需要向將其提升爲 QSharedPointer 並驗證該對象是否爲 null,若對象不爲 null,則可以使用該指針。QWeakPointer::toStrongRef()用於將 QWeakPointer 轉換爲 QSharedPointer。
QWeakPointer 指向 QSharedPointer 所管理的對象,但不會增加對象的引用計數,也不會影響對象的生命週期。當對象被釋放時,QWeakPointer會自動被置爲空指針,避免了空懸指針的問題。

#include <QSharedPointer>
#include <QWeakPointer>
#include <QDebug>

class MyClass
{
public:
    MyClass(int value) : m_value(value) {
        qDebug() << "MyClass constructor called with value" << m_value;
    }
    ~MyClass() {
        qDebug() << "MyClass destructor called with value" << m_value;
    }
    int getValue() const {
        return m_value;
    }

private:
    int m_value;
};

int main()
{
    QSharedPointer<MyClass> shared(new MyClass(20));
    QWeakPointer<MyClass> weak(shared);

    qDebug() << "Shared pointer value:" << shared->getValue();
    qDebug() << "Weak pointer value:" << weak.data()->getValue();

    shared.clear();
    // 此時,MyClass對象的引用計數爲0,將被自動刪除,而此時 QWeakPointer 對象 weak 也爲null。

    if (weak.isNull()) {
        qDebug() << "Weak pointer is null - object has been deleted"; //執行
    } else {
        qDebug() << "Weak pointer is not null - object still exists";
    }

    return 0;
}

QSharedDataPointer

QSharedDataPointer 用於簡化隱式共享類的實現。QSharedDataPointer 實現了線程安全的引用計數,保證了向可重入類添加 QSharedDataPointers 時不破壞的的可重入性。Qt 中很多類都採用了隱式共享來提升指針的訪問速度和內存使用效率。Qt 的容器類都使用了隱式共享,如 QList 、QVarLengthArray 、QStack 、QQueue、 QSet、 QMap、 QMultiMap、 QHash、 QMultiHash 。
例如,實現 Employee 類的隱式共享,需要以下步驟:

  1. 定義 Employee 類,並聲明一個 QSharedDataPointer 成員變量;
  2. 定義一個 EmployeeData 並繼承 QSharedData,將 Employee 需要的成員變量在 EmployeeData 中進行聲明。
#include <QSharedData>
#include <QString>

// EmployeeData 繼承自 QSharedData,QSharedData爲其提供了一個引用計數器
// EmployeeData 要實現共享必須提供默認的構造函數、拷貝構造函數和析構函數
// 如果要對 Employee 類的使用者隱藏數據,應該把 EmployeeData 類聲明到獨立的 .h 文件中
class EmployeeData : public QSharedData
{
  public:
    EmployeeData() : id(-1) { }
    // 拷貝構造函數
    EmployeeData(const EmployeeData &other)
        : QSharedData(other), id(other.id), name(other.name) { }
    ~EmployeeData() { }

    // 共享數據
    int id;
    QString name;
};

class Employee
{
  public:
    Employee() { d = new EmployeeData; }
    // 該構造函數調用了 setId(id) 和 setName(name), 2次修改共享數據,但是並不會觸發 copy on write
    Employee(int id, const QString &name) {
        d = new EmployeeData;
        setId(id); // 此時 EmployeeData 的引用計數爲 1
        setName(name); // 引用計數爲 1 ,不會 copy 共享數據
    }
    // 這個拷貝構造函數可以不用定義,編譯器會自動生成拷貝構造函數
    // 拷貝構造函數會對成員變量 d 進行賦值,賦值操作 =() 會增加共享數據的引用計數
    Employee(const Employee &other)
          : d (other.d)
    {
    }
    // 修改數據時,操作符 ->() 會自動調用 detach() ,如果共享數據的引用計數大於1,會自動copy一份數據用於修改。
    // 保證一個 Employee 對象對共享數據的修改不會影響其它Employee對象引用的共享數據
    void setId(int id) { d->id = id; }
    void setName(const QString &name) { d->name = name; }

    // 不修改 EmployeeData ,操作符 -> 不會觸發detach()
    int id() const { return d->id; }
    QString name() const { return d->name; }

  private:
    // Employee 只用一個成員變量,其它數據在 EmployeeData 中定義
    QSharedDataPointer<EmployeeData> d;
};

在上面的場景中,Employee 對象拷貝、賦值或作爲參數傳遞時,QSharedDataPointer 自動增加引用計數。Employee 對象刪除或不在當前範圍時, QSharedDataPointer 自動減少引用計數。當引用計數爲 0 時,EmployeeData 對象自動被刪除。當 Employee 的成員函數對成員變量 d 進行修改時,QSharedDataPointer 自動調用 detach() 操作,併爲 Employee 對象拷貝出一份數據,保證 Employee 對象對數據的修改不會影響其它對象。如果 Employee 有多個成員函數都會修改成員變量 d,detach() 會被調用多次,但是隻有首次調用 detach() 時纔會拷貝共享數據,因爲第一次調用 detach() 後成員變量 d 指向新拷貝的數據,它的引用計數爲 1。

隱式共享需要注意的問題:
看下面的代碼,如果 e1 和 e2 都代表 id 爲 1001 的數據,那麼將出現 1001 有 2 個不同 name 的問題,這在數據一致性上可能會有問題。這種問題需要使用顯示共享來解決,即在 Employee 類中聲明爲顯示共享 QExplicitlySharedDataPointer d; 顯示共享不會自動執行 copy on write 操作。

#include "employee.h"

int main()
{
    Employee e1(1001, "Albrecht Durer");
    // e1 和 e2 指向同一個共享數據(1001, "Albrecht Durer")
    Employee e2 = e1;
    // setName 後成員變量 e1 將指向另一個數據(1001, "Hans Holbein")
    e1.setName("Hans Holbein");
}

可以考慮使用宏Q_DECLARE_TYPEINFO()將隱式共享類聲明爲 movable 類型,例如上面的 Employee 類。

隱式共享的 iterator 問題:當使用 iterator 遍歷容器時,不能進行容器拷貝。例如:

QList<int> a, b;
// 構造一個用 0 初始化的 list
a.resize(100000); 

QList<int>::iterator i = a.begin();
// 下面是 iterator i 的錯誤使用方式

b = a;

// 與 STL 容器不同的是,如果此時執行 *i = 4 會發生隱式拷貝

a[0] = 5;
// 此時 a 已經從共享數據中分離出來,雖然 i 是 容器 a 的遍歷器,但實際上是 b 的遍歷器,此時 (*i) == 0

b.clear(); 
// 此時遍歷器 i 已經完全無效了

int j = *i; 
// 此時會出現 i 未定義的情況

// 如果使用的是 STL 的容器類 std::list<T> 不會發生上述情況,此時 (*i) == 5

QExplicitlySharedDataPointer

QExplicitlySharedDataPointer 用於簡化顯式共享類的實現。QExplicitlySharedDataPointer 實現了線程安全的引用計數,保證了向可重入類添加 QSharedDataPointers 時不破壞的的可重入性。
QExplicitlySharedDataPointer 與 QSharedDataPointer 類似,惟一不同的是 QExplicitlySharedDataPointer 的成員函數在出現寫操作時不會自動 copy 共享數據。QExplicitlySharedDataPointer 的 detach() 方法只能手動調用。QExplicitlySharedDataPointers 自動進行引用計數並在引用計數變爲 0 時刪除共享數據。

參考文章:
Qt 智能指針介紹: QSharedPointer、QWeakPointer 、QScopedPointer 、QPointer(附實例)
Qt 中的智能指針
【圖解】Qt中的智能指針
Qt 智能指針學習(7種QT的特有指針)

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章