【Qt】Qt插件式开发中非常重要的3个宏——Q_DECLARE_INTERFACE、Q_PLUGIN_METADATA和Q_INTERFACES

前言

在Qt插件式开发中，Q_DECLARE_INTERFACE、Q_PLUGIN_METADATA和Q_INTERFACES这3个宏扮演者非常重要的角色，只要使用了Qt官方的插件式开发框架，就必定会使用到这三个宏。笔者对这3个宏总是混淆、记不清楚，今天就总结下来，方便日后查看。

1. Q_DECLARE_INTERFACE

简介

Q_DECLARE_INTERFACE用于生命一个接口类型，以便插件能够实现这个接口。这个宏会生成用于接口类型可识别和查询的代码。

这里进一步解释3个关键词，便于大家理解（或者以后的我~哈哈哈哈哈，忘的太快）

接口类型：即下文示例中的MyInterface类；
识别：通过IID，即下文中的"com.example.MyInterface"，在插件系统中唯一标识一个接口类型；
查询：通过IID在插件系统中查找和加载一个实现了特定接口的插件。

用法示例：

#include <QtPlugin>

class MyInterface
{
public:
    virtual ~MyInterface() {}
    virtual void myMethod() = 0;
};

// 声明接口类型
QT_BEGIN_NAMESPACE
Q_DECLARE_INTERFACE(MyInterface, "com.example.MyInterface")
QT_END_NAMESPACE

解释

MyInterface是你定义的接口类。
"com.example.MyInterface"是接口的唯一标识符（ID），它通常是一个字符串，可以在不同插件之间唯一标识该接口（即一个接口可以对应多个插件程序）。

Q_DECLARE_INTERFACE宏概述

Q_DECLARE_INTERFACE这个宏主要作用是生成一些必要的代码，以便Qt的插件机制能够识别和查找实现了该接口的插件。

简而言之：此宏用于把唯一标识符与类名接口关联起来。

2. Q_PLUGIN_METADATA

简介

Q_PLUGIN_METADATA用于为插件提供元数据，描述插件的信息，如插件的名称、版本号等。这些元数据帮助QT的插件系统管理插件，并在运行时查找和加载插件。

用法示例

#include <QtPlugin>

Q_PLUGIN_METADATA(IID "com.example.MyPluginInterface" FILE "myplugin.json")

解释

IID "com.example.MyPluginInterface" 是插件所实现的接口的唯一标识符，通常与 Q_DECLARE_INTERFACE 中的标识符一致。
FILE "myplugin.json" 是一个 JSON 文件的路径，该文件包含了插件的元数据，比如插件的描述、版本号等信息，以便 Qt 在加载插件时可以读取这些信息。

3. Q_INTERFACES

Q_INTERFACES用于指定插件实现了哪些接口，从而使运行时的Qt插件系统知晓该插件提供了哪些功能接口，并根据这些接口来调用插件的功能。

用法示例

#include <QtPlugin>

class MyPlugin : public QObject, public MyInterface
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID "com.example.MyPluginInterface")
    Q_INTERFACES(MyInterface)
public:
    void myMethod() override { /* 实现接口方法 */ }
};

解释

Q_INTERFACES(MyInterface)表示这个插件实现了MyInterface接口。这将生成一些额外的代码，以便在运行时能够通过接口ID查找和调用插件的接口方法。

最后简要总结

Q_DECLARE_INTERFACE：用于声明接口类和其唯一标识符；
Q_PLUGIN_METADATA：用于提供插件的元数据包括插件名称和元数据文件（即 JSON 文件）路径；
Q_INTERFACES：用于指定插件实现了哪些接口，确保插件能够提供接口所需的功能（指实现接口的虚函数）。

这3个宏配合使用，可以使 Qt 的插件机制能够正确地识别、加载和使用插件，实现插件的动态扩展和功能模块化。