插件元数据

插件元数据文件是一个 JSON 文件，其中包含加载插件库所需的所有信息，如确定插件是否加载及加载顺序（例如，根据依赖关系）。此外，它还包含关于创建者、用途以及如何找到更多信息等文本描述。该文件必须位于编译插件时包含搜索路径之一，且必须具有 .json 扩展名。JSON 文件将作为元数据编译到插件中，然后由 Qt Creator 在加载插件时读取。

主要键

用于识别您的插件并定义默认加载行为的默认键包括必修键 Name 和 Version，以及可选键 CompatVersion、Experimental、DisabledByDefault、Required 和 Platform。

插件描述键

这些仅用于对插件进行更详细的（用户为中心）描述。所有这些都是可选的。

依赖关系

插件可以依赖其他插件。这些在插件元数据中指定，以确保在其他插件加载之前加载这些插件。

依赖关系使用Dependency键声明，其中包含一个包含必需键Name和Version的JSON对象数组，以及可选键Type。

以下公式说明了依赖信息如何匹配。在公式中，所需的插件名称（如依赖对象中定义的Name）表示为DependencyName，所需的插件版本表示为DependencyVersion。如果给定插件的Name、Version和插件元数据中定义的CompatVersion与依赖关系匹配，则该插件与依赖关系匹配

• 其Name与DependencyName匹配，并且
• CompatVersion <= DependencyVersion <= Version.

例如，一个依赖项

{
    "Name" : "SomeOtherPlugin",
    "Version" : "2.3.0_2"
}

会被一个具有

{
    "Name" : "SomeOtherPlugin",
    "Version" : "3.1.0",
    "CompatVersion" : "2.2.0",
    ...
}

的插件匹配，因为名称匹配，且依赖项标签中给出的版本2.3.0_2位于范围2.2.0和3.1.0内。

依赖对象是一个JSON对象，具有以下键

可选依赖关系

插件可以通过在依赖对象中添加"Type" : "Optional"来指定对另一个插件的依赖关系是可选的

• 如果依赖关系可以解决，那么插件和其依赖关系将被加载并初始化，就像Required依赖关系一样。
• 如果依赖关系无法解决，则插件将被加载并初始化，就像未声明依赖关系一样。

插件没有任何方式得知存在可选依赖项。由于可能有或没有加载依赖项，插件可能也不会链接到依赖项。从可选依赖项访问对象的一种常见方式是通过全局对象池通过ExtensionSystem::PluginManager::getObjectByName() 获取对象，并使用QMetaObject函数调用其上的函数。

测试依赖项

当用户使用-test 命令行参数运行应用程序时，只会加载指定的插件及其依赖项。这样做的目的是通过避免加载不必要的插件来加快测试执行速度。

通过使用"Type" : "Test" 说明依赖项，插件可以指定其运行测试所需但正常执行时不需要的附加依赖项。测试依赖项将强制加载，并且不影响加载顺序。

此类依赖项不是可传递的。

命令行参数

插件可以注册用户在启动应用程序时可以提供的命令行参数。当用户使用-help 命令行参数运行应用程序时，这些命令行参数将与一行描述一起显示，并根据这些信息进行插件管理器的命令行解析和有效性检查。如果插件管理器发现与插件匹配的命令行参数，则将其传递到插件initialize()函数。

命令行参数通过键Arguments定义，其中包含一个参数对象数组。每个单独的参数对象都有必需的键Name，以及可选的键Parameter和Description。

参数对象是一个包含以下键的JSON对象

示例 Test.json

{
    "Name" : "Test",
    "Version" : "1.0.1",
    "CompatVersion" : "1.0.0",
    "Vendor" : "My Company",
    "Copyright" : "(C) 2016 MyCompany",
    "License" : [
        "This is a default license bla",
        "blubbblubb",
        "end of terms"
    ],
    "Category" : "My Company Additions",
    "Description" : [
        "This plugin is just a test.",
        "It demonstrates the great use of the plugin meta data."
    ],
    "Url" : "http://www.mycompany-online.com/products/greatplugin",
    "Arguments" : [
        {
            "Name" : "-variant",
            "Parameter" : "fancy|boring",
            "Description" : "Brings up the fancy or boring user interface"
        }
    ],
    "Dependencies" : [
        { "Name" : "SomeOtherPlugin", "Version" : "2.3.0_2" },
        { "Name" : "EvenOther", "Version" : "1.0.0" }
    ]
}

其他元数据

关于插件版本的注意事项

插件版本的形式为 x.y.z_n，其中，x、y、z 和 n 是非负整数。您无需使用这种完整形式指定版本 - 任何未指定的部分都将隐式设置为0。因此，2.10_2 等于 2.10.0_2，而1 与 1.0.0_0 相同。