Plugin Meta Data
- 主鍵
- 插件描述鍵
- 依賴
  - 可選依賴項
  - 測驗依賴項
- 命令列引數
- Test.json示例
- 插件版本說明

Plugin Meta Data

插件的元資料檔案是一個JSON檔案，包含加載插件庫所需的所有資訊，決定要加載哪些插件，以及加載順序（取決于依賴關系），此外，它包含插件的作者，插件的用途，以及在何處可以找到有關插件的更多資訊，編譯插件時，該檔案必須位于include搜索路徑中，并且必須具有.json擴展名， JSON檔案將作為元資料編譯到插件中，然后在加載插件時由Qt Creator讀取，

主鍵

主鍵用于標識插件，定義默認加載行為，包括強制鍵Name和Version，和可選鍵CompatVersion，Experimental，DisabledByDefault，Required和Platform，

鍵	值型別	含義
Name	String	用作插件的識別符號，例如在其他插件的依賴項中進行參考，
Version	String	x.y.z_n形式的版本字串，用于標識插件，另請參閱本章的"插件版本說明"小節，
CompatVersion	String	可選項，如果未給出，則隱式設定為與Version相同的值，兼容性版本說明當前版本能二進制后向兼容的插件的版本，并用于解決此插件的依賴關系，即 Version2.1.1和CompatVersion 2.0.0，意味著插件的2.1.1版本是二進制后向兼容該插件的2.1.1~2.0.0的所有版本（含2.0.0），
Experimental	Boolean	可選項，默認為false，實驗性插件默認情況下不會被加載，而必須由用戶顯式使能，應該為可能會對用戶體驗產生負面影響的新插件使能此屬性，
DisabledByDefault	Boolean	可選項，默認為false，如果設定了，相應的插件默認情況下不會被加載，而必須由用戶顯式使能，應該為預計不會被太多人使用的插件進行設定，以減少附加資源消耗，
HiddenByDefault	Boolean	可選項，默認為false，如果設定了，則插件不會顯示在"關于插件..."對話框的默認視圖中，只有在用戶要求查看所有插件時才顯示，如果有-version命令列引數一起時，它也顯示，
Required	Boolean	可選項，默認為false，作為"關于插件..."對話框的提示，提示用戶可能無法手動禁用此插件，僅用于Core插件，
Platform	String	可選項，正則運算式，匹配運行插件的平臺名稱，省略標簽，意味著該插件可加載在所有平臺上，

插件描述鍵

這些鍵僅用于更詳細（以用戶為中心）的插件描述，所有這些都是可選項，

鍵	值型別	含義
Category	String	默認為`Utilities`，用于在"關于插件..."對話框的插件概述中，將相關聯的插件放在同一樹節點下，
Vendor	String	字串，描述插件創建者/供應商，例如MyCompany，
Copyright	String	簡短的著作權宣告，例如`(C) 2016 MyCompany`，
License	String or array of strings	關于插件的可能多行的許可資訊，由于UI并非為長文本而設計，因此應保持相對簡短，
Description	String or array of strings	對插件應該提供的內容進行可能多行的描述，由于UI并非為長文本而設計，因此應保持相對簡短，
Url	String	鏈接到有關該插件的更多資訊，例如`http://www.mycompany-online.com/products/greatplugin`，

依賴

一個插件可以依賴于其他插件，這些是在插件元資料中指定的，以確保將這些其他插件在此插件之前被加載，

依賴項通過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的范圍內，

鍵	值型別	含義
Dependencies	依賴物件陣列	描述對其他插件的依賴

依賴物件是具有以下鍵的JSON物件：

鍵	值型別	含義
Name	String	該插件所依賴的插件的名稱，
Version	String	必須兼容的用來填充依賴項的被依賴插件的版本，格式為x.y.z_n，如果版本無關緊要，則可以為空，
Type	String	可選項，值為`Required`, `Optional`, 或 `Test`，如果依賴項是硬性要求，或者有運行插件測驗的要求，則定義之，默認為`Required`，

可選依賴項

插件可以指定對另一個插件的依賴關系是可選的，通過向依賴物件添加"Type" : "Optional"：

如果依賴關系可以被解決，則插件和它的依賴插件，將按照Required依賴關系進行加載和初始化，
如果依賴關系無法被解決，則只有插件被加載并初始化，就好像根本沒有宣告依賴關系一樣，

插件不會以任何方式被通知，是否存在可選依賴插件，因為依賴插件可能會被加載，也可能不會，插件也可能不會鏈接到該依賴插件，從可選依賴插件訪問物件的一種常見方法，是通過ExtensionSystem::PluginManager::getObjectByName() 或ExtensionSystem::PluginManager::getObjectByClassName()從全域物件池中獲取物件，并在獲取的物件上，呼叫QMetaObject函式，

測驗依賴項

當用戶使用-test命令列引數運行應用程式時，僅加載指定的插件及其依賴插件，這樣做是為了避免加載不需要的插件，從而加快測驗的執行速度，

通過使用"Type" : "Test"宣告依賴關系，插件可以指定，要求執行測驗功能，而不是執行正常功能的依賴插件，測驗依賴項是強制加載的，并且不影響加載順序，

這種依賴性不傳遞，

命令列引數

插件可以注冊命令列引數，用戶可以在啟動應用程式時提供的，當用戶使用-help命令列引數運行應用程式時，這些命令列引數將以單行說明的形式顯示，并且插件管理器會基于該資訊進行命令列決議和完整性檢查，如果插件管理器為插件找到匹配的命令列引數，會傳遞給給插件的initialize()函式，

命令列引數是通過Arguments鍵定義的，該鍵包含一個引數物件陣列，每個單獨的引數物件，都具有強制鍵Name，以及可選鍵Parameter和Description，

鍵	值型別	含義
Arguments	引數物件陣列	描述插件想要處理的命令列引數

引數物件是具有以下鍵的JSON物件：

鍵	值型別	含義
Name	String	命令列引數本身，包含前綴符號'-'，例如`-my-parameter`
Parameter	String	可選項，如果指定了此引數，則命令列引數需要一個附加值，例如-my-parameter somevalue，此屬性的值作為簡短描述，提供給用戶，
Description	String	可選項，引數的（單行）描述，用于命令列引數幫助，

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相同，

原創造福大家，共享改變世界

獻出一片愛心，溫暖作者心靈

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/14271.html

標籤：其他

上一篇：qt creator原始碼全方面分析(2-10-2)

下一篇：qt creator原始碼全方面分析(2-10-4)

qt creator原始碼全方面分析(2-10-3)