使用Qt如何編寫模塊化插件式應用程序
本文介紹的是使用Qt如何編寫模塊化插件式應用程序，對于插件式應用程序的講解，也很詳細，我們廢話不多說，先看內(nèi)容。
動態(tài)鏈接庫技術使軟件工程師們獸血沸騰，它使得應用系統(tǒng)（程序）可以以二進制模塊的形式靈活地組建起來。比起源碼級別的模塊化，二進制級別的模塊劃分使得各模塊更加獨立，各模塊可以分別編譯和鏈接，模塊的升級不會引起其它模塊和主程序的重新編譯，這點對于大系統(tǒng)的構建來說更加實用。另一方面，對于商業(yè)目的明顯的企業(yè)，各模塊可以獨立設置訪問權限，開發(fā)成員只能訪問自己負責的模塊，其它模塊是不能也不給看到的，這樣減少了整個系統(tǒng)泄漏技術的風險。
一、動態(tài)鏈接庫技術概況
動態(tài)鏈接庫技術用得很多。事實上，整個Windows就是由一個個動態(tài)鏈接庫（DLL）構建起來的，不管是系統(tǒng)內(nèi)核，或是系統(tǒng)調(diào)用的API封裝，還是通用工具（如控制面板、ActiveX插件等），都是一個個動態(tài)鏈接庫文件。動態(tài)鏈接庫并不是微軟獨有的技術，它是軟件工程發(fā)展到一定階段的必然產(chǎn)物。在類Unix系統(tǒng)中，這種二進制可執(zhí)行模塊技術不叫動態(tài)鏈接庫，而被稱為共享對象或共享庫，后綴名一般為.so（即Share Object的簡寫）。為簡便，下文將統(tǒng)稱這種動態(tài)鏈接的技術為DLL或共享庫。
其實，DLL文件跟普通的可執(zhí)行文件差別不大，都是可執(zhí)行文件嘛，裝載到進程空間后，都是一些機器指令（函數(shù)代碼）、內(nèi)存分配（變量）等。在Windows中，這些可執(zhí)行文件被稱作PE/COFF格式文件，在Linux則稱為ELF文件。從CPU的角度看來，程序中的各個要素，不管是函數(shù)還是變量，它們都是一個個地址，函數(shù)是入口地址，變量是訪問地址；而C++的所謂類或對象，最后也被編譯器肢解成了一個個變量和函數(shù)代碼（這里是形象的說法，嚴謹技術解說請搜索C++對象模型）。DLL的裝載（指導入進程空間，然后執(zhí)行）方式比可執(zhí)行文件的裝載稍微復雜，因為它把模塊鏈接過程推遲到了運行時。在動態(tài)鏈接庫的裝載過程中，首要任務就是解決地址重定向問題。我們知道，DLL裝載到進程空間的位置（基址）是不確定的（動態(tài)裝載嘛），即使DLL內(nèi)部使用的函數(shù)調(diào)用和全局變量引用，在裝載時都要重新計算其地址。Windows采用基址重定向（Rebasing）技術解決這一問題，而Linux采用地址無關代碼（PIC，通過GOT和PLT表實現(xiàn)）技術。這兩種技術各有優(yōu)缺點。
二、Qt中的動態(tài)鏈接庫編程
使用C++面向對象的類編寫DLL是要注意很多細節(jié)的，主要是二進制（ABI）兼容問題。COM是一個很成功的例子，只要符合COM的規(guī)范，我們就能編寫出很好的DLL來，然而COM是微軟私生的，要想跨平臺，我們還得另找它路。
Qt的跨平臺特性同樣令人（至少是我）獸血沸騰。如果你認為QT僅僅是一個跨平臺界面庫，那就小看它了。我要說的是，它不但是一個通用的跨平臺的面向對象的應用程序接口庫（包括GUI、數(shù)據(jù)庫、網(wǎng)絡、多線程、XML、數(shù)據(jù)容器和算法等，常用的編輯資源都有封裝，就是說，這些都可以跨平臺，而不僅僅是界面），更是一種C++語言的擴展，一種編程平臺和應用程序框架。信號和槽的機制簡化了對象之間的通信，比MFC的消息映射直觀多了；界面的布局管理機制使開發(fā)人員可以很輕松地編出優(yōu)雅的窗體；界面語言翻譯機制也很方便實用；QObject容器管理可以看到Qt在內(nèi)存管理方面的努力；擴展的foreach循環(huán)結構也向現(xiàn)代語言靠攏……
Qt的跨平臺特性很好，對于本文的主題——動態(tài)鏈接庫的支持也很好。QT對各種平臺的動態(tài)鏈接庫編程技術都有包裝，QT把這種技術統(tǒng)一命名為共享庫（Shared Libraries）。通過使用Qt包裝過的類和宏，可以編寫跨平臺的共享庫和插件——當然，這只是源代碼級別的跨平臺，你不要指望用MSVC編譯出來的DLL，能集成到ARM平臺的Linux程序上面——這是一個很美很美的理想哦。
QT使用以下兩個宏來實現(xiàn)符號（函數(shù)或全局變量/對象）的導出和導入（跨平臺不能用def文件了）：
Q_DECL_EXPORT // 必須添加到符號聲明中（共享庫項目）
Q_DECL_IMPORT // 必須添加到符號聲明中（使用共享庫的客戶項目）
Q_DECL_EXPORT // 必須添加到符號聲明中（共享庫項目）
Q_DECL_IMPORT // 必須添加到符號聲明中（使用共享庫的客戶項目）
QT使用 QLibrary 類實現(xiàn)共享庫的動態(tài)加載，即在運行時決定加載那個DLL程序，插件機制使用。
三、QT共享庫和插件范例
本節(jié)通過例子，實現(xiàn)一個共享庫和一個插件。在Windows平臺上開發(fā)，使用VS2005編譯，QT庫版本為4.6.2。
本例了將編寫以下三類項目：
Bil 項目：共享庫項目，輸出Bil.dll和Bil.lib，基礎接口類庫，定義一個公共的接口IAnimal（抽象類），供客戶項目和插件項目使用；
Plugin 類項目：插件類項目，現(xiàn)編寫B(tài)ilDog和BilPanda兩插件項目，實現(xiàn)IAnimal的功能，供客戶項目加載和測試。兩項目輸出BilDog.dll和BilPanda.dll；
Test 項目：客戶應用程序項目，輸出Test.exe，界面中可以選擇要加載的Animal插件，然后調(diào)用Animal的功能函數(shù)，完成測試；
#p#
1. 編寫共享庫——Bil 項目的實現(xiàn)
該項目定義一個抽象的 IAnimal 類作為導出接口，供客戶項目和插件項目使用。項目類型為共享庫，將生成Bil.lib和Bil.dll兩個文件，Bil.lib供Plugin項目和Test 項目引用，而Bil.dll將給Test.exe運行時動態(tài)加載。
新建一個頭文件Bil.h，輸入如下代碼：
- view plaincopy to clipboardprint?
- #ifndef BIL_H
- #define BIL_H
- #include <Qt/qglobal.h>
- // 定義BIL_SHARE，使用者可以不用再處理符號的導入和導出細節(jié)
- #ifdef BIL_LIB
- # define BIL_SHARE Q_DECL_EXPORT
- #else
- # define BIL_SHARE Q_DECL_IMPORT
- #endif
- #endif // BIL_H
- #ifndef BIL_H
- #define BIL_H
- #include <Qt/qglobal.h>
- // 定義BIL_SHARE，使用者可以不用再處理符號的導入和導出細節(jié)
- #ifdef BIL_LIB
- # define BIL_SHARE Q_DECL_EXPORT
- #else
- # define BIL_SHARE Q_DECL_IMPORT
- #endif
- #endif // BIL_H
你現(xiàn)在可能不知道BIL_SHARE宏有何用處。沒關系，請繼續(xù)看下面的IAnimal接口定義代碼：
- view plaincopy to clipboardprint?
- #ifndef IANIMAL_H
- #define IANIMAL_H
- #include "Bil.h"
- class BIL_SHARE IAnimal
- {
- public:
- IAnimal();
- virtual ~IAnimal();
- public:
- virtual void Eat() = 0;
- virtual void Run() = 0;
- virtual void Sleep() = 0;
- };
- #endif // IANIMAL_H
- #ifndef IANIMAL_H
- #define IANIMAL_H
- #include "Bil.h"
- class BIL_SHARE IAnimal
- {
- public:
- IAnimal();
- virtual ~IAnimal();
- public:
- virtual void Eat() = 0;
- virtual void Run() = 0;
- virtual void Sleep() = 0;
- };
- #endif
現(xiàn)在知道BIL_SHARE宏的妙用了吧。BIL_SHARE宏會根據(jù)項目編譯選項BIL_LIB有沒有定義，自動聲明IAnimal是導出類，還是導入類。所以，使用BIL_SHARE宏，我們只需要向IAnimal插件的開發(fā)者提供同一份IAnimal定義文件（IAnimal.h）即可。
當然，我們得先在Bil項目的編譯選項中定義BIL_LIB宏，使得在Bil項目內(nèi)，BIL_SHARE就是導出符號的聲明。插件項目就不要定義BIL_LIB了，因為在Animal插件項目中，IAnimal是導入符號。
編譯選項如何定義宏？如果使用Visual Studio工程文件，依次展開：項目屬性->配置屬性->C/C++->預處理器，在預處理器定義中添加宏BIL_LIB即可；如果是QT工程文件，請在QT工程文件Bil.pro中加入如下定義：
- DEFINES += BIL_LIB
- DEFINES += BIL_LIB
在IAnimal接口中，我們定義了三個純虛函數(shù)Eat()、Run()和Sleep()，表示吃、跑和睡眠的動作，這是抽象的，因為不同的動物有不同的吃相和睡眠姿態(tài)，而世間的動物何止千千萬——無所謂，讓這些具體動物的不同表現(xiàn)交給IAnimal插件的編寫者發(fā)揮吧——這就是接口的魅力，加上插件的思想，整個應用程序就變成開放的，可擴展的了！
#p#
繼續(xù)編寫Anima類的實現(xiàn)文件Anima.cpp：
- view plaincopy to clipboardprint?
- #include "IAnimal.h"
- IAnimal::IAnimal()
- {
- }
- IAnimal::~IAnimal()
- {
- }
- #include "IAnimal.h"
- IAnimal::IAnimal()
- {
- }
- IAnimal::~IAnimal()
- {
- }
雖然只實現(xiàn)了構造和析構函數(shù)，并且什么工作也不做，但這是必要的，我們暫時不要使用內(nèi)聯(lián)的構造和析構函數(shù)，否則在插件項目實現(xiàn)IAnimal時可能會出現(xiàn)鏈接錯誤。
好了，我們開始編譯吧，生成整個Bil項目。最終我們得到兩個輸出文件：Bil.lib 和 Bil.dll。
我們向Animal插件開發(fā)者提供：
兩個頭文件：Bil.h 和 IAnimal.h
兩個庫文件：Bil.lib 和 Bil.dll
下面的插件類項目和客戶項目就是依賴這些文件實現(xiàn)的，也許你更愿意把Bil看作是一個通用的DLL類庫，就像QT或MFC一樣——事實上也是如此，Bil就是這樣一個動態(tài)的共享類庫。
2. 編寫Animal插件——BilDog和BilPanda項目的實現(xiàn)
現(xiàn)在，讓我們來實現(xiàn)兩個小插件。BilDog插件很簡單，只是匯報下“我是Dog，我正在啃骨頭”；BilPanda也是如此——這里僅僅是測試而已，實現(xiàn)的項目中，你可以盡情的發(fā)揮——沒錯，是在遵循IAnimal接口的前提下。
創(chuàng)建BilDog項目，把Bil項目輸出的Bil.h、IAnimal.h和Bil.lib加入到工程。
創(chuàng)建Dog類的頭文件Dog.h：
- view plaincopy to clipboardprint?
- #ifndef CLASS_DOG_H
- #define CLASS_DOG_H
- #include "IAnimal.h"
- class Dog : public IAnimal
- {
- public:
- Dog(void);
- virtual ~Dog(void);
- public:
- virtual void Eat();
- virtual void Run();
- virtual void Sleep();
- };
- #endif // CLASS_DOG_H
- #ifndef CLASS_DOG_H
- #define CLASS_DOG_H
- #include "IAnimal.h"
- class Dog : public IAnimal
- {
- public:
- Dog(void);
- virtual ~Dog(void);
- public:
- virtual void Eat();
- virtual void Run();
- virtual void Sleep();
- };
- #endif
創(chuàng)建Dog類的實現(xiàn)文件Dog.cpp：
- view plaincopy to clipboardprint?
- #include <QtGui/QMessageBox>
- #include "Dog.h"
- Dog::Dog(void)
- {
- }
- Dog::~Dog(void)
- {
- }
- void Dog::Eat()
- {
- QMessageBox::information(NULL, "Hello", "Dog eating ...");
- }
- void Dog::Run()
- {
- QMessageBox::information(NULL, "Hello", "Dog running ...");
- }
- void Dog::Sleep()
- {
- QMessageBox::information(NULL, "Hello", "Dog sleeping ...");
- }
- #include <QtGui/QMessageBox>
- #include "Dog.h"
- Dog::Dog(void)
- {
- }
- Dog::~Dog(void)
- {
- }
- void Dog::Eat()
- {
- QMessageBox::information(NULL, "Hello", "Dog eating ...");
- }
- void Dog::Run()
- {
- QMessageBox::information(NULL, "Hello", "Dog running ...");
- }
- void Dog::Sleep()
- {
- QMessageBox::information(NULL, "Hello", "Dog sleeping ...");
- }
調(diào)用QT的QMessageBox::information()函數(shù)彈出一個信息提示框。
還有一個非常重要的工作，我們得提供一個能夠創(chuàng)建（釋放）Animal具體對象（這里是Dog）的接口，并且把這些函數(shù)導出，讓主程序（Test.exe）能夠解析這個接口函數(shù)，動態(tài)創(chuàng)建Animal對象，并訪問其功能。
#p#
新建BilDog.h文件，輸入下面的代碼：
- view plaincopy to clipboardprint?
- #ifndef BILDOG_H
- #define BILDOG_H
- #include "Dog.h"
- // extern "C" 生成的導出符號沒有任何修飾，方便主程序找到它
- extern "C"
- {
- Q_DECL_EXPORT IAnimal * CreateAnimal();
- Q_DECL_EXPORT void ReleaseAnimal(IAnimal * animal);
- }
- #endif // BILDOG_H
- #ifndef BILDOG_H
- #define BILDOG_H
- #include "Dog.h"
- // extern "C" 生成的導出符號沒有任何修飾，方便主程序找到它
- extern "C"
- {
- Q_DECL_EXPORT IAnimal * CreateAnimal();
- Q_DECL_EXPORT void ReleaseAnimal(IAnimal * animal);
- }
- #endif
這兩個函數(shù)的工作很簡單，直接創(chuàng)建和釋放對象即可。
下面是BilDog.cpp的代碼：
- view plaincopy to clipboardprint?
- #include "bildog.h"
- IAnimal * CreateAnimal()
- {
- return new Dog();
- }
- void ReleaseAnimal(IAnimal * animal)
- {
- delete animal;
- }
- #include "bildog.h"
- IAnimal * CreateAnimal()
- {
- return new Dog();
- }
- void ReleaseAnimal(IAnimal * animal)
- {
- delete animal;
- }
至此，一個Animal插件總算完成了。編譯，生成BilDog項目，輸出BilDog.dll插件文件，以供主程序Test.exe動態(tài)調(diào)用。
BilPanda項目和BilDog項目類似，在這里就不把代碼貼出來了。以后開發(fā)Animal插件（即使是第三方）的過程都是如此。
我們不打算輸出該項目的.lib文件和那些頭文件，因為我們打算讓主程序在運行時刻根據(jù)需要裝載dll插件和調(diào)用插件的功能，而不是讓主程序項目在編譯時就指定具體的插件。
3. 編寫客戶程序——Test項目的實現(xiàn)
Test項目是一個測試程序項目，但它的角色是主程序，是能使用Animal插件的客戶程序。
同樣，這個項目用到了Bil共享庫，所以得先把Bil項目的幾個輸出文件導入到Test項目。
我們假設Test主程序是一個對話框，上面有一個編輯框和一個“加載并調(diào)用”按鈕，終端用戶在編輯框中輸入Animal插件的文件名（比如BilDog，后綴名可省略，Qt會根據(jù)平臺判斷該查找.dll還是.so），點擊“加載并調(diào)用”進行共享庫的加載，并調(diào)用動態(tài)創(chuàng)建的IAnimal對象的Eat()函數(shù)（當然你可以調(diào)用Run()函數(shù)或Sleep()，這里僅僅是一個示例）。
下面的函數(shù)將被“加載并調(diào)用”按鈕的觸發(fā)事件調(diào)用：
- view plaincopy to clipboardprint?
- // ...
- #include <QString>
- #include <QLibrary>
- #include <IAnimal.h>
- // ...
- // strPluginName為插件的名稱，可省略后綴
- void MainDlg::LoadAndAction(QString strPluginName)
- {
- // 加載插件dll
- QLibrary lib(strPluginName);
- if (lib.load())
- {
- // 定義插件中的兩個導出函數(shù)的原型
- typedef IAnimal* (*CreateAnimalFunction)();
- typedef void (*ReleaseAnimalFunction)(IAnimal* animal);
- // 解析導出函數(shù)
- CreateAnimalFunction createAnimal =
- (CreateAnimalFunction) lib.resolve("CreateAnimal");
- ReleaseAnimalFunction releaseAnimal =
- (ReleaseAnimalFunction) lib.resolve("ReleaseAnimal");
- if (createAnimal && releaseAnimal)
- {
- // 創(chuàng)建Animal對象
- IAnimal * animal = createAnimal();
- if (animal)
- {
- // 使用插件功能
- animal->Eat();
- animal->Sleep();
- // 插件使用完畢，刪除對象
- releaseAnimal(animal);
- }
- }
- // 卸載插件
- lib.unload();
- }
- }
- // ...
- // ...
- #include <QString>
- #include <QLibrary>
- #include <IAnimal.h>
- // ...
- // strPluginName為插件的名稱，可省略后綴
- void MainDlg::LoadAndAction(QString strPluginName)
- {
- // 加載插件dll
- QLibrary lib(strPluginName);
- if (lib.load())
- {
- // 定義插件中的兩個導出函數(shù)的原型
- typedef IAnimal* (*CreateAnimalFunction)();
- typedef void (*ReleaseAnimalFunction)(IAnimal* animal);
- // 解析導出函數(shù)
- CreateAnimalFunction createAnimal =
- (CreateAnimalFunction) lib.resolve("CreateAnimal");
- ReleaseAnimalFunction releaseAnimal =
- (ReleaseAnimalFunction) lib.resolve("ReleaseAnimal");
- if (createAnimal && releaseAnimal)
- {
- // 創(chuàng)建Animal對象
- IAnimal * animal = createAnimal();
- if (animal)
- {
- // 使用插件功能
- animal->Eat();
- animal->Sleep();
- // 插件使用完畢，刪除對象
- releaseAnimal(animal);
- }
- }
- // 卸載插件
- lib.unload();
- }
- }
- // ...
生成Test項目，輸出Test.exe。我們把Test.exe、Bil.dll、BilDog.dll、BilPanda.dll放在同一目錄，雙擊運行Test.exe，趕快試下效果吧！注意BilDog.dll或BilPanda.dll依賴于基礎接口庫Bil.dll，如果系統(tǒng)找不到Bil.dll，將不能加載BilDog.dll或BilPanda.dll，所以請把它們放在同一目錄。
四、一些遺憾
DLL的愿望是美好的，只要接口一致，用戶可以任意更換模塊。但如果不注意細節(jié)，很容易陷入它的泥潭中，這就是傳說中的DLL Hell（DLL地獄）！
引起DLL地獄問題的主要原因有以下幾點：
1. 版本控制不好（主要是接口的版本）
DLL是共享的，如果某程序更新了一個共享的DLL，其它同樣依賴于該DLL的程序就可能不能正常工作了！
2. 二制兼容問題（ABI）
即使同一平臺，不同編譯器（甚至同一編譯器的不同版本）編出來的共享庫和程序也可能不能協(xié)同工作。
二制兼容問題對于C++來說尤其嚴重。C++的標準是源代碼級別的，標準中并沒有對如何實現(xiàn)C++作出統(tǒng)一的規(guī)定，所以不同的編譯器，對標準C++采用不同的實現(xiàn)方式。這些差異主要有：對象在內(nèi)存中的分配（C++）、構造和析構函數(shù)的實現(xiàn)（C++）、重載和模板的實現(xiàn)（C++）、虛函數(shù)表結構（C++）、多重繼承和虛基類的實現(xiàn)（C++）、函數(shù)調(diào)用約定（C）、符號修飾（C/C++）等。此外，不同的運行時庫（CRT、STL等標準庫）也會引起ABI兼容問題?？梢哉f，如果你在編寫基于類的共享庫，如果接口（指導出類）稍有改變，新的DLL與原程序就可能不協(xié)同工作了。
關于二進制兼容問題，大家可以參考KDE官網(wǎng)上的一篇文章《Policies/Binary Compatibility Issues With C++ 》
不過這些都不是大問題，畢竟我們不是編寫像Qt一樣的通用庫。我們引入DLL劃分應用程序的模塊，目的是減小系統(tǒng)開發(fā)和后期升級維護的難度，同時方便項目的管理。如果用戶想自己編寫插件模塊，就得使用我們指定的編譯平臺和類接口。所以我們?nèi)阅軓腄LL技術中得到很大的實惠。
