PS:目前利用前端技术开发跨平台App很火爆，最火的当属使用cordova框架开发App，另外最近很火的前端开发框架ionic访问原生的能力也是来自于cordova(对cordova进行了封装)。插件是它们的核心所在，无论我们要使用ionic还是直接使用cordova去开发一个App，都会用到框架提供的插件或自定义插件，所以掌握Plugin.xml的编写还是很重要滴~。

plugin.xml文件作用

plugin.xml文件定义插件所需的结构和设置，它通过几个元素来提供有关插件的详细信息。

cordova Plugin.xml 官网
现在开始详细说一下这些元素（标签）~~~

顶级元素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的框架的版本。对于目标项目不满足引擎约束的任何插件，CLI将使用非零代码进行中止。如果不指定了标记，则CLI会尝试盲目地安装到指定的cordova项目目录中。

注意：在Cordova 6.1.0+中，指定平台，插件和CLI依赖项的推荐位置在插件的package.json中。有关 更多信息，请参阅指定Cordova依赖项。

例如:

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

引擎元素还可以使用“>”，“> =”等指定模糊匹配以避免重复，并在更新基础平台时减少维护。

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

该<engine>标签默认支持所有的已经存在的主要的cordova平台。指定cordova引擎标记意味着任何平台上的所有Cordova版本都必须满足引擎版本属性。您还可以列出特定平台及其版本，以覆盖笼统的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元素的内容包含插件作者的名称。

例如：

<author>Foo plugin author</author>

keywords

keywords元素的内容包含逗号分隔的关键字以描述插件。

例子：

<keywords>foo,bar</keywords>

license（许可、执照）

此元素用于指定插件的许可证。
例如:

<license>Apache 2.0 License</license>

asset

此元素用于列出要复制到Cordova应用程序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目录中创建js/experimental目录，除非已存在，并复制该new-foo.js文件并将其重命名为foo.js。

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

js-module

大多数插件都包含一个或多个JavaScript文件。每个<js-module>标记对应一个JavaScript文件，并阻止插件的使用者必须为每个文件添加<script>标记。不要使用cordova.define包装文件，因为它是自动添加的。该模块包含在一个闭包中，带有模块，导出，以及要求在范围内，就像普通的AMD模块一样。嵌套在<platform>元素中的<js-module>元素声明特定平台绑定的JavaScript模块。

例如：

使用下面的示例安装插件时，将socket.js复制到www/plugins/my-plugin-id/socket.js并添加为条目www/cordova_plugins.js。在加载时，代码cordova.js使用XHR读取每个文件并将<script>标记注入HTML。

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

同样对于此示例，如果插件ID为chrome-socket，则模块名称将为chrome-socket.Socket。

clobbers（覆盖~个人理解）

<js-module>允许元素内使用。用于指定window插入module.exports的对象下的命名空间。你可以拥有任意多的<clobbers>，相应的window上创建的对象将不可用。

例：

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

这里module.exports作为window.chrome.socket被插入到window对象中。

merges

<js-module>允许元素内使用。用来指定在哪里module.exports获取与任何现有的价值合并window对象的命名空间。如果已经存在，模块的版本取代原来的。你可以有很多的merges只要你喜欢。创建在window上的任何对象不可用。
| 属性(类型) | 描述 |
| --- | --- |
| target(string) | module.exports合并到的命名空间。 |
例：

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

这里module.exports与任何现有值合并在一起window.chrome.socket。

runs

<js-module>允许元素内使用。它意味着您的代码应该使用cordova.require，但不能安装在window对象上。这在初始化模块，附加事件处理程序或其他方面很有用。您最多只能有一个<runs/>标签。需要注意的是，包括一个<runs/>带有<clobbers/>或者<merges/>是多余的，因为它们也cordova.require你的模块。
例如：

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

dependency

该<dependency>标签允许你指定在其当前插件依赖其他插件。插件由其唯一的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

标识具有关联原生代码或需要修改其配置文件的平台。使用此规范的工具可以识别支持的平台并将代码安装到Cordova项目中。没有<platform>标签的插件被假定为仅仅是JavaScript，因此可以安装在任何和所有平台上。

例如：

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

source-file

标识应安装到项目中的可执行源代码。

例子：

<!-- 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等平台，用于区分源文件，头文件和资源。Windows不支持此功能。

例：

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

resource-file

这类似于<source-file>元素，但专门用于区分源文件，头文件和资源的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应使用反斜杠以避免在Visual Studio中DEP2100部署错误。

config-file

标识要修改的基于XML的配置文件，即：该文档中应该被修改的位置，以及应修改的内容。已使用此元素测试修改的两种文件类型是xml和plist文件。该config-file元素仅允许您将新子项附加到XML文档树。子项是要插入目标文档的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>

上面的示例将设置8.1之前的平台（特别是Windows 8）以要求webcam设备功能和picturesLibrary常规功能，并仅将webcam设备功能应用于为Windows Phone构建的Windows 8.1项目。Windows桌面8.1系统未经修改。

plugins-plist

指定要附加到iOS Cordova项目中AppInfo.plist 文件的键和值。这已经过时，因为它仅适用于cordova-ios 2.2.0及更低版本。将使用<config-file>标签用于较新版本的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

标识插件所依赖的框架（通常是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），框架标记用于包含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项目的编译+链接步骤。这基本上是当前“自定义”框架可以针对多个体系结构的唯一方式，因为它们显式构建为依赖通过cordova应用程序的引用。

<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

向用户提供的其他信息。当您需要无法轻松实现或超出CLI范围的额外步骤时，这非常有用。CLI安装插件时会打印出此标记的内容。

例：

<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

表示您在发生特定操作时将由Cordova调用的自定义脚本（例如，在添加插件或调用平台准备逻辑之后）。当您需要扩展默认的Cordova功能时，这非常有用。有关详细信息，请参阅 Hooks Guide。

例：

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

uses-permission

在某些情况下，插件可能需要根据目标应用程序进行配置更改。例如，要在Android上注册C2DM，其包ID为my-app-id的应用程序将需要一个权限，比如：

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

在这种情况下，从plugin.xml文件中插入的内容未提前知道，变量可以用美元符号表示，后跟一系列大写字母，数字或下划线。对于上面的示例，该plugin.xml文件将包含此标记：

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

CLI使用指定值替换变量引用，如果未找到则替换空字符串。可以检测变量引用的值（在这种情况下，从AndroidManifest.xml文件中）或由工具的用户指定; 确切的过程取决于特定的工具。

Plugman可以请求用户指定插件的必需变量。例如，可以将C2M和Google Maps的API密钥指定为命令行参数：

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

应保留某些变量名称，例如$PACKAGE_NAME。这是包的反向域样式唯一标识符，对应CFBundleIdentifier于iOS上或package属性的顶级manifest元素在AndroidManifest.xml文件中。

preference

如上一节所示，有时插件可能要求用户指定其变量的值。要使这些变量成为必需项，<platform>标记需要包含<preference>标记。CLI检查是否传入了这些必需的首选项。如果没有，它应该警告用户如何传入变量并使用非零代码退出。

例如:

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

*好啦，到这里终于把Plugin.xml文件给解析了一遍，希望对读者有帮助，下一节我们将在ionic项目中创建一个cordova自定义插件。