Cordova入門系列（四）自定義Cordova插件--showToast

版權聲明：本文為博主原創文章，轉載請注明出處

 

　　前三篇Cordova入門系列，簡單講解了Cordova，以及如何調用Cordova插件，今天我們講解一下如何自己做一個插件。

　　自定義插件，就是自己寫一些安卓java代碼，然后和js代碼以及配置文件，封裝成一個cordova插件。通過js代碼，調用安卓java代碼，從而實現調用原生的東西。只不過這些調用原生的行為是我們為了我們自己特定的需求寫的，而不是Cordova官方的。。。

　　自定義插件的結構：　　

　　|---pluginName                        
　　　　|---src
　　　　　　|---android
　　　　　　　　|---XXX.java

　　　　　　|---ios
　　　　|---www
　　　　　　|---xxx.js
　　　　|---plugin.xml

 

　　我們今天做一個名字叫showToast的插件，用戶點擊的時候，會調用安卓原生的Toast去顯示。目錄結構如下：

　　

　　

　　先看showToast.js

cordova.define("myPlugins.showToast", function(require, exports, module) { var exec = require('cordova/exec'); var myFunc = function(){}; // arg1：成功回調
    // arg2：失敗回調
    // arg3：將要調用類配置的標識,要在feature中配置的
    // arg4：調用的原生方法名
    // arg5：參數，json格式
    myFunc.prototype.show=function(success, fail) { exec(success, fail, "ShowToast", "show", []); }; var showtoast = new myFunc(); module.exports = showtoast; });

 

　　再看ShowToast.java

package myPlugin; import org.apache.cordova.CallbackContext; import org.apache.cordova.CordovaPlugin; import org.json.JSONArray; import org.json.JSONException; import android.app.Activity; import android.widget.Toast; public class ShowToast extends CordovaPlugin { @Override public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException { Activity activity = cordova.getActivity(); if("show".equals(action)) { Toast.makeText(activity, "this is my plugin showToast", Toast.LENGTH_SHORT).show(); } callbackContext.success("toast success"); return true; } }

 

　　plugin.xml

<?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android" id="myPlugins.showToast" version="0.0.1">
    <name>showToast</name>
    <description>this is the plugin witch use js to call Toast</description>

    <js-module src="www/showToast.js">
        <clobbers target="myPlugins.showToast"/>
    </js-module>

    <platform name="android">
        <source-file src="src/android/ShowToast.java" target-dir="src/myPlugin"/>

        <config-file target="res/xml/config.xml" parent="/*">
            <feature name="ShowToast">
                <param name="android-package" value="myPlugin.ShowToast"/>
            </feature>
        </config-file>

        <config-file target="AndroidManifest.xml" parent="/*">
            <uses-permission android:name="android.permission.READ_PHONE_STATE" />
        </config-file>
    </platform>

</plugin>

 

　　安裝這個插件到項目中，cordova plugin add “插件的路徑”

　　然后調用：

myPlugins.showToast.show(  function(msg){ console.log(msg); }, function(msg){ console.log(msg); } );