PS:目前利用前端技術(shù)開發(fā)跨平臺App很火爆法梯，最火的當(dāng)屬使用cordova框架開發(fā)App速缨，另外最近很火的前端開發(fā)框架ionic訪問原生的能力也是來自于cordova(對cordova進(jìn)行了封裝)拒秘。插件是它們的核心所在，無論我們要使用ionic還是直接使用cordova去開發(fā)一個App碱蒙，都會用到框架提供的插件或自定義插件琴儿，所以掌握Plugin.xml的編寫還是很重要滴~。

plugin.xml文件作用

plugin.xml文件定義插件所需的結(jié)構(gòu)和設(shè)置茵休，它通過幾個元素來提供有關(guān)插件的詳細(xì)信息薪棒。

cordova Plugin.xml 官網(wǎng)
現(xiàn)在開始詳細(xì)說一下這些元素（標(biāo)簽）~~~

頂級元素plugin

該plugin元素是插件清單的頂級元素手蝎。

例：

<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
    xmlns:android="http://schemas.android.com/apk/res/android"
    id="my-plugin-id"
    version="1.0.2">

engines and engine

plugin元素的子元素<engines>指定此插件支持的基于Apache Cordova的框架的版本钞脂。對于目標(biāo)項目不滿足引擎約束的任何插件揣云，CLI將使用非零代碼進(jìn)行中止。如果不指定了標(biāo)記冰啃，則CLI會嘗試盲目地安裝到指定的cordova項目目錄中邓夕。

注意：在Cordova 6.1.0+中，指定平臺亿笤，插件和CLI依賴項的推薦位置在插件的package.json中翎迁。有關(guān) 更多信息，請參閱指定Cordova依賴項净薛。

例如:

<engines>
  <engine name="cordova-android" version="=1.8.0" />
</engines>

引擎元素還可以使用“>”毁枯，“> =”等指定模糊匹配以避免重復(fù)慈缔，并在更新基礎(chǔ)平臺時減少維護(hù)。

<engines>
  <engine name="cordova-android" version=">=1.8.0" />
</engines>

該<engine>標(biāo)簽?zāi)J(rèn)支持所有的已經(jīng)存在的主要的cordova平臺种玛。指定cordova引擎標(biāo)記意味著任何平臺上的所有Cordova版本都必須滿足引擎版本屬性藐鹤。您還可以列出特定平臺及其版本瓤檐，以覆蓋籠統(tǒng)的cordova引擎：

<engines>
  <engine name="cordova" version=">=1.7.0" />
  <engine name="cordova-android" version=">=1.8.0" />
  <engine name="cordova-ios" version=">=1.7.1" />
</engines>

自定義框架的例子：

<engines>
  <engine name="my_custom_framework" version="1.0.0" platform="android" scriptSrc="path_to_my_custom_framework_version"/>
  <engine name="another_framework" version=">0.2.0" platform="ios|android" scriptSrc="path_to_another_framework_version"/>
  <engine name="even_more_framework" version=">=2.2.0" platform="*" scriptSrc="path_to_even_more_framework_version"/>
</engines>

name

該name元素用于指定插件的名稱。此元素（尚未）處理本地化娱节。
例如：

 <name>Foo</name>

description

該description元素用于指定插件的描述挠蛉。此元素（尚未）處理本地化。
例如：

<description>Foo plugin description</description>

author

author元素的內(nèi)容包含插件作者的名稱括堤。

例如：

<author>Foo plugin author</author>

keywords

keywords元素的內(nèi)容包含逗號分隔的關(guān)鍵字以描述插件碌秸。

例子：

<keywords>foo,bar</keywords>

license（許可、執(zhí)照）

此元素用于指定插件的許可證悄窃。
例如:

<license>Apache 2.0 License</license>

asset

此元素用于列出要復(fù)制到Cordova應(yīng)用程序www目錄中的文件或目錄。任何嵌套在<platform>元素中的<asset>元素都指定特定于平臺的web資源蹂窖。

例子：

<!-- a single file, to be copied in the root directory -->
<asset src="www/foo.js" target="foo.js" />
<!-- a directory, also to be copied in the root directory -->
<asset src="www/foo" target="foo" />

資源也可以指定到子目錄问潭。這將在www目錄中創(chuàng)建js/experimental目錄，除非已存在婚被，并復(fù)制該new-foo.js文件并將其重命名為foo.js狡忙。

<asset src="www/new-foo.js" target="js/experimental/foo.js" />

js-module

大多數(shù)插件都包含一個或多個JavaScript文件。每個<js-module>標(biāo)記對應(yīng)一個JavaScript文件址芯，并阻止插件的使用者必須為每個文件添加<script>標(biāo)記灾茁。不要使用cordova.define包裝文件，因為它是自動添加的谷炸。該模塊包含在一個閉包中北专，帶有模塊，導(dǎo)出淑廊，以及要求在范圍內(nèi)逗余，就像普通的AMD模塊一樣。嵌套在<platform>元素中的<js-module>元素聲明特定平臺綁定的JavaScript模塊季惩。

例如：

使用下面的示例安裝插件時捣辆，將socket.js復(fù)制到www/plugins/my-plugin-id/socket.js并添加為條目www/cordova_plugins.js蔬螟。在加載時，代碼cordova.js使用XHR讀取每個文件并將<script>標(biāo)記注入HTML汽畴。

<js-module src="socket.js" name="Socket">
</js-module>

同樣對于此示例旧巾，如果插件ID為chrome-socket，則模塊名稱將為chrome-socket.Socket忍些。

clobbers（覆蓋~個人理解）

<js-module>允許元素內(nèi)使用鲁猩。用于指定window插入module.exports的對象下的命名空間。你可以擁有任意多的<clobbers>罢坝，相應(yīng)的window上創(chuàng)建的對象將不可用廓握。

例：

<js-module src="socket.js" name="Socket">
  <clobbers target="chrome.socket" />
</js-module>

這里module.exports作為window.chrome.socket被插入到window對象中炸客。

merges

<js-module>允許元素內(nèi)使用疾棵。用來指定在哪里module.exports獲取與任何現(xiàn)有的價值合并window對象的命名空間。如果已經(jīng)存在痹仙，模塊的版本取代原來的是尔。你可以有很多的merges只要你喜歡。創(chuàng)建在window上的任何對象不可用开仰。
| 屬性(類型) | 描述 |
| --- | --- |
| target(string) | module.exports合并到的命名空間拟枚。 |
例：

<js-module src="socket.js" name="Socket">
  <merges target="chrome.socket" />
</js-module>

這里module.exports與任何現(xiàn)有值合并在一起window.chrome.socket。

runs

<js-module>允許元素內(nèi)使用众弓。它意味著您的代碼應(yīng)該使用cordova.require恩溅，但不能安裝在window對象上。這在初始化模塊谓娃，附加事件處理程序或其他方面很有用脚乡。您最多只能有一個<runs/>標(biāo)簽。需要注意的是滨达，包括一個<runs/>帶有<clobbers/>或者<merges/>是多余的奶稠，因為它們也cordova.require你的模塊俯艰。
例如：

<js-module src="socket.js" name="Socket">
  <runs/>
</js-module>

dependency

該<dependency>標(biāo)簽允許你指定在其當(dāng)前插件依賴其他插件。插件由其唯一的npm id或github url引用锌订。

例:

<dependency id="cordova-plugin-someplugin" url="https://github.com/myuser/someplugin" commit="428931ada3891801" subdir="some/path/here" />
<dependency id="cordova-plugin-someplugin" version="1.0.1">

platform

標(biāo)識具有關(guān)聯(lián)原生代碼或需要修改其配置文件的平臺养葵。使用此規(guī)范的工具可以識別支持的平臺并將代碼安裝到Cordova項目中征堪。沒有<platform>標(biāo)簽的插件被假定為僅僅是JavaScript，因此可以安裝在任何和所有平臺上关拒。

例如：

<platform name="android">
  <!-- android-specific elements -->
</platform>

source-file

標(biāo)識應(yīng)安裝到項目中的可執(zhí)行源代碼。

例子：

<!-- android -->
<source-file src="src/android/Foo.java" target-dir="src/com/alunny/foo" />
<!-- ios -->
<source-file src="src/ios/CDVFoo.m" />
<source-file src="src/ios/someLib.a" framework="true" />
<source-file src="src/ios/someLib.a" compiler-flags="-fno-objc-arc" />

header-file

這類似于<source-file>元素凯傲，但專門針對iOS和Android等平臺，用于區(qū)分源文件嗦篱，頭文件和資源冰单。Windows不支持此功能。

例：

<header-file src="CDVFoo.h" />

resource-file

這類似于<source-file>元素，但專門用于區(qū)分源文件椿每，頭文件和資源的iOS和Android等平臺伊者。

例子：
For Android:

<resource-file src="FooPluginStrings.xml" target="res/values/FooPluginStrings.xml" />

For Windows:

<resource-file src="src/windows/win81/MobServices.pri" target="win81\MobServices.pri" device-target="windows" versions="8.1" arch="x64"/>

<!-- Example of referencing  -->
<resource-file src="x86/foo.dll" target="foo.dll" arch="x86" reference="true" />
<resource-file src="x64/foo.dll" target="foo.dll" arch="x64" reference="true" />

注意：target應(yīng)使用反斜杠以避免在Visual Studio中DEP2100部署錯誤投慈。

config-file

標(biāo)識要修改的基于XML的配置文件，即：該文檔中應(yīng)該被修改的位置冠骄，以及應(yīng)修改的內(nèi)容伪煤。已使用此元素測試修改的兩種文件類型是xml和plist文件。該config-file元素僅允許您將新子項附加到XML文檔樹凛辣。子項是要插入目標(biāo)文檔的XML literals带族。

例如:

For XML（Android等）:

<config-file target="AndroidManifest.xml" parent="/manifest/application">
    <activity android:name="com.foo.Foo" android:label="@string/app_name">
        <intent-filter>
        </intent-filter>
    </activity>
</config-file>

For plist（iOS）:

<config-file target="*-Info.plist" parent="CFBundleURLTypes">
    <array>
        <dict>
            <key>PackageName</key>
            <string>$PACKAGE_NAME</string>
        </dict>
    </array>
</config-file>

For windows-specific attributes:

<config-file target="package.appxmanifest" parent="/Package/Capabilities" versions="<8.1.0">
    <Capability Name="picturesLibrary" />
    <DeviceCapability Name="webcam" />
</config-file>
<config-file target="package.appxmanifest" parent="/Package/Capabilities" versions=">=8.1.0" device-target="phone">
    <DeviceCapability Name="webcam" />
</config-file>

上面的示例將設(shè)置8.1之前的平臺（特別是Windows 8）以要求webcam設(shè)備功能和picturesLibrary常規(guī)功能肥缔，并僅將webcam設(shè)備功能應(yīng)用于為Windows Phone構(gòu)建的Windows 8.1項目。Windows桌面8.1系統(tǒng)未經(jīng)修改汹来。

plugins-plist

指定要附加到iOS Cordova項目中AppInfo.plist 文件的鍵和值续膳。這已經(jīng)過時，因為它僅適用于cordova-ios 2.2.0及更低版本俗慈。將使用<config-file>標(biāo)簽用于較新版本的Cordova姑宽。

lib-file

類似source, resource, and header files，但特別適用于使用用戶生成的庫的BlackBerry 10等平臺闺阱。對于Windows平臺炮车，在生成的Windows項目文件中該<lib-file>元素允許包含an <SDKReference>。

例如：

<lib-file src="src/BlackBerry10/native/device/libfoo.so" arch="device" />
<lib-file src="src/BlackBerry10/native/simulator/libfoo.so" arch="simulator" />

For Windows:

<lib-file src="Microsoft.WinJS.2.0, Version=1.0" arch="x86" />
<lib-file src="Microsoft.WinJS.2.0, Version=1.0" versions=">=8.1" />
<lib-file src="Microsoft.WinJS.2.0, Version=1.0" target="phone" />
<lib-file src="Microsoft.WinJS.2.0, Version=1.0" target="win" versions="8.0" arch="x86" />

framework

標(biāo)識插件所依賴的框架（通常是OS /平臺的一部分）腋粥。

例如：
For iOS:

<framework src="libsqlite3.dylib" />
<framework src="social.framework" weak="true" />
<framework src="relative/path/to/my.framework" custom="true" />

在Android上（截至cordova-android@4.0.0）揍障，框架標(biāo)記用于包含Maven依賴項目养，或包含捆綁的庫項目。

<!-- Depend on latest version of GCM from play services -->
<framework src="com.google.android.gms:play-services-gcm:+" />
<!-- Depend on v21 of appcompat-v7 support library -->
<framework src="com.android.support:appcompat-v7:21+" />
<!-- Depend on library project included in plugin -->
<framework src="relative/path/FeedbackLib" custom="true" />

Framework還可用于將自定義.gradle文件包含在主項目的.gradle文件中：

<framework src="relative/path/rules.gradle" custom="true" type="gradleReference" />

在Windows下使用毒嫡，custom='true'并且type='projectReference'將添加項目引用癌蚁，將被添加到這些cordova項目的編譯+鏈接步驟幻梯。這基本上是當(dāng)前“自定義”框架可以針對多個體系結(jié)構(gòu)的唯一方式，因為它們顯式構(gòu)建為依賴通過cordova應(yīng)用程序的引用努释。

<framework src="path/to/project/LibProj.csproj" custom="true" type="projectReference"/>

使用這些Windows特定屬性的示例：

<framework src="src/windows/example.dll" arch="x64" />
<framework src="src/windows/example.dll" versions=">=8.0" />
<framework src="src/windows/example.vcxproj" type="projectReference" target="win" />
<framework src="src/windows/example.vcxproj" type="projectReference" target="all" versions="8.1" arch="x86" />
<framework src="src/windows/example.dll" target-dir="bin/x64" arch="x64" custom="true"/>

info

向用戶提供的其他信息碘梢。當(dāng)您需要無法輕松實現(xiàn)或超出CLI范圍的額外步驟時，這非常有用伐蒂。CLI安裝插件時會打印出此標(biāo)記的內(nèi)容煞躬。

例：

<info>
You need to install __Google Play Services__ from the `Android Extras` section using the Android SDK manager (run `android`).

You need to add the following line to the `local.properties`:

android.library.reference.1=PATH_TO_ANDROID_SDK/sdk/extras/google/google_play_services/libproject/google-play-services_lib
</info>

hook

表示您在發(fā)生特定操作時將由Cordova調(diào)用的自定義腳本（例如，在添加插件或調(diào)用平臺準(zhǔn)備邏輯之后）逸邦。當(dāng)您需要擴(kuò)展默認(rèn)的Cordova功能時恩沛，這非常有用。有關(guān)詳細(xì)信息缕减，請參閱 Hooks Guide雷客。

例：

<hook type="after_plugin_install" src="scripts/afterPluginInstall.js" />

uses-permission

在某些情況下，插件可能需要根據(jù)目標(biāo)應(yīng)用程序進(jìn)行配置更改桥狡。例如搅裙，要在Android上注冊C2DM，其包ID為my-app-id的應(yīng)用程序?qū)⑿枰粋€權(quán)限总放，比如：

<uses-permission android:name="my-app-id.permission.C2D_MESSAGE"/>

在這種情況下呈宇，從plugin.xml文件中插入的內(nèi)容未提前知道，變量可以用美元符號表示局雄，后跟一系列大寫字母甥啄，數(shù)字或下劃線。對于上面的示例炬搭，該plugin.xml文件將包含此標(biāo)記：

<uses-permission android:name="$PACKAGE_NAME.permission.C2D_MESSAGE"/>

CLI使用指定值替換變量引用蜈漓，如果未找到則替換空字符串」可以檢測變量引用的值（在這種情況下融虽，從AndroidManifest.xml文件中）或由工具的用戶指定; 確切的過程取決于特定的工具。

Plugman可以請求用戶指定插件的必需變量灼芭。例如有额，可以將C2M和Google Maps的API密鑰指定為命令行參數(shù)：

plugman --platform android --project /path/to/project --plugin name|git-url|path --variable API_KEY=!@CFATGWE%^WGSFDGSDFW$%^#$%YTHGsdfhsfhyer56734

應(yīng)保留某些變量名稱，例如$PACKAGE_NAME彼绷。這是包的反向域樣式唯一標(biāo)識符巍佑，對應(yīng)CFBundleIdentifier于iOS上或package屬性的頂級manifest元素在AndroidManifest.xml文件中。

preference

如上一節(jié)所示寄悯，有時插件可能要求用戶指定其變量的值萤衰。要使這些變量成為必需項，<platform>標(biāo)記需要包含<preference>標(biāo)記猜旬。CLI檢查是否傳入了這些必需的首選項脆栋。如果沒有倦卖，它應(yīng)該警告用戶如何傳入變量并使用非零代碼退出。

例如:

<preference name="API_KEY" default="default-value" />

*好啦舍扰，到這里終于把Plugin.xml文件給解析了一遍，希望對讀者有幫助希坚，下一節(jié)我們將在ionic項目中創(chuàng)建一個cordova自定義插件边苹。