Phonegap Android插件开发攻略

最新推荐文章于 2025-06-15 11:05:49 发布

原创最新推荐文章于 2025-06-15 11:05:49 发布 · 563 阅读

CC 4.0 BY-SA版权

1 篇文章

订阅专栏

本文介绍了PhoneGap Android插件的开发流程，包括配置开发环境、编写源文件、描述文件及JS接口等内容。详细阐述了插件的执行方式和相关指令，还讨论了插件实例化、线程交互等问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

phonegap插件由三部分组成源文件(src),js接口(www)，以及描述文件(plugin.xml)。

源文件应该继承于CordovaPlugin，并重写一个excute方法。

描述文件范例如下：

<-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="notification"

    version="1.0.0">

    <-name>Custom<-/name>

    <-description>Custom Plugin<-/description>

    <-license>Apache 2.0<-/license>

    <-keywords>cordova,Custom<-/keywords>

    <-js-module src="www/test.js" name="send">

        <-clobbers target="tpx" />

    <-/js-module>

    <-platform name="android">

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

            <-feature name="Custom" >

                <-param name="android-package" value="com.btt.plugin.test.Custom"/>

            <-/feature>

        <-/config-file>

        <-source-file src="src/android/Custom.java" target-dir="src/plugin" />

    <-/platform>

<-/plugin>

其中比较重要的参数有id，js-module等，具体说明如下：

· name:没有特殊含义。

· id:该插件的标识，com.btt.plugin.custom.该名字可以随意取，没关系。(可以通过phonegap local plugin list命令查看)

· js-module：指明js接口。name表示的是action的名字。clobbers是真正使用时的调用者。

· platform：平台相关信息。feature name表示的是service name。value属性值必须为源文件入口(包名.类名full_name_including_namespace)。

· source-file：源文件路径。target-dir：目标文件路径，可自定义。若有多个源文件，应该写多行。

插件add以后，可以查看res/xml/config.xml文件的变化

        <-feature name="">

        <-param name="android-package" value="" />

插件的执行可直接通过cordova.exec(function(winParam) {},function(error){},"Custom","send",params);语句执行的。也可通过js接口来执行：

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

exports = {

         send: function(callback) {

                 var params = [];

                 params.push("android toast");

                params.push("博思");

                //真正调用的是cordova.exec(...);

                 exec(callback, function(error){alert(error.code + ' ' + error.message);}, "Custom", "send", params);

};

· 查看已成功安装的插件列表:phonegap local plugin list

· 添加本地插件:phonegap local plugin add path(e.g D:\phonegap\plugins\com.btt.plugin.test)

· 移除本地插件:phonegap local plugin remove id

插件在被js调用的时候才创建实例，一种情况下例外：

<-feature name="Echo">

    <-param name="android-package" value="" />

    <-param name="onload" value="true" />

插件的执行接口并不是运行在WebView主线程中，而是运行在WebCore线程中，当需要与UI进行交互，可以通过一下手段：

                     cordova.getActivity().runOnUiThread(new Runnable() {

                public void run() {

...

                    callbackContext.success(); // Thread-safe.

});

或

            cordova.getThreadPool().execute(new Runnable() {

                public void run() {

...

                    callbackContext.success(); // Thread-safe.

});