cordova入门教程(三)自定义Android平台插件

有时cordova和npm上提供的插件都不能满足我们的项目需求,这时候就要自己定义插件并将原生接口暴露给cordova了

开发插件

现在我们开发一个Android平台中弹出Toast的插件,创建一个文件夹cordova-plugin-toast作为toast插件的根目录,其他需要创建的文件和文件夹如下,

cordova-plugin-toast
-src
--android
---Toast.java//Android插件实现
--ios//如果要提供ios插件的话,要在里面放上.h的toast的实现
-pulgin.xml  //插件配置文件,主要通过该文件将原生接口暴露给cordova

Toast.java文件要继承CordovaPlugin类,然后重写execute()方法,代码如下:

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

public class Toast extends CordovaPlugin
{

    @Override
    public boolean execute(String action, JSONArray data, CallbackContext callbackContext) throws JSONException
    {

        if (action.equals("toast"))
        {
            toast(data);
            return true;
        }
        else
        {
            return false;
        }
    }

    public void toast(JSONArray data)
    {
        android.widget.Toast.makeText(this.cordova.getActivity(), data.getString(0), android.widget.Toast.LENGTH_SHORT).show();
    }
    
}

execut()其实是个分发器,根据不同的action调用不同的方法,方便以后跟新维护。
接下来,我们就要配置plugin.xml文件了

<plugin xmlns="http://www.phonegap.com/ns/plugins/1.0" //命名空间,默认为该值
        id="cordova-plugin-toast" //npm类型的标识符,一般与根目录保持一致
        version="0.7.0">//版本号
    <name>Toast</name>//插件名称
    <engines>
        <engine name="cordova" version=">=3.4.0"/>//支持的cordova版本
    </engines>

    <platform name="android">//Android平台
        <config-file target="res/xml/config.xml" parent="/*">
            <feature name="Toast">//服务名称,后面在js中对应service这个参数
                <param name="android-package" value="com.whr.demo.Toast"/>//value为完整的类名
            </feature>
        </config-file>
        <source-file src="src/android/Toast.java" target-dir="src/com/whr/demo/"/>//src为源文件位置,target-dir为解压到目标位置,为上面类的包名
    </platform>

   //ios的有些不同,以后补充...

</plugin>

添加插件

plugin.xml配置好之后,我们将cordova这个文件夹拷贝到我们的cordova工程下的plugins文件夹下


然后呢,通过下面的命令行将我们自定义的插件添加到cordova。

cordova plugin add cordova-plugin-toast

这边的名称为文件夹的名称。提示安装成功之后,我们就可以在js中使用该插件了

//Toast为我们在plugin.xml中feature元素里name的名称,它对应com.whr.demo.Toast这个类
//toast为action名称,我们在Toast.java文件中通过action名称识别前端要请求的方法。
cordova.exec(onSuccess, onFail, "Toast", "toast", ["123"]);

补充

  • 我们可以使用corodova这个全局变量的前提,是我们的html引入cordova.js文件
<script type="text/javascript" src="cordova.js"></script>
  • 为了方便后期的维护,我们一般在js中会cordova.exec(onSuccess, onFail, "Toast", "toast", ["123"])再进行封装一层
    在插件根目录下添加www文件夹
cordova-plugin-toast
-www
--toast.js

tost.js中的代码为

module.exports = {
    toast: function (name, successCallback, errorCallback) {
        cordova.exec(successCallback, errorCallback, "Toast", "toast", [name]);
    }
};

然后在上面plugin.xml中添加

<asset src="www/toast.js" target="js/toast.js"/>
<js-module src="www/toast.js" name="toast">
  <clobbers target="toast" />
</js-module>

更新插件后,我们就可以这样使用啦,后面插件有更新改动什么的,前端也不用改啦

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

推荐阅读更多精彩内容