使用Qt编写模块化插件式应用程序

文章来源：http://blog.sina.com.cn/s/blog_4119bd830100taf1.html

一、动态链接库技术概况

动态链接库技术用得很多。事实上，整个Windows就是由一个个动态链接库（DLL）构建起来的，不管是系统内核，或是系统调用的API封装，还
是通用工具（如控制面板、ActiveX插件等），都是一个个动态链接库文件。动态链接库并不是微软独有的技术，它是软件工程发展到一定阶段的必然产物。 在类Unix系统中，这种二进制可执行模块技术不叫动态链接库，而被称为共享对象或共享库，后缀名一般为.so（即Share
Object的简写）。为简便，下文将统称这种动态链接的技术为DLL或共享库。

二、Qt中的动态链接库编程

使用C++面向对象的类编写DLL是要注意很多细节的，主要是二进制（ABI）兼容问题。

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. #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. // extern "C" 生成的导出符号没有任何修饰，方便主程序找到它

5. extern "C"

6. {

7. Q_DECL_EXPORT IAnimal * CreateAnimal();

8. Q_DECL_EXPORT void ReleaseAnimal(IAnimal * animal);

9. }

10. #endif // BILDOG_H

这两个函数的工作很简单，直接创建和释放对象即可。

下面是BilDog.cpp的代码：

1. #include "bildog.h"

2. IAnimal * CreateAnimal()

3. {

4. return new Dog();

5. }

6. void ReleaseAnimal(IAnimal * animal)

7. {

8. delete animal;

9. }

至此，一个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. // strPluginName为插件的名称，可省略后缀

7. void MainDlg::LoadAndAction(QString strPluginName)

8. {

9. // 加载插件dll

10. QLibrary lib(strPluginName);

11. if (lib.load())

12. {

13. // 定义插件中的两个导出函数的原型

14. typedef IAnimal* (*CreateAnimalFunction)();

15. typedef void (*ReleaseAnimalFunction)(IAnimal* animal);

16. // 解析导出函数

17. CreateAnimalFunction createAnimal =

18. (CreateAnimalFunction) lib.resolve("CreateAnimal");

19. ReleaseAnimalFunction releaseAnimal =

20. (ReleaseAnimalFunction) lib.resolve("ReleaseAnimal");

21. if (createAnimal && releaseAnimal)

22. {

23. // 创建Animal对象

24. IAnimal * animal = createAnimal();

25. if (animal)

26. {

27. // 使用插件功能

28. animal->Eat();

29. animal->Sleep();

30. // 插件使用完毕，删除对象

31. releaseAnimal(animal);

32. }

33. }

34. // 卸载插件

35. lib.unload();

36. }

37. }

生成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）

即使同一平台，不同编译器（甚至同一编译器的不同版本）编出来的共享库和程序也可能不能协同工作。