使用Qt編寫模塊化插件式應用程序

動態鏈接庫技術使軟件工程師們獸血沸騰,它使得應用系統(程序)可以以二進制模塊的形式靈活地組建起來。比起源碼級別的模塊化,二進制級別的模塊劃 分使得各模塊更加獨立,各模塊可以分別編譯和鏈接,模塊的升級不會引起其它模塊和主程序的重新編譯,這點對於大系統的構建來說更加實用。另一方面,對於商 業目的明顯的企業,各模塊可以獨立設置訪問權限,開發成員只能訪問自己負責的模塊,其它模塊是不能也不給看到的,這樣減少了整個系統泄漏技術的風險。

一、動態鏈接庫技術概況

動態鏈接庫技術用得很多。事實上,整個Windows就是由一個個動態鏈接庫(DLL)構建起來的,不管是系統內核,或是系統調用的API封裝,還 是通用工具(如控制面板、ActiveX插件等),都是一個個動態鏈接庫文件。動態鏈接庫並不是微軟獨有的技術,它是軟件工程發展到一定階段的必然產物。 在類Unix系統中,這種二進制可執行模塊技術不叫動態鏈接庫,而被稱爲共享對象或共享庫,後綴名一般爲.so(即Share Object的簡寫)。爲簡便,下文將統稱這種動態鏈接的技術爲DLL或共享庫。

其實,DLL文件跟普通的可執行文件差別不大,都是可執行文件嘛,裝載到進程空間後,都是一些機器指令(函數代碼)、內存分配(變量)等。在 Windows中,這些可執行文件被稱作PE/COFF格式文件,在Linux則稱爲ELF文件。從CPU的角度看來,程序中的各個要素,不管是函數還是 變量,它們都是一個個地址,函數是入口地址,變量是訪問地址;而C++的所謂類或對象,最後也被編譯器肢解成了一個個變量和函數代碼(這裏是形象的說法, 嚴謹技術解說請搜索C++對象模型)。DLL的裝載(指導入進程空間,然後執行)方式比可執行文件的裝載稍微複雜,因爲它把模塊鏈接過程推遲到了運行時。 在動態鏈接庫的裝載過程中,首要任務就是解決地址重定向問題。我們知道,DLL裝載到進程空間的位置(基址)是不確定的(動態裝載嘛),即使DLL內部使 用的函數調用和全局變量引用,在裝載時都要重新計算其地址。Windows採用基址重定向(Rebasing)技術解決這一問題,而Linux採用地址無 關代碼(PIC,通過GOT和PLT表實現)技術。這兩種技術各有優缺點。

二、Qt中的動態鏈接庫編程

使用C++面向對象的類編寫DLL是要注意很多細節的,主要是二進制(ABI)兼容問題。COM是一個很成功的例子,只要符合COM的規範,我們就能編寫出很好的DLL來,然而COM是微軟私生的,要想跨平臺,我們還得另找它路。

Qt的跨平臺特性同樣令人(至少是我)獸血沸騰。如果你認爲QT僅僅是一個跨平臺界面庫,那就小看它了。我要說的是,它不但是一個通用的跨平臺的面 向對象的應用程序接口庫(包括GUI、數據庫、網絡、多線程、XML、數據容器和算法等,常用的編輯資源都有封裝,就是說,這些都可以跨平臺,而不僅僅是 界面),更是一種C++語言的擴展,一種編程平臺和應用程序框架。信號和槽的機制簡化了對象之間的通信,比MFC的消息映射直觀多了;界面的佈局管理機制 使開發人員可以很輕鬆地編出優雅的窗體;界面語言翻譯機制也很方便實用;QObject容器管理可以看到Qt在內存管理方面的努力;擴展的foreach 循環結構也向現代語言靠攏……

Qt的跨平臺特性很好,對於本文的主題——動態鏈接庫的支持也很好。QT對各種平臺的動態鏈接庫編程技術都有包裝,QT把這種技術統一命名爲共享庫 (Shared Libraries)。通過使用Qt包裝過的類和宏,可以編寫跨平臺的共享庫和插件——當然,這只是源代碼級別的跨平臺,你不要指望用MSVC編譯出來的 DLL,能集成到ARM平臺的Linux程序上面——這是一個很美很美的理想哦。

QT使用以下兩個宏來實現符號(函數或全局變量/對象)的導出和導入(跨平臺不能用def文件了):

  1. Q_DECL_EXPORT   // 必須添加到符號聲明中(共享庫項目)   
  2. Q_DECL_IMPORT   // 必須添加到符號聲明中(使用共享庫的客戶項目)   

QT使用 QLibrary 類實現共享庫的動態加載,即在運行時決定加載那個DLL程序,插件機制使用。

三、QT共享庫和插件範例

本節通過例子,實現一個共享庫和一個插件。在Windows平臺上開發,使用VS2005編譯,QT庫版本爲4.6.2。

本例了將編寫以下三類項目:

  1. Bil 項目:共享庫項目,輸出Bil.dll和Bil.lib,基礎接口類庫,定義一個公共的接口IAnimal(抽象類),供客戶項目和插件項目使用;
  2. Plugin 類項目:插件類項目,現編寫BilDog和BilPanda兩插件項目,實現IAnimal的功能,供客戶項目加載和測試。兩項目輸出BilDog.dll和BilPanda.dll;
  3. Test 項目:客戶應用程序項目,輸出Test.exe,界面中可以選擇要加載的Animal插件,然後調用Animal的功能函數,完成測試;

1. 編寫共享庫——Bil 項目的實現

該項目定義一個抽象的 IAnimal 類作爲導出接口,供客戶項目和插件項目使用。項目類型爲共享庫,將生成Bil.lib和Bil.dll兩個文件,Bil.lib供Plugin項目和Test 項目引用,而Bil.dll將給Test.exe運行時動態加載。

新建一個頭文件Bil.h,輸入如下代碼:

  1. #ifndef BIL_H   
  2. #define BIL_H   
  3. #include <Qt/qglobal.h>   
  4. // 定義BIL_SHARE,使用者可以不用再處理符號的導入和導出細節   
  5. #ifdef BIL_LIB   
  6. # define BIL_SHARE Q_DECL_EXPORT   
  7. #else   
  8. # define BIL_SHARE Q_DECL_IMPORT   
  9. #endif   
  10. #endif // BIL_H   

你現在可能不知道BIL_SHARE宏有何用處。沒關係,請繼續看下面的IAnimal接口定義代碼: 

  1. #ifndef IANIMAL_H   
  2. #define IANIMAL_H   
  3. #include "Bil.h"   
  4. class  BIL_SHARE IAnimal  
  5. {  
  6. public :  
  7.     IAnimal();  
  8.     virtual  ~IAnimal();  
  9. public :  
  10.     virtual  void  Eat() = 0;  
  11.     virtual  void  Run() = 0;  
  12.     virtual  void  Sleep() = 0;  
  13. };  
  14.   
  15. #endif // IANIMAL_H   

現在知道BIL_SHARE宏的妙用了吧。BIL_SHARE宏會根據項目編譯選項BIL_LIB有沒有定義,自動聲明IAnimal是導出類,還 是導入類。所以,使用BIL_SHARE宏,我們只需要向IAnimal插件的開發者提供同一份IAnimal定義文件(IAnimal.h)即可。

當然,我們得先在Bil項目的編譯選項中定義BIL_LIB宏,使得在Bil項目內,BIL_SHARE就是導出符號的聲明。插件項目就不要定義BIL_LIB了,因爲在Animal插件項目中,IAnimal是導入符號。

編譯選項如何定義宏?如果使用Visual Studio工程文件,依次展開:項目屬性->配置屬性->C/C++->預處理器,在預處理器定義中添加宏BIL_LIB即可;如果是QT工程文件,請在QT工程文件Bil.pro中加入如下定義:

  1. DEFINES += BIL_LIB  

在IAnimal接口中,我們定義了三個純虛函數Eat()、Run()和Sleep(),表示吃、跑和睡眠的動作,這是抽象的,因爲不同的動物有 不同的吃相和睡眠姿態,而世間的動物何止千千萬——無所謂,讓這些具體動物的不同表現交給IAnimal插件的編寫者發揮吧——這就是接口的魅力,加上插 件的思想,整個應用程序就變成開放的,可擴展的了!

繼續編寫IAnimal類的實現文件IAnimal.cpp:

 

  1. #include "IAnimal.h"   
  2. IAnimal::IAnimal()  
  3. {  
  4. }  
  5. IAnimal::~IAnimal()  
  6. {  
  7. }  

雖然只實現了構造和析構函數,並且什麼工作也不做,但這是必要的,我們暫時不要使用內聯的構造和析構函數,否則在插件項目實現IAnimal時可能會出現鏈接錯誤。

好了,我們開始編譯吧,生成整個Bil項目。最終我們得到兩個輸出文件:Bil.lib 和 Bil.dll。

我們向Animal插件開發者提供:

  • 兩個頭文件:Bil.h 和 IAnimal.h
  • 兩個庫文件:Bil.lib 和 Bil.dll

下面的插件類項目和客戶項目就是依賴這些文件實現的,也許你更願意把Bil看作是一個通用的DLL類庫,就像QT或MFC一樣——事實上也是如此,Bil就是這樣一個動態的共享類庫。

2. 編寫Animal插件——BilDog和BilPanda項目的實現

現在,讓我們來實現兩個小插件。BilDog插件很簡單,只是彙報下“我是Dog,我正在啃骨頭”;BilPanda也是如此——這裏僅僅是測試而已,實現的項目中,你可以盡情的發揮——沒錯,是在遵循IAnimal接口的前提下。

創建BilDog項目,把Bil項目輸出的Bil.h、IAnimal.h和Bil.lib加入到工程。

創建Dog類的頭文件Dog.h:

 

  1. #ifndef CLASS_DOG_H   
  2. #define CLASS_DOG_H   
  3. #include "IAnimal.h"   
  4. class  Dog : public  IAnimal  
  5. {  
  6. public :  
  7.     Dog(void );  
  8.     virtual  ~Dog(void );  
  9. public :  
  10.     virtual  void  Eat();  
  11.     virtual  void  Run();  
  12.     virtual  void  Sleep();  
  13. };  
  14. #endif // CLASS_DOG_H   

創建Dog類的實現文件Dog.cpp:

  1. #include <QtGui/QMessageBox>   
  2. #include "Dog.h"   
  3. Dog::Dog(void )  
  4. {  
  5. }  
  6. Dog::~Dog(void )  
  7. {  
  8. }  
  9. void  Dog::Eat()  
  10. {  
  11.     QMessageBox::information(NULL, "Hello""Dog eating ..." );  
  12. }  
  13. void  Dog::Run()  
  14. {  
  15.     QMessageBox::information(NULL, "Hello""Dog running ..." );  
  16. }  
  17. void  Dog::Sleep()  
  18. {  
  19.     QMessageBox::information(NULL, "Hello""Dog sleeping ..." );  
  20. }  

調用QT的QMessageBox::information()函數彈出一個信息提示框。

還有一個非常重要的工作,我們得提供一個能夠創建(釋放)Animal具體對象(這裏是Dog)的接口,並且把這些函數導出,讓主程序(Test.exe)能夠解析這個接口函數,動態創建Animal對象,並訪問其功能。

新建BilDog.h文件,輸入下面的代碼:

  1. #ifndef BILDOG_H   
  2. #define BILDOG_H   
  3. #include "Dog.h"   
  4.   
  5. // extern "C" 生成的導出符號沒有任何修飾,方便主程序找到它   
  6. extern  "C"   
  7. {  
  8.     Q_DECL_EXPORT IAnimal * CreateAnimal();  
  9.     Q_DECL_EXPORT void  ReleaseAnimal(IAnimal * animal);  
  10. }  
  11. #endif // BILDOG_H   

這兩個函數的工作很簡單,直接創建和釋放對象即可。
下面是BilDog.cpp的代碼:

  1. #include "bildog.h"   
  2.   
  3. IAnimal * CreateAnimal()  
  4. {  
  5.     return  new  Dog();  
  6. }  
  7.   
  8. void  ReleaseAnimal(IAnimal * animal)  
  9. {  
  10.     delete  animal;  
  11. }  

至此,一個Animal插件總算完成了。編譯,生成BilDog項目,輸出BilDog.dll插件文件,以供主程序Test.exe動態調用。

BilPanda項目和BilDog項目類似,在這裏就不把代碼貼出來了。以後開發Animal插件(即使是第三方)的過程都是如此。

我們不打算輸出該項目的.lib文件和那些頭文件,因爲我們打算讓主程序在運行時刻根據需要裝載dll插件和調用插件的功能,而不是讓主程序項目在編譯時就指定具體的插件。

3. 編寫客戶程序——Test項目的實現

Test項目是一個測試程序項目,但它的角色是主程序,是能使用Animal插件的客戶程序。

同樣,這個項目用到了Bil共享庫,所以得先把Bil項目的幾個輸出文件導入到Test項目。

我們假設Test主程序是一個對話框,上面有一個編輯框和一個“加載並調用”按鈕,終端用戶在編輯框中輸入Animal插件的文件名(比如 BilDog,後綴名可省略,Qt會根據平臺判斷該查找.dll還是.so),點擊“加載並調用”進行共享庫的加載,並調用動態創建的IAnimal對象 的Eat()函數(當然你可以調用Run()函數或Sleep(),這裏僅僅是一個示例)。

下面的函數將被“加載並調用”按鈕的觸發事件調用:

  1. // ...   
  2. #include <QString>   
  3. #include <QLibrary>   
  4. #include <IAnimal.h>   
  5.   
  6. // ...   
  7.   
  8. // strPluginName爲插件的名稱,可省略後綴   
  9. void  MainDlg::LoadAndAction(QString strPluginName)  
  10. {  
  11.     // 加載插件dll   
  12.     QLibrary lib(strPluginName);  
  13.     if  (lib.load())  
  14.     {  
  15.         // 定義插件中的兩個導出函數的原型   
  16.         typedef  IAnimal* (*CreateAnimalFunction)();  
  17.         typedef  void  (*ReleaseAnimalFunction)(IAnimal* animal);  
  18.   
  19.         // 解析導出函數   
  20.         CreateAnimalFunction createAnimal =   
  21.                 (CreateAnimalFunction) lib.resolve("CreateAnimal" );  
  22.         ReleaseAnimalFunction releaseAnimal =   
  23.                 (ReleaseAnimalFunction) lib.resolve("ReleaseAnimal" );  
  24.   
  25.         if  (createAnimal && releaseAnimal)  
  26.         {  
  27.             // 創建Animal對象   
  28.             IAnimal * animal = createAnimal();  
  29.             if  (animal)  
  30.             {  
  31.                 // 使用插件功能   
  32.                 animal->Eat();  
  33.                 animal->Sleep();  
  34.                 // 插件使用完畢,刪除對象   
  35.                 releaseAnimal(animal);  
  36.             }  
  37.         }  
  38.         // 卸載插件   
  39.         lib.unload();  
  40.     }  
  41. }  

生成Test項目,輸出Test.exe。我們把Test.exe、Bil.dll、BilDog.dll、BilPanda.dll放在同一目 錄,雙擊運行Test.exe,趕快試下效果吧!注意BilDog.dll或BilPanda.dll依賴於基礎接口庫Bil.dll,如果系統找不到 Bil.dll,將不能加載BilDog.dll或BilPanda.dll,所以請把它們放在同一目錄。

四、一些遺憾

DLL的願望是美好的,只要接口一致,用戶可以任意更換模塊。但如果不注意細節,很容易陷入它的泥潭中,這就是傳說中的DLL Hell(DLL地獄)!

引起DLL地獄問題的主要原因有以下幾點:

1. 版本控制不好(主要是接口的版本)

    DLL是共享的,如果某程序更新了一個共享的DLL,其它同樣依賴於該DLL的程序就可能不能正常工作了!

2. 二制兼容問題(ABI)

    即使同一平臺,不同編譯器(甚至同一編譯器的不同版本)編出來的共享庫和程序也可能不能協同工作。

    二制兼容問題對於C++來說尤其嚴重。C++的標準是源代碼級別的,標準中並沒有對如何實現C++作出統一的規定,所以不同的編譯器,對標準C++採用不 同的實現方式。這些差異主要有:對象在內存中的分配(C++)、構造和析構函數的實現(C++)、重載和模板的實現(C++)、虛函數表結構(C++)、 多重繼承和虛基類的實現(C++)、函數調用約定(C)、符號修飾(C/C++)等。此外,不同的運行時庫(CRT、STL等標準庫)也會引起ABI兼容 問題。可以說,如果你在編寫基於類的共享庫,如果接口(指導出類)稍有改變,新的DLL與原程序就可能不協同工作了。

關於二進制兼容問題,大家可以參考KDE官網上的一篇文章《Policies/Binary Compatibility Issues With C++

不過這些都不是大問題,畢竟我們不是編寫像Qt一樣的通用庫。我們引入DLL劃分應用程序的模塊,目的是減小系統開發和後期升級維護的難度,同時方 便項目的管理。如果用戶想自己編寫插件模塊,就得使用我們指定的編譯平臺和類接口。所以我們仍能從DLL技術中得到很大的實惠。

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