目錄

• Plugin Meta Data
  • 主鍵
  • 外掛描述鍵
  • 依賴
    • 可選依賴項
    • 測試依賴項
  • 命令列引數
  • Test.json示例
  • 外掛版本說明

Plugin Meta Data

外掛的元資料檔案是一個JSON檔案，包含載入外掛庫所需的所有資訊，決定要載入哪些外掛，以及載入順序（取決於依賴關係）。此外，它包含外掛的作者，外掛的用途，以及在何處可以找到有關外掛的更多資訊。 編譯外掛時，該檔案必須位於include搜尋路徑中，並且必須具有.json副檔名。 JSON檔案將作為元資料編譯到外掛中，然後在載入外掛時由Qt Creator讀取。

主鍵

主鍵用於標識外掛，定義預設載入行為，包括強制鍵Name和Version，和可選鍵CompatVersion，Experimental，DisabledByDefault，Required和Platform。

外掛描述鍵

這些鍵僅用於更詳細（以使用者為中心）的外掛描述。 所有這些都是可選項。

依賴

一個外掛可以依賴於其他外掛。 這些是在外掛元資料中指定的，以確保將這些其他外掛在此外掛之前被載入。

依賴項通過Dependency鍵進行宣告，鍵由JSON物件陣列組成，包含強制鍵Name和Version，以及可選鍵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() 或ExtensionSystem::PluginManager::getObjectByClassName()從全域性物件池中獲取物件，並在獲取的物件上，呼叫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是非負整數。 您不必以完整格式指定版本 - 任何遺漏的部分都將隱式設定為零。 因此，2.10_2等於2.10.0_2，並且1與1.0.0_0相