快速自定義Cordova插件(-配置文件）

知識 10-19

一、動態改變插件參數變數

在正式開始之前先補充個知識點：

1，在安卓gradle裡面有很多個控制變數，比如cdvBuildMultipleApks之類的，怎麼來的呢

首先創建一個.build文件比如：config.build文件，

然後在裡面定義變數如：

ext {

minSdkVersion = 14

targetSdkVersion = 23

compileSdkVersion = 23

}

也可以直接寫為ext.cdvBuildMultipleApks,ext.cdvVersionCodeForceAbiDigit,ext.cdvMinSdkVersion

ext的意思是對外提供變數

我們在build.gradle(app)在中使用的cdvBuildMultipleApks可能來自於build.gradle(project)中定義，也可能來自於其他的.gradle文件，在build.gradle(app)中使用時需要引入(build.gradle(project)的除外)如:apply from "../config.gradle"

2，安卓中config.xml文件中插件的配置舉例（cordova-plugin-crosswalk-webview插件）：

</plugin>

variable中name對應於插件裡面的plugin.xml中$XWALK_VERSION"，$XWALK_LITEVERSION，$XWALK_COMMANDLINE，$XWALK_MODE，$XWALK_MULTIPLEAPK：

在插件的plugin.xml中通過上面的方法可以獲取到config.xml中插件的配置value

3，安卓中config.xml裡面可以寫preference開頭的標籤文件，如：

然後在android中的.java文件和ios中的.m文件裡面可以獲取到並且配置。

現在我們正式開始，以cordova-plugin-wechat這個插件舉例：

plugin.xml配置文件如下：

<?xml version="1.0" encoding="UTF-8"?>

<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"

xmlns:rim="http://www.blackberry.com/ns/widgets"

xmlns:android="http://schemas.android.com/apk/res/android"

id="cordova-plugin-wechat"

version="2.1.0">

<name>Wechat</name>

<description>A cordova plugin, a JS version of Wechat SDK</description>

<keywords>cordova,wechat,weixin,share</keywords>

<repo>https://github.com/xu-li/cordova-plugin-wechat.git</repo>

<issue>https://github.com/xu-li/cordova-plugin-wechat/issues</issue>

<js-module src="www/wechat.js" name="Wechat">

</js-module>

<config-file target="config.xml" parent="/*">

</feature>

</config-file>

<config-file target="*-Info.plist" parent="LSApplicationQueriesSchemes">

<array>

<string>weixin</string>

<string>wechat</string>

</array>

</config-file>

<config-file target="*-Info.plist" parent="NSAppTransportSecurity">

<dict>

<key>NSAllowsArbitraryLoads</key>

<true/>

</dict>

</config-file>

<config-file target="*-Info.plist" parent="CFBundleURLTypes">

<array>

<dict>

<key>CFBundleURLName</key>

<string>weixin</string>

<key>CFBundleURLSchemes</key>

<array>

<string>$WECHATAPPID</string>

</array>

</dict>

</array>

</config-file>

<header-file src="src/ios/CDVWechat.h" />

<source-file src="src/ios/CDVWechat.m" />

<header-file src="src/ios/libs/OpenSDK1.8.0/WXApi.h" />

<header-file src="src/ios/libs/OpenSDK1.8.0/WXApiObject.h" />

<source-file src="src/ios/libs/OpenSDK1.8.0/libWeChatSDK.a" framework="true" />

</platform>

<config-file target="res/xml/config.xml" parent="/*">

</feature>

</config-file>

<config-file target="AndroidManifest.xml" parent="/*">

<uses-permission android:name="android.permission.INTERNET"/>

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>

<uses-permission android:name="android.permission.READ_PHONE_STATE" />

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

</config-file>

<config-file target="AndroidManifest.xml" parent="/manifest/application">

<activity

android:name=".wxapi.WXEntryActivity"

android:label="@string/launcher_name"

android:exported="true">

<intent-filter>

</intent-filter>

</activity>

<activity

android:name=".wxapi.WXPayEntryActivity"

android:label="@string/launcher_name"

android:exported="true"

android:launchMode="singleTop">

<intent-filter>

</intent-filter>

</activity>

</config-file>

<source-file src="src/android/Wechat.java" target-dir="src/xu/li/cordova/wechat" />

<source-file src="src/android/Util.java" target-dir="src/xu/li/cordova/wechat" />

</platform>

</plugin>

註：發現通過$WECHATAPPID去取到config.xml中插件配置的value的，同時發現通過在plugin.xml裡面就可以把需要的信息寫入到了ios中的info文件和安卓中的mainfest.xml文件中去了

安裝cordova-plugin-wechat這個插件需要用戶指定變數的值，需要在插件plugin.xml中添加<preference/>標籤，標籤有兩個參數設置：name和default。

1、name：變數名稱，如果需要引用name對應的value時使用$name，如 <preference name="KEY"> 引用使用 <data scheme="$KEY">;

2、default：默認值，如果用戶沒有指定值的時候。如果default參數未指定，則name屬性用戶必須填寫，這也是cordova的一個策略。

使用方式：cordova plugin cordova_plugin_xxx --variable key=123456789

安卓剛剛實現了在插件裡面的plugin.xml中可以去配置mainfest.xml，發現還有一個需求：就是怎麼通過插件去控制gradle中的配置呢?

思路就是：在插件的src/android中創建一個.gradle文件，然後在裡面寫配置，同時可以根據插件裡面的plugin.xml中的變數做不同的處理，還以開頭講的第二個知識點為例，

插件中的plugin.xml中其中有一個配置文件如下：

<config-file target="res/xml/config.xml" parent="/*">

</config-file>

在xwalk.gradle文件中 ext.xwalkMode = getConfigPreference("xwalkMode");，

這裡getConfigPreference("xwalkMode");裡面的「xwalkMode」紅字部分是對應的。

二、自定義插件中需要引入第三方庫

1，安卓中自定義插件需要引入jar包，這個問題搞了一天才搞好，被網上的貼子和老的demo給坑了，有個demo是拿jpush舉例子的

如下：

<source-file src="src/android/jpush-sdk-release1.7.5.jar" target-dir="libs"/>

實踐證明上面是錯誤的，看cordova官方有兩種做法：

The preferred way is to use the <framework /> tag (see the Plugin Specification for more details). Specifying libraries in this manner allows them to be resolved via Gradle"s Dependency Management logic. This allows commonly used libraries such as gson, android-support-v4, and google-play-services to be used by multiple plugins without conflict.

The second option is to use the <lib-file /> tag to specify the location of a jar file (see the Plugin Specification for more details). This approach should only be used if you are sure that no other plugin will be depending on the library you are referencing (e.g. if the library is specific to your plugin). Otherwise, you risk causing build errors for users of your plugin if another plugin adds the same library. It is worth noting that Cordova app developers are not necessarily native developers, so native platform build errors can be especially frustrating.

意思是說一種通過<framework>另一種是通過<lib-file>,第一種方式試了很多遍就是不成功，無奈試了第二種方式成功了。

過程如下：src/android/libs中放入需要引用的jar包

如上我是自定義友盟統計的插件，然後在plugin.xml中寫入：

<lib-file src="src/android/libs/umeng-analytics-7.4.0.jar" />

<lib-file src="src/android/libs/umeng-common-1.4.0.jar" />

<lib-file src="src/android/libs/utdid4all-1.1.5.3_proguard.jar" />

2，ios中添加framework（依然拿友盟framework舉例）

注意的地方是framework有可能會依賴系統的庫，比如友盟這裡就需要添加：

快速自定義Cordova插件(-配置文件）