Cordova plugin

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/u010106153/article/details/53418528
Cordova plugin
工程目录

src: 各个平台的源码文件，包含 Android ios blackberry 等；
www: JavaScript调用native代码的接口文件；
plugin.xml: 插件的配置文件

编写Android代码
首先定义一个类继承自CordovaPlugin：
public class Updater extends CordovaPlugin {
public Updater(){
}
}
1
2
3
4
在该类中添加一个方法execute:
public class Updater extends CordovaPlugin {
public Updater(){

}

public boolean execute(String action, JSONArray args, final CallbackContext callbackContext) throws JSONException {
if (action.equals("update")) {
new UpdaterTask(callbackContext).execute(args.getString(0));
}else{
return false;
}
return true;
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
action:在JavaScript中调用时指定的action名称；
args：在JavaScript中调用时传入的参数；
callbackContext：向JavaScript返回结果的上下文对象，正确返回时callbackContext.success(data),错误返回时 callbackContext.error(err)

注意：cordova plugin中的上下文与Android native中的上下文有所区别，例如在cordova中启动一个Activity的写法是：cordova.getActivity().startActivity(Intent intent)，且cordova plugin中的Activity需要继承自CordovaActivity.

编写plugin.xml文件
首先看一个例子：

<?xml version='1.0' encoding='utf-8'?>
<plugin id="expense-plugin-updater" version="0.0.1" xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android">
<name>ExpenseUpdater</name>
<js-module name="ExpenseUpdater" src="www/expense-plugin-updater.js"><clobbers target="expenseupdater"/></js-module>
<platform name="android">
<config-file parent="/*" target="res/xml/config.xml">
<feature name="ExpenseUpdater"><param name="android-package" value="expense.plugin.updater.Updater"/></feature>
</config-file>
<config-file parent="/*" target="AndroidManifest.xml">
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.INTERNET" />
</config-file>
<source-file src="src/android/Updater.java" target-dir="src/expense/plugin/updater"/>
<source-file src="src/android/UpdaterTask.java" target-dir="src/expense/plugin/updater"/>
<source-file src="src/android/DecompressFast.java" target-dir="src/expense/plugin/updater"/>
</platform>
</plugin>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
js-module: name:接口文件的名字 src：接口文件的路径 clobbers.target：在宿主工程中该plugin的对象名称；
feature：每一个调用入口都需要在这里注册，即：extends CordovaPlugin的类
source-file：源码文件的map关系
plugin.xml详细的教程见：https://cordova.apache.org/docs/en/latest/plugin_ref/spec.html
编写接口文件
例子：

var exec = require('cordova/exec');

exports.update = function(url, success, error) {
exec(success, error, "ExpenseUpdater", "update", [url]);
};
1
2
3
4
5
success: 正确回调
error：错误回调
ExpenseUpdater：需要调用的feature的名称
update：需要调用的action的名称
[url]:传入的参数数组
在Ionic2中如何使用
首先将该plugin安装到ionic工程中：
cordova plugin add [path-to-your-plugin]
1
编写一个调用的interface[updater.d.ts]
export declare class ExpenseUpdater {
update(url: string): Promise<any>;
}
1
2
3
实现interface[updater.js]
"use strict";
var ExpenseUpdater = (function(){
function ExpenseUpdater(){};

ExpenseUpdater.prototype.update=function(url){
return new Promise(function(resolve,reject){
expenseupdater.update(url,function(msg){
resolve(msg);
},function(err){
reject("fuck");
});
});
};
return ExpenseUpdater;
}());

exports.ExpenseUpdater = ExpenseUpdater;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
注意：其中expenseupdater对应pluign.xml文件中的js-module标签中的clobbers.target
---------------------
作者：LehmanHe
来源：CSDN
原文：https://blog.csdn.net/u010106153/article/details/53418528
版权声明：本文为博主原创文章，转载请附上博文链接！