| 【QT】QT中插件化开发及其简单使用 | 您所在的位置：网站首页 › 插件的英文怎么写 › 【QT】QT中插件化开发及其简单使用 |
【QT】QT中插件化开发及其简单使用
|
在此记录以下QT中插件的开发过程及插件的使用方式，方便以后查阅。 目录 1、插件概述 1.1、插件的运行机制 1.2、插件和动态库的差别 1.2.1、插件 1.2.2、动态库 1.3、插件的应用场景 2、QT中的插件 3、QT插件开发示例 3.1、QT插件主程序开发流程 3.2、QT插件程序开发流程 3.3、示例编写 3.3.1、创建主程序工程 3.3.2、创建插件程序工程 3.3.3、使用插件 4、参考文档 1、插件概述来自百度百科的定义： 插件(Plug-in,又称addin、add-in、addon或add-on,又译外挂)是一种遵循一定规范的应用程序接口编写出来的程序。其只能运行在程序规定的系统平台下（可能同时支持多个平台），而不能脱离指定的平台单独运行。因为插件需要调用原纯净系统提供的函数库或者数据。很多软件都有插件，插件有无数种。例如在IE中，安装相关的插件后，WEB浏览器能够直接调用插件程序，用于处理特定类型的文件。 1.1、插件的运行机制应用软件提供使插件能够应用的各项服务，其中包括提供加载方式，使插件可以加载到应用程序和网络传输协议中，从而和插件进行数据交换。插件必须依赖于应用程序才能发挥自身功能，仅靠插件是无法正常运行的。相反地，应用程序并不需要依赖插件就可以运行，这样一来，插件就可以加载到应用程序上并且动态更新而不会对应用程序造成任何改变。 插件定位于开发实现应用软件平台不具备的功能的程序,与主程序之间通过接口联系，就像硬件插卡一样，可以被随时删除，插入和修改，所以结构很灵活，容易修改，方便软件的升级和维护。 简单理解就是：系统可以加载插件，但它不知道任何东西，通过一组定义良好的接口和协议与它们进行通信。 1.2、插件和动态库的差别两者都是用于封装部分功能的实现，并降低模块代码耦合度。但其实插件也是被部署为动态库的形式，但是和传统的动态库还是有一些差别的。 1.2.1、插件插件主要面向接口编程，无需访问 .lib 文件，热插拔、利于团队开发。即使在程序运行时 .dll 不存在，也可以正常启动，只是相应插件的功能无法正常使用而已。 1.2.2、动态库动态库需要访问 .lib 文件，而且在程序运行时必须保证 .dll 存在，否则无法正常启动。 1.3、插件的应用场景一个大型项目的开发离不开插件化，可以让整个框架结构更加清晰和容易理解，比如说一个该项目经常会针对不同客户做功能定制，或者对于软件使用的不同场景，功能有所区别，那这时候插件就变得非常有用了，主工程中包含所有功能模块的调用，但是如果某些功能如果不需要，那最终程序打包只要不把插件的dll打包进去就OK了，程序依然可以正常运行，只是该插件的功能无法使用而已。 这样对于多功能模块的情况下，如果不同版本仅需要其中几项功能，就可以不用像动态链接库那样，全部dll都包含进去，从而也节省了安装包的空间。 2、QT中的插件Qt提供了两种API用于创建插件： （1）、一种是高阶API用于扩展Qt本身的功能：如自定义数据库驱动，图像格式，文本编码，自定义样式等等； （2）、一种低阶API用于扩展Qt应用程序。 支持静态和动态两种方式来调用插件。 3、QT插件开发示例QT的插件开发至少分为两部分：主程序部分和插件程序部分。其中主程序部分定义插件的接口并提供插件的管理器用于管理插件的加载与使用；插件程序部分用于按照主程序中定义的插件接口来定义插件，最终实现插件的功能，并生成供主程序部分调用的插件。 3.1、QT插件主程序开发流程要想使用插件来扩展应用程序，那么首先在主程序中的步骤如下： （1）、定义一组用于与插件通信的接口（只有纯虚函数的类） （2）、使用 Q_DECLARE_INTERFACE() 宏来告诉 Qt 元对象系统有关接口的情况 （3）、在应用程序中使用 QPluginLoader 加载插件 （4）、使用 qobject_cast() 来测试插件是否实现了指定的接口 3.2、QT插件程序开发流程编写扩展 Qt 应用程序的插件，步骤如下： （1）、声明一个继承自 QObject 的插件类，在类中定义想要提供的接口 （2）、使用 Q_INTERFACES() 宏来告诉 Qt 元对象系统有关接口的情况 （3）、使用 Q_PLUGIN_METADATA() 宏导出插件 （4）、使用合适的 .pro 文件构建插件 3.3、示例编写 3.3.1、创建主程序工程新建QT工程，命名为PluginTest：
定义通信接口： 在PluginTest工程中添加一个头文件，用于定义主程序与插件通信的接口（只有纯虚函数的类）： //declareinterface.h #ifndef DECLAREINTERFACE_H #define DECLAREINTERFACE_H //定义接口 class DeclareInterface { public: virtual ~DeclareInterface() {} virtual int add(int a,int b) = 0; }; //一定是唯一的标识符 #define DeclareInterface_iid "Examples.Plugin.DeclareInterface" QT_BEGIN_NAMESPACE Q_DECLARE_INTERFACE(DeclareInterface, DeclareInterface_iid) QT_END_NAMESPACE #endif // DECLAREINTERFACE_H为方便演示，这里只做了非常简单的加法运算，所以创建了一个纯虚函数接口add，这里的DeclareInterface_iid 宏定义字符串一定要是唯一的，然后使用宏Q_DECLARE_INTERFACE来声明该接口。 widget.h: #ifndef WIDGET_H #define WIDGET_H #include #include "declareinterface.h" namespace Ui { class Widget; } class Widget : public QWidget { Q_OBJECT public: explicit Widget(QWidget *parent = 0); ~Widget(); private slots: void on_pushButton_clicked(); private: bool loadPlugin(); //加载插件 DeclareInterface* m_pInterface = nullptr; //获取插件类型 private: Ui::Widget *ui; }; #endif // WIDGET_Hwidget.cpp： #include "widget.h" #include "ui_widget.h" #include Widget::Widget(QWidget *parent) : QWidget(parent), ui(new Ui::Widget) { ui->setupUi(this); if(!loadPlugin()){ QMessageBox::warning(this, "Error", "Could not load the plugin"); } } Widget::~Widget() { delete ui; } bool Widget::loadPlugin(){ QDir pluginsDir(qApp->applicationDirPath()); //pluginsDir："../build-xxx-debug/debug" #if defined(Q_OS_WIN) if (pluginsDir.dirName().toLower() == "debug" || pluginsDir.dirName().toLower() == "release") pluginsDir.cdUp(); //pluginsDir："../build-xxx-debug" pluginsDir.cdUp(); //pluginsDir："../" #elif defined(Q_OS_MAC) if (pluginsDir.dirName() == "MacOS") { pluginsDir.cdUp(); pluginsDir.cdUp(); pluginsDir.cdUp(); } #endif pluginsDir.cd("plugins"); foreach (QString fileName, pluginsDir.entryList(QDir::Files)) { QPluginLoader pluginLoader(pluginsDir.absoluteFilePath(fileName)); QObject *plugin = pluginLoader.instance(); qDebug() text().toInt(); int b = ui->lineEdit_2->text().toInt(); int r = -1; if(m_pInterface){ r = m_pInterface->add(a, b); } ui->lineEdit_3->setText(QString::number(r)); }其中loadPlugin函数用于加载插件。 槽函数on_pushButton_clicked()中演示了如何使用插件中的API。 3.3.2、创建插件程序工程新建插件项目，并命名为PluginLib： 先选择一个空项目进行添加：
编写插件 主程序中已经声明了插件通信接口，然后开始按照接口来编写插件。首先将主程序中声明通信接口的文件declareinterface.h拷贝到该工程目录下，然后在插件工程PluginLib下创建一个新的类QTPlugin，同时继承于QObject和通信接口类DeclareInterface，如下： qtplugin.h： #ifndef QTPLUGIN_H #define QTPLUGIN_H #include #include #include "declareinterface.h" class QTPlugin : public QObject, public DeclareInterface { Q_OBJECT Q_INTERFACES(DeclareInterface) Q_PLUGIN_METADATA(IID DeclareInterface_iid FILE "qtplugin.json") public: explicit QTPlugin(QObject *parent = 0); int add(int a, int b); signals: public slots: }; #endif // QTPLUGIN_H注意，在头文件中一定要用Q_INTERFACES宏来声明接口类。 这里的qtplugin.json是为插件提供插件信息的，并使用Q_PLUGIN_METADATA声明（实例化该对象的）插件的元数据，元数据是插件的一部分。 Q_PLUGIN_METADATA这个宏所在的类必须是默认可构造的。 FILE 是可选的，并指向一个 Json 文件。Json 文件必须位于构建系统指定的包含目录之一中（在本工程中和.pro在同级目录下）。当无法找到指定的文件时，moc 会出现错误。如果不想为插件提供信息，当然不会有任何问题，只需保证 Json 文件为空就行。 qtplugin.cpp： #include "qtplugin.h" QTPlugin::QTPlugin(QObject *parent) : QObject(parent) { } int QTPlugin::add(int a, int b) { return a+b; }修改插件工程pro文件： 按照如下配置修改pro文件 TEMPLATE = lib CONFIG += plugin QT += widgets TARGET = qtplugin DESTDIR = ../plugins # 输出目录 EXAMPLE_FILES = qtplugin.json HEADERS += \ qtplugin.h \ declareinterface.h SOURCES += \ qtplugin.cpp 3.3.3、使用插件直接运行主程序，在界面输入操作数直接进行操作：
程序目录结构如下：
Qt插件化（Plugins）开发扩展应用程序 |
widget.ui :
【本文地址】