Qt編寫DLL

最近突然對dll比較感興趣,開始自己用vs寫了幾個dll測試了一下,後來突然想知道Qt是怎麼實現的。就到網上去找資料,發現一位csdn的博友寫的不錯,就把他的copy過來了,主要是爲了加深映象和方便自己以後複習。不廢話了直接看下面:(建議看原文,原文鏈接:http://blog.csdn.net/ape_neu/article/details/6679246

1: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文件了):
Q_DECL_EXPORT   // 必須添加到符號聲明中(共享庫項目)  
Q_DECL_IMPORT   // 必須添加到符號聲明中(使用共享庫的客戶項目) 
QT使用 QLibrary 類實現共享庫的動態加載,即在運行時決定加載那個DLL程序,插件機制使用。
2、QT共享庫和插件範例
本節通過例子,實現一個共享庫和一個插件。在Windows平臺上開發,使用VS2005編譯,QT庫版本爲4.6.2。
本例了將編寫以下三類項目:
Bil 項目:共享庫項目,輸出Bil.dll和Bil.lib,基礎接口類庫,定義一個公共的接口IAnimal(抽象類),供客戶項目和插件項目使用;
Plugin 類項目:插件類項目,現編寫BilDog和BilPanda兩插件項目,實現IAnimal的功能,供客戶項目加載和測試。兩項目輸出BilDog.dll和BilPanda.dll;
Test 項目:客戶應用程序項目,輸出Test.exe,界面中可以選擇要加載的Animal插件,然後調用Animal的功能函數,完成測試;
1. 編寫共享庫——Bil 項目的實現
該項目定義一個抽象的 IAnimal 類作爲導出接口,供客戶項目和插件項目使用。項目類型爲共享庫,將生成Bil.lib和Bil.dll兩個文件,Bil.lib供Plugin項目和Test 項目引用,而Bil.dll將給Test.exe運行時動態加載。

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

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

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

    1.  
    2. #ifndef IANIMAL_H        
    3. #define IANIMAL_H        
    4. #include "Bil.h"        
    5. class BIL_SHARE IAnimal        
    6. {        
    7. public:        
    8.     IAnimal();        
    9.     virtual ~IAnimal();        
    10. public:        
    11.     virtual void Eat() = 0;        
    12.     virtual void Run() = 0;        
    13.     virtual void Sleep() = 0;        
    14. };        
    15.        
    16. #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    
    2. DEFINES += BIL_LIB 
在IAnimal接口中,我們定義了三個純虛函數Eat()、Run()和Sleep(),表示吃、跑和睡眠的動作,這是抽象的,因爲不同的動物有不同的吃相和睡眠姿態,而世間的動物何止千千萬——無所謂,讓這些具體動物的不同表現交給IAnimal插件的編寫者發揮吧——這就是接口的魅力,加上插件的思想,整個應用程序就變成開放的,可擴展的了!

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

    1. view plaincopy to clipboardprint?  
    2. #include "IAnimal.h"     
    3. IAnimal::IAnimal()     
    4. {     
    5. }     
    6. IAnimal::~IAnimal()     
    7. {     
    8. }     

雖然只實現了構造和析構函數,並且什麼工作也不做,但這是必要的,我們暫時不要使用內聯的構造和析構函數,否則在插件項目實現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.   
    2. #ifndef CLASS_DOG_H     
    3. #define CLASS_DOG_H     
    4. #include "IAnimal.h"     
    5. class Dog : public IAnimal     
    6. {     
    7. public:     
    8.  Dog(void);     
    9.  virtual ~Dog(void);     
    10. public:     
    11.  virtual void Eat();     
    12.  virtual void Run();     
    13.  virtual void Sleep();     
    14. };     
    15. #endif // CLASS_DOG_H     

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

    1.  
    2. #include <QtGui/QMessageBox>        
    3. #include "Dog.h"        
    4. Dog::Dog(void)        
    5. {        
    6. }        
    7. Dog::~Dog(void)        
    8. {        
    9. }        
    10. void Dog::Eat()        
    11. {        
    12.     QMessageBox::information(NULL, "Hello", "Dog eating ...");        
    13. }        
    14. void Dog::Run()        
    15. {        
    16.     QMessageBox::information(NULL, "Hello", "Dog running ...");        
    17. }        
    18. void Dog::Sleep()        
    19. {        
    20.     QMessageBox::information(NULL, "Hello", "Dog sleeping ...");        
    21. }  
調用QT的QMessageBox::information()函數彈出一個信息提示框。
還有一個非常重要的工作,我們得提供一個能夠創建(釋放)Animal具體對象(這裏是Dog)的接口,並且把這些函
數導出,讓主程序(Test.exe)能夠解析這個接口函數,動態創建Animal對象,並訪問其功能。

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

    1. view plaincopy to clipboardprint?  
    2. #ifndef BILDOG_H     
    3. #define BILDOG_H     
    4. #include "Dog.h"     
    5.     
    6. // extern "C" 生成的導出符號沒有任何修飾,方便主程序找到它     
    7. extern "C"    
    8. {     
    9.  Q_DECL_EXPORT IAnimal * CreateAnimal();     
    10.  Q_DECL_EXPORT void ReleaseAnimal(IAnimal * animal);     
    11. }     
    12. #endif // BILDOG_H     
這兩個函數的工作很簡單,直接創建和釋放對象即可。

下面是BilDog.cpp的代碼:

    1. view plaincopy to clipboardprint?  
    2. #include "bildog.h"        
    3. IAnimal * CreateAnimal()        
    4. {        
    5.     return new Dog();        
    6. }        
    7. void ReleaseAnimal(IAnimal * animal)        
    8. {        
    9.     delete animal;        
    10. }      
至此,一個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. // ...        
    3. #include <QString>        
    4. #include <QLibrary>        
    5. #include <IAnimal.h>        
    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.         CreateAnimalFunction createAnimal =         
    20.                 (CreateAnimalFunction) lib.resolve("CreateAnimal");        
    21.         ReleaseAnimalFunction releaseAnimal =         
    22.                 (ReleaseAnimalFunction) lib.resolve("ReleaseAnimal");          
    23.         if (createAnimal && releaseAnimal)        
    24.         {        
    25.             // 創建Animal對象        
    26.             IAnimal * animal = createAnimal();        
    27.             if (animal)        
    28.             {        
    29.                 // 使用插件功能        
    30.                 animal->Eat();        
    31.                 animal->Sleep();        
    32.                 // 插件使用完畢,刪除對象        
    33.                 releaseAnimal(animal);        
    34.             }        
    35.         }        
    36.         // 卸載插件        
    37.         lib.unload();        
    38.     }        
    39. }       
    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技術中得到很大的實惠。

 

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