背景
ref : https://www.ibm.com/developerworks/cn/linux/guitoolkit/qt/signal-slot/index.html
信號和槽機制是 QT 的核心機制,要精通 QT 編程就必須對信號和槽有所了解。
信號與槽和設計模式中的觀察者模式很類似。當某個事件發生之后,比如,按鈕檢測到自己被點擊了一下,它就會發出一個信號(signal)。這種發出是沒有目的的,類似廣播。如果有對象對這個信號感興趣,它就會事先使用連接(connect)函數,意思是,用自己的一個函數(成為槽(slot))進行注冊以便於處理這個信號。也就是說,當信號發出時,被連接的槽函數會自動被回調。這就類似觀察者模式:當發生了感興趣的事件,某一個操作就會被自動觸發。(這里提一句,Qt 的信號槽使用了額外的處理來實現,並不是 GoF 經典的觀察者模式的實現方式。)
概念
信號和槽是一種高級接口,應用於對象之間的通信,它是 QT 的核心特性,也是 QT 區別於其它工具包的重要地方。信號和槽是 QT 自行定義的一種通信機制,它獨立於標准的 C/C++ 語言。
因此要正確的處理信號和槽,必須借助一個稱為 moc(Meta Object Compiler)的 QT 工具,該工具是一個 C++ 預處理程序,它為高層次的事件處理自動生成所需要的附加代碼。
Qt 不是使用的“標准的” C++ 語言,而是對其進行了一定程度的“擴展”。所以有人會覺得 Qt 的程序編譯速度慢,這主要是因為在 Qt 將源代碼交給標准 C++ 編譯器,如 gcc 之前,需要事先將這些擴展的語法去除掉。完成這一操作的就是 moc。
換句話說,QT 的拓展語法就是由其實現的。
在我們所熟知的很多 GUI 工具包中,窗口小部件 (widget) 都有一個回調函數用於響應它們能觸發的每個動作,這個回調函數通常是一個指向某個函數的指針。但是,在 QT 中信號和槽取代了這些凌亂的函數指針,使得我們編寫這些通信程序更為簡潔明了。信號和槽能攜帶任意數量和任意類型的參數,他們是類型完全安全的,不會像回調函數那樣產生 core dumps。
所有從 QObject 或其子類 ( 例如 Qwidget) 派生的類都能夠包含信號和槽。
- 當對象改變其狀態時,信號就由該對象發射 (emit) 出去,這就是對象所要做的全部事情,它不知道另一端是誰在接收這個信號。這就是真正的信息封裝,它確保對象被當作一個真正的軟件組件來使用。
- 槽(slot)用於接收信號,但它們是普通的對象成員函數。一個槽並不知道是否有任何信號與自己相連接。而且,對象並不了解具體的通信機制。
你可以將很多信號與單個的槽進行連接,也可以將單個的信號與很多的槽進行連接,甚至於將一個信號與另外一個信號相連接也是可能的,這時無論第一個信號什么時候發射,系統都將立刻發射第二個信號。
總之,信號與槽構造了一個強大的部件編程機制。
信號
當某個信號對其客戶或所有者發生的內部狀態發生改變,信號被一個對象發射。只有定義過這個信號的類及其派生類能夠發射這個信號。
當一個信號被發射時,與其相關聯的槽將被立刻執行,就象一個正常的函數調用一樣。信號-槽機制完全獨立於任何 GUI 事件循環。只有當所有的槽返回以后發射函數(emit)才返回。
如果存在多個槽與某個信號相關聯,那么,當這個信號被發射時,這些槽將會一個接一個地執行,但是它們執行的順序將會是隨機的、不確定的,我們不能人為地指定哪個先執行、哪 個后執行。
信號的聲明是在頭文件中進行的,QT 的 signals 關鍵字指出進入了信號聲明區,隨后即可聲明自己的信號。例如,下面定義了三個信號:
signals:
void mySignal();
void mySignal(int x);
void mySignalParam(int x,int y);
在上面的定義中,signals 是 QT 的關鍵字,而非 C/C++ 的。
接下來的一行 void mySignal()
定義了信號 mySignal
,這個信號沒有攜帶參數;
接下來的一行 void mySignal(int x) 定義 了重名信號 mySignal,但是它攜帶一個整形參數,這有點類似於 C++ 中的虛函數。
從形式上講信號的聲明與普通的 C++ 函數是一樣的,但是信號卻沒有函數體定義,另外,信號的返回類型都是 void,不要指望能從信號返回什么有用信息。信號由 moc 自動產生,它們不應該在 .cpp 文件中實現。
槽
槽是普通的 C++ 成員函數,可以被正常調用,它們唯一的特殊性就是很多信號可以與其相關聯。當與其關聯的信號被發射時,這個槽就會被調用。槽可以有參數,但槽的參數不能有缺省值。既然槽是普通的成員函數,因此與其它的函數一樣,它們也有存取權限。槽的存取權限決定了誰能夠與其相關聯。同普通的 C++ 成員函數一樣,槽函數也分為三種類型,即 public slots、private slots 和 protected slots。
public slots:在這個區內聲明的槽意味着任何對象都可將信號與之相連接。這對於組件編程非常有用,你可以創建彼此互不了解的對象,將它們的信號與槽進行連接以便信息能夠正確的傳遞。
protected slots:在這個區內聲明的槽意味着當前類及其子類可以將信號與之相連接。這適用於那些槽,它們是類實現的一部分,但是其界面接口卻面向外部。
private slots:在這個區內聲明的槽意味着只有類自己可以將信號與之相連接。這適用於聯系非常緊密的類。
槽也能夠聲明為虛函數,這也是非常有用的。
槽的聲明也是在頭文件中進行的。例如,下面聲明了三個槽:
public slots:
void mySlot();
void mySlot(int x);
void mySignalParam(int x,int y);
信號與槽的關聯
connect
通過調用 QObject 對象的 connect 函數來將某個對象的信號與另外一個對象的槽函數相關聯,這樣當發射者發射信號時,接收者的槽函數將被調用。該函數的定義如下:
bool QObject::connect ( const QObject * sender, const char * signal,
const QObject * receiver, const char * member ) [static]
這個函數的作用就是將發射者 sender 對象中的信號 signal 與接收者 receiver 中的 member 槽函數聯系起來。當指定信號 signal 時必須使用 QT 的宏 SIGNAL(),當指定槽函數時必須使用宏 SLOT()。如果發射者與接收者屬於同一個對象的話,那么在 connect 調用中接收者參數可以省略。
例如,下面定義了兩個對象:標簽對象 label 和滾動條對象 scroll,並將 valueChanged() 信號與標簽對象的 setNum() 相關聯,另外信號還攜帶了一個整形參數,這樣標簽總是顯示滾動條所處位置的值。
QLabel *label = new QLabel;
QScrollBar *scroll = new QScrollBar;
QObject::connect( scroll, SIGNAL(valueChanged(int)),
label, SLOT(setNum(int)) );
一個信號甚至能夠與另一個信號相關聯,看下面的例子:
class MyWidget : public QWidget
{
public:
MyWidget();
...
signals:
void aSignal();
...
private:
...
QPushButton *aButton;
};
MyWidget::MyWidget()
{
aButton = new QPushButton( this );
connect( aButton, SIGNAL(clicked()), SIGNAL(aSignal()) );
}
在上面的構造函數中,MyWidget 創建了一個私有的按鈕 aButton,按鈕的單擊事件產生的信號 clicked() 與另外一個信號 aSignal() 進行了關聯。
這樣一來,當信號 clicked() 被發射時,信號 aSignal() 也接着被發射。當然,你也可以直接將單擊事件與某個私有的槽函數相關聯,然后在槽中發射 aSignal() 信號,這樣的話似乎有點多余。
disconnect
當信號與槽沒有必要繼續保持關聯時,我們可以使用 disconnect 函數來斷開連接。其定義如下:
bool QObject::disconnect ( const QObject * sender, const char * signal,
const Object * receiver, const char * member ) [static]
這個函數斷開發射者中的信號與接收者中的槽函數之間的關聯。
有三種情況必須使用 disconnect() 函數:
1、斷開與某個對象相關聯的任何對象。這似乎有點不可理解,事實上,當我們在某個對象中定義了一個或者多個信號,這些信號與另外若干個對象中的槽相關聯,如果我們要切斷這些關聯的話,就可以利用這個方法,非常之簡潔。
disconnect( myObject, 0, 0, 0 )
或者
myObject->disconnect()
2、斷開與某個特定信號的任何關聯。
disconnect( myObject, SIGNAL(mySignal()), 0, 0 )
或者
myObject->disconnect( SIGNAL(mySignal()) )
3、斷開兩個對象之間的關聯。
disconnect( myObject, 0, myReceiver, 0 )
或者
myObject->disconnect( myReceiver )
在 disconnect 函數中 0 可以用作一個通配符,分別表示任何信號、任何接收對象、接收對象中的任何槽函數。但是發射者 sender 不能為 0,其它三個參數的值可以等於 0。
元對象工具
元對象編譯器 moc(meta object compiler)對 C++ 文件中的類聲明進行分析並產生用於初始化元對象的 C++ 代碼,元對象包含全部信號和槽的名字以及指向這些函數的指針。
moc 讀 C++ 源文件,如果發現有 Q_OBJECT 宏聲明的類,它就會生成另外一個 C++ 源文件,這個新生成的文件中包含有該類的元對象代碼。例如,假設我們有一個頭文件 mysignal.h,在這個文件中包含有信號或槽的聲明,那么在編譯之前 moc 工具就會根據該文件自動生成一個名為 mysignal.moc.h 的 C++ 源文件並將其提交給編譯器;類似地,對應於 mysignal.cpp 文件 moc 工具將自動生成一個名為 mysignal.moc.cpp 文件提交給編譯器。
元對象代碼是 signal/slot 機制所必須的。用 moc 產生的 C++ 源文件必須與類實現一起進行編譯和連接,或者用 #include 語句將其包含到類的源文件中。moc 並不擴展 #include 或者 #define 宏定義 , 它只是簡單的跳過所遇到的任何預處理指令。
程序樣例
這里給出了一個簡單的樣例程序,程序中定義了三個信號、三個槽函數,然后將信號與槽進行了關聯,每個槽函數只是簡單的彈出一個對話框窗口。
信號和槽函數的聲明一般位於頭文件中,同時在類聲明的開始位置必須加上 Q_OBJECT 語句,這條語句是不可缺少的,它將告訴編譯器在編譯之前必須先應用 moc 工具進行擴展。關鍵字 signals 指出隨后開始信號的聲明,這里 signals 用的是復數形式而非單數,siganls 沒有 public、private、protected 等屬性,這點不同於 slots。另外,signals、slots 關鍵字是 QT 自己定義的,不是 C++ 中的關鍵字。
信號的聲明類似於函數的聲明而非變量的聲明,左邊要有類型,右邊要有括號,如果要向槽中傳遞參數的話,在括號中指定每個形式參數的類型,當然,形式參數的個數可以多於一個。
關鍵字 slots 指出隨后開始槽的聲明,這里 slots 用的也是復數形式。
槽的聲明與普通函數的聲明一樣,可以攜帶零或多個形式參數。既然信號的聲明類似於普通 C++ 函數的聲明,那么,信號也可采用 C++ 中虛函數的形式進行聲明,即同名但參數不同。例如,第一次定義的 void mySignal() 沒有帶參數,而第二次定義的卻帶有參數,從這里我們可以看到 QT 的信號機制是非常靈活的。
信號與槽之間的聯系必須事先用 connect 函數進行指定。如果要斷開二者之間的聯系,可以使用函數 disconnect。
//tsignal.h
...
class TsignalApp:public QMainWindow
{
Q_OBJECT
...
// 信號聲明區
signals:
// 聲明信號 mySignal()
void mySignal();
// 聲明信號 mySignal(int)
void mySignal(int x);
// 聲明信號 mySignalParam(int,int)
void mySignalParam(int x,int y);
// 槽聲明區
public slots:
// 聲明槽函數 mySlot()
void mySlot();
// 聲明槽函數 mySlot(int)
void mySlot(int x);
// 聲明槽函數 mySignalParam (int,int)
void mySignalParam(int x,int y);
}
...
//tsignal.cpp
...
TsignalApp::TsignalApp()
{
...
// 將信號 mySignal() 與槽 mySlot() 相關聯
connect(this,SIGNAL(mySignal()),SLOT(mySlot()));
// 將信號 mySignal(int) 與槽 mySlot(int) 相關聯
connect(this,SIGNAL(mySignal(int)),SLOT(mySlot(int)));
// 將信號 mySignalParam(int,int) 與槽 mySlotParam(int,int) 相關聯
connect(this,SIGNAL(mySignalParam(int,int)),SLOT(mySlotParam(int,int)));
}
// 定義槽函數 mySlot()
void TsignalApp::mySlot()
{
QMessageBox::about(this,"Tsignal", "This is a signal/slot sample without parameter.");
}
// 定義槽函數 mySlot(int)
void TsignalApp::mySlot(int x)
{
QMessageBox::about(this,"Tsignal", "This is a signal/slot sample with one parameter.");
}
// 定義槽函數 mySlotParam(int,int)
void TsignalApp::mySlotParam(int x,int y)
{
char s[256];
sprintf(s,"x:%d y:%d",x,y);
QMessageBox::about(this,"Tsignal", s);
}
void TsignalApp::slotFileNew()
{
// 發射信號 mySignal()
emit mySignal();
// 發射信號 mySignal(int)
emit mySignal(5);
// 發射信號 mySignalParam(5,100)
emit mySignalParam(5,100);
}
應注意的問題
信號與槽機制是比較靈活的,但有些局限性我們必須了解,這樣在實際的使用過程中做到有的放矢,避免產生一些錯誤。下面就介紹一下這方面的情況。
1 .信號與槽的效率是非常高的,但是同真正的回調函數比較起來,由於增加了靈活性,因此在速度上還是有所損失,當然這種損失相對來說是比較小的,通過在一台 i586-133 的機器上測試是 10 微秒(運行 Linux),可見這種機制所提供的簡潔性、靈活性還是值得的。但如果我們要追求高效率的話,比如在實時系統中就要盡可能的少用這種機制。
2 .信號與槽機制與普通函數的調用一樣,如果使用不當的話,在程序執行時也有可能產生死循環。因此,在定義槽函數時一定要注意避免間接形成無限循環,即在槽中再次發射所接收到的同樣信號。例如 , 在前面給出的例子中如果在 mySlot() 槽函數中加上語句 emit mySignal() 即可形成死循環。
3 .如果一個信號與多個槽相聯系的話,那么,當這個信號被發射時,與之相關的槽被激活的順序將是隨機的。
4)宏定義不能用在 signal 和 slot 的參數中。
既然 moc 工具不擴展 #define,因此,在 signals 和 slots 中攜帶參數的宏就不能正確地工作,如果不帶參數是可以的。例如,下面的例子中將帶有參數的宏 SIGNEDNESS(a) 作為信號的參數是不合語法的:
#ifdef ultrix
#define SIGNEDNESS(a) unsigned a
#else
#define SIGNEDNESS(a) a
#endif
class Whatever : public QObject
{
[...]
signals:
void someSignal( SIGNEDNESS(a) );
[...]
};
5)構造函數不能用在 signals 或者 slots 聲明區域內。
的確,將一個構造函數放在 signals 或者 slots 區內有點不可理解,無論如何,不能將它們放在 private slots、protected slots 或者 public slots 區內。下面的用法是不合語法要求的:
class SomeClass : public QObject
{
Q_OBJECT
public slots:
SomeClass( QObject *parent, const char *name )
: QObject( parent, name ) {} // 在槽聲明區內聲明構造函數不合語法
[...]
};
6)函數指針不能作為信號或槽的參數。
例如,下面的例子中將 void (applyFunction)(QList, void*) 作為參數是不合語法的:
class someClass : public QObject
{
Q_OBJECT
[...]
public slots:
void apply(void (*applyFunction)(QList*, void*), char*); // 不合語法
};
你可以采用下面的方法繞過這個限制:
typedef void (*ApplyFunctionType)(QList*, void*);
class someClass : public QObject
{
Q_OBJECT
[...]
public slots:
void apply( ApplyFunctionType, char *);
};
7)信號與槽不能有缺省參數。
既然 signal->slot 綁定是發生在運行時刻,那么,從概念上講使用缺省參數是困難的。下面的用法是不合理的:
class SomeClass : public QObject
{
Q_OBJECT
public slots:
void someSlot(int x=100); // 將 x 的缺省值定義成 100,在槽函數聲明中使用是錯誤的
};
8)信號與槽也不能攜帶模板類參數。
如果將信號、槽聲明為模板類參數的話,即使 moc 工具不報告錯誤,也不可能得到預期的結果。 例如,下面的例子中當信號發射時,槽函數不會被正確調用:
[...]
public slots:
void MyWidget::setLocation (pair<int,int> location);
[...]
public signals:
void MyObject::moved (pair<int,int> location);
但是,你可以使用 typedef 語句來繞過這個限制。如下所示:
typedef pair<int,int> IntPair;
[...]
public slots:
void MyWidget::setLocation (IntPair location);
[...]
public signals:
void MyObject::moved (IntPair location);
這樣使用的話,你就可以得到正確的結果。
9)嵌套的類不能位於信號或槽區域內,也不能有信號或者槽。
例如,下面的例子中,在 class B 中聲明槽 b() 是不合語法的,在信號區內聲明槽 b() 也是不合語法的。
class A
{
Q_OBJECT
public:
class B
{
public slots: // 在嵌套類中聲明槽不合語法
void b();
[....]
};
signals:
class B
{
// 在信號區內聲明嵌套類不合語法
void b();
[....]
}:
};
10)友元聲明不能位於信號或者槽聲明區內。
相反,它們應該在普通 C++ 的 private、protected 或者 public 區內進行聲明。下面的例子是不合語法規范的:
class someClass : public QObject
{
Q_OBJECT
[...]
signals: // 信號定義區
friend class ClassTemplate; // 此處定義不合語法
};
自定義信號槽實例
原文來自:https://www.devbean.net/2012/08/qt-study-road-2-custom-signal-slot/
使用connect()
可以讓我們連接系統提供的信號和槽。但是,Qt 的信號槽機制並不僅僅是使用系統提供的那部分,還會允許我們自己設計自己的信號和槽。這也是 Qt 框架的設計思路之一,用於我們設計解耦的程序。本節將講解如何在自己的程序中自定義信號槽。
信號槽不是 GUI 模塊提供的,而是 Qt 核心特性之一。因此,我們可以在普通的控制台程序使用信號槽。
經典的觀察者模式在講解舉例的時候通常會舉報紙和訂閱者的例子。有一個報紙類Newspaper
,有一個訂閱者類Subscriber
。Subscriber
可以訂閱Newspaper
。這樣,當Newspaper
有了新的內容的時候,Subscriber
可以立即得到通知。在這個例子中,觀察者是Subscriber
,被觀察者是Newspaper
。在經典的實現代碼中,觀察者會將自身注冊到被觀察者的一個容器中(比如subscriber.registerTo(newspaper)
)。被觀察者發生了任何變化的時候,會主動遍歷這個容器,依次通知各個觀察者(newspaper.notifyAllSubscribers()
)。
我們來看這個例程,添加2個頭文件
- newspaper.h
#ifndef NEWSPAPER_H
#define NEWSPAPER_H
#include <QCoreApplication>
#include <QObject>
#include <QDebug>
class Newspaper : public QObject
{
Q_OBJECT
public:
Newspaper(const QString & name) :
m_name(name)
{
}
void send()
{
emit newPaper(m_name);
}
signals:
void newPaper(const QString &name);
private:
QString m_name;
};
#endif // NEWSPAPER_H
- reader.h
#ifndef READER_H
#define READER_H
#include <QCoreApplication>
#include <QObject>
#include <QDebug>
class Reader : public QObject
{
Q_OBJECT
public:
Reader() {}
void receiveNewspaper(const QString & name)
{
qDebug() << "Receives Newspaper: " << name;
}
};
#endif // READER_H
- main.cpp
#include <QCoreApplication>
#include <QObject>
#include <QDebug>
#include "newspaper.h"
#include "reader.h"
int main(int argc, char *argv[])
{
QCoreApplication app(argc, argv);
Newspaper newspaper("Newspaper A");
Reader reader;
QObject::connect(&newspaper, &Newspaper::newPaper,
&reader, &Reader::receiveNewspaper);
newspaper.send();
return app.exec();
}
為了減少文件數量,可以把 newspaper.h 和 reader.h 都放在 main.cpp 的
main()
函數之前嗎?答案是,可以,但是需要有額外的操作。解決方法:我們手動調用 moc 工具處理 main.cpp,並且將 main.cpp 中的
#include "newspaper.h"
改為#include "moc_newspaper.h"
就可以了。不過,這是相當繁瑣的步驟,為了避免這樣修改,我們還是將其放在頭文件中。許多初學者會遇到莫名其妙的錯誤,一加上Q_OBJECT
就出錯,很大一部分是因為沒有注意到這個宏應該放在頭文件中。
解析
QObject 關鍵字
首先看Newspaper
這個類。這個類繼承了QObject
類。只有繼承了QObject
類的類,才具有信號槽的能力。所以,為了使用信號槽,必須繼承QObject
。凡是QObject
類(不管是直接子類還是間接子類),都應該在第一行代碼寫上Q_OBJECT
。不管是不是使用信號槽,都應該添加這個宏。這個宏的展開將為我們的類提供信號槽機制、國際化機制以及 Qt 提供的不基於 C++ RTTI 的反射能力。因此,如果你覺得你的類不需要使用信號槽,就不添加這個宏,就是錯誤的。其它很多操作都會依賴於這個宏。注意,這個宏將由 moc(我們會在后面章節中介紹 moc。這里你可以將其理解為一種預處理器,是比 C++ 預處理器更早執行的預處理器。) 做特殊處理,不僅僅是宏展開這么簡單。moc 會讀取標記了 Q_OBJECT
的頭文件,生成以 moc_
為前綴的文件,比如 newspaper.h
將生成 moc_newspaper.cpp
。你可以到構建目錄查看這個文件,看看到底增加了什么內容。注意,由於 moc 只處理頭文件中的標記了Q_OBJECT
的類聲明,不會處理 cpp 文件中的類似聲明。
signals 關鍵字
Newspaper
類的 public 和 private 代碼塊都比較簡單,只不過它新加了一個 signals。signals 塊所列出的,就是該類的信號。信號就是一個個的函數名,返回值是 void(因為無法獲得信號的返回值,所以也就無需返回任何值),參數是該類需要讓外界知道的數據。信號作為函數名,不需要在 cpp 函數中添加任何實現(我們曾經說過,Qt 程序能夠使用普通的 make 進行編譯。沒有實現的函數名怎么會通過編譯?原因還是在 moc,moc 會幫我們實現信號函數所需要的函數體,所以說,moc 並不是單純的將 Q_OBJECT 展開,而是做了很多額外的操作)。
emit 關鍵字
Newspaper
類的send()
函數比較簡單,只有一個語句emit newPaper(m_name);
。emit 是 Qt 對 C++ 的擴展,是一個關鍵字(其實也是一個宏)。emit 的含義是發出,也就是發出newPaper()
信號。感興趣的接收者會關注這個信號,可能還需要知道是哪份報紙發出的信號?所以,我們將實際的報紙名字m_name
當做參數傳給這個信號。當接收者連接這個信號時,就可以通過槽函數獲得實際值。這樣就完成了數據從發出者到接收者的一個轉移。
slot 槽函數
Reader
類更簡單。因為這個類需要接受信號,所以我們將其繼承了QObject
,並且添加了Q_OBJECT
宏。后面則是默認構造函數和一個普通的成員函數。Qt 5 中,任何成員函數、static 函數、全局函數和 Lambda 表達式都可以作為槽函數
。與信號函數不同,槽函數必須自己完成實現代碼。
槽函數就是普通的成員函數,因此作為成員函數,也會受到 public、private 等訪問控制符的影響。(我們沒有說信號也會受此影響,事實上,如果信號是 private 的,這個信號就不能在類的外面連接,也就沒有任何意義。)
connect
main()
函數中,我們首先創建了Newspaper
和Reader
兩個對象,然后使用QObject::connect()
函數。將信號-槽連接起來。然后我們調用Newspaper
的send()
函數。這個函數只有一個語句:發出信號。
由於我們的連接,當這個信號發出時,自動調用 reader 的槽函數,打印出語句。
自定義信號槽需要注意的事項:
- 發送者和接收者都需要是
QObject
的子類(當然,槽函數是全局函數、Lambda 表達式等無需接收者的時候除外); - 使用 signals 標記信號函數,信號是一個函數聲明,返回 void,不需要實現函數代碼;
- 槽函數是普通的成員函數,作為成員函數,會受到 public、private、protected 的影響;
- 使用 emit 在恰當的位置發送信號;
- 使用
QObject::connect()
函數連接信號和槽。