Android平台下,自定义Cordova插件

除了使用Cordova官方的插件外,我们也可以自己写插件,来满足业务需求。

在Android平台,每个插件都有两部分组成:

  • 插件的JavaScript文件
  • 插件的JAVA类

创建插件的JavaScript

插件所在的目录assets/www/plugins/,如果你添加了Cordova的插件,可以看到下图

可以看到Cordova自己的插件都定义在,以其包名命名的文件夹下的www目录中,我们也按照此约定创建JS,指定包名为 com.test.plugin

JS内容如下:

// "com.test.plugin.PluginTest"指定的是此插件的ID
cordova.define("com.test.plugin.PluginTest", function (require, exports, module) {

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

    function PluginTest() {
    }

    PluginTest.prototype = {
            
        test1: function (params, successCallback, errorCallback) {
            // 第三个参数是插件的名称,必须与config.xml文件中的feature.name保持一致
            exec(successCallback, errorCallback, "PluginTest", "test1", [params]);
        },
        test2: function (params, successCallback, errorCallback) {
            exec(successCallback, errorCallback, "PluginTest", "test2", [params]);
        }
    }

    module.exports = new PluginTest();
});

创建插件的JAVA类

继承CordovaPlugin类,并重写其execute方法,约定:类中的方法名与js中的方法名保持一致,方便查找。

package com.test.plugin;

import org.apache.cordova.CallbackContext;
import org.apache.cordova.CordovaPlugin;
import org.json.JSONArray;
import org.json.JSONException;

import android.widget.Toast;

public class PluginTest extends CordovaPlugin {

    /**
     * 必须重写execute方法
     */
    @Override
    public boolean execute(String action, JSONArray args,
            CallbackContext callbackContext) throws JSONException {
        if("test1".equals(action)) {
            this.test1(args, callbackContext);
        }else if("test2".equals(action)) {
            this.test2(args, callbackContext);
        }else{
            return false;
        }
        return true;
    }

    private void test1(JSONArray args, final CallbackContext callbackContext)
            throws JSONException {
        // 开启worker线程
        cordova.getThreadPool().execute(new Runnable() {
            @Override
            public void run() {
                System.out.println("Execute test1 method");
                callbackContext.success("执行成功回调");
            }
        });
    }

    private void test2(JSONArray args, final CallbackContext callbackContext)
            throws JSONException {
        // 在UI线程上执行
        cordova.getActivity().runOnUiThread(new Runnable() {
            @Override
            public void run() {
                Toast.makeText(cordova.getActivity(), "Execute test2 method", Toast.LENGTH_SHORT).show();
                callbackContext.error("执行失败回调");
            }
        });
    }

}

配置插件

下面是配置插件,让Cordova知道我们写了个插件。
打开res/xml/config.xml文件,添加一个feature:

Cordova会解析config.xml文件,每个feature就是一个plugin.

key desc
feature.name plugin的名称
android-package 指定插件的java类,必须是含包名的完整命名
onload 为true,表示webview在加载html时,是否加载此插件。默认为false,当要使用此插件时,再去加载

到这里插件就完成了,可以在JS中调用插件的方法了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,829评论 1 331
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,603评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,846评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,600评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,780评论 3 272
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,695评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,136评论 2 293
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,862评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,453评论 0 229
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,942评论 2 233
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,347评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,790评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,293评论 3 221
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,839评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,448评论 0 181
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,564评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,623评论 2 249

推荐阅读更多精彩内容