【QT】QT中插件化开发及其简单使用

bailang_zhizun

已于 2025-05-07 16:56:52 修改

阅读量2w

点赞数 36

分类专栏： QT 文章标签： qt 开发语言

于 2021-12-15 10:14:17 首次发布

本文链接：https://blog.youkuaiyun.com/bailang_zhizun/article/details/121945642

版权

QT 专栏收录该内容

13 篇文章

订阅专栏

在此记录以下QT中插件的开发过程及插件的使用方式，方便以后查阅。

1、插件概述

关于插件的含义可以自行搜索或者问AI。

2、QT插件开发示例

QT的插件开发至少分为两部分：主程序部分和插件程序部分。其中主程序部分定义插件的接口并提供插件的管理器用于管理插件的加载与使用；插件程序部分用于按照主程序中定义的插件接口来定义插件，最终实现插件的功能，并生成供主程序部分调用的插件。

2.1、QT插件主程序开发流程

要想使用插件来扩展应用程序，那么首先在主程序中的步骤如下：

（1）、定义一组用于与插件通信的接口（只有纯虚函数的类）

（2）、使用 Q_DECLARE_INTERFACE() 宏来告诉 Qt 元对象系统有关接口的情况

（3）、在应用程序中使用 QPluginLoader 加载插件

（4）、使用 qobject_cast() 来测试插件是否实现了指定的接口

2.2、QT插件程序开发流程

编写扩展 Qt 应用程序的插件，步骤如下：

（1）、声明一个继承自 QObject 的插件类，在类中定义想要提供的接口

（2）、使用 Q_INTERFACES() 宏来告诉 Qt 元对象系统有关接口的情况

（3）、使用 Q_PLUGIN_METADATA() 宏导出插件

（4）、使用合适的 .pro 文件构建插件

2.3、示例编写

2.3.1、创建主程序工程

新建QT工程，命名为PluginTest：

widget.ui :

定义通信接口：

在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 <QWidget>
#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_H

widget.cpp：

#include "widget.h"
#include "ui_widget.h"
#include <QtWidgets>

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() << __FUNCTION__ << pluginLoader.errorString();
        if (plugin) {
            m_pInterface = qobject_cast<DeclareInterface *>(plugin);
            if (m_pInterface)
                return true;
        }
    }
    return false;
}

void Widget::on_pushButton_clicked()
{
    int a = ui->lineEdit->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。

2.3.2、创建插件程序工程

新建插件项目，并命名为PluginLib：

先选择一个空项目进行添加：

编写插件

主程序中已经声明了插件通信接口，然后开始按照接口来编写插件。首先将主程序中声明通信接口的文件declareinterface.h拷贝到该工程目录下，然后在插件工程PluginLib下创建一个新的类QTPlugin，同时继承于QObject和通信接口类DeclareInterface，如下：

qtplugin.h：

#ifndef QTPLUGIN_H
#define QTPLUGIN_H

#include <QObject>
#include <QtPlugin>
#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