给Ionic写一个cordova(PhoneGap)插件

 给Ionic写一个cordova(PhoneGap)插件

之前由javaWeb转html5开发，由于面临新技术，遂在适应的过程中极为挣扎，不过还好~，这个过程也极为短暂；现如今面临一些较为复杂的需求还会有一丝丝头痛，却没有一开始那么强烈了。。。

  对于新手，建议准备好相应的IDE及环境：webstrom、google chrome、eclipse(或者 idea)，android SDK ; webstrom 用于配合页面js以及插件开发，eclipse用于app插件调试。

  就拿最近一个需求来说吧，需求：未防止第三方破解app，客户找了一个安全公司做个评估，其中一个安全问题是安卓apk的包经过修改后依然可以安装运行(ios由于安全机制存在不存在这个问题)，项目组内部讨论出一个比较好的解决方案是用户登陆前验证app包的hashcode值，并与后台交互验证当前发行版app的hashcode的有效性，以杜绝破解。

  这个需求的难点在于需要访问手机的内存读取安装包文件，如果是普通的需求就可以一个html、一个JS(controller)外加上路由配置就 so easy~

  首先一个规范的cordova插件是这样子的(这里我写的一个插件的名字是 cordova-plugin-integrity-checking)：

插件的主目录下面有两个文件夹(src和www)以及四个文件(LICENSE、package.json、plugin.xml、README.md)，插件内部的排列是根据cordova规范来的，这里不多解释，请看上图:

src:是放置安卓，ios，wp8等原生代目的地方，一般为了区分各个平台的代码都会先建一个文件夹(以上是android),文件夹下面是代码文件。

www：这里放置的是js调用原生代码的api，里面有调用方法和返回对象(可无)。

LICENSE:是一些开源说明,一般声明的开源协议有GNU、BSD、Apache等~ 

package.json:这里面用一个json声明了当前插件的文件结构，当然这个不是给开发者用的，是为了将此插件添加到项目中时打cordova命令用的，请不要忽略~

plugin.xml:这个文件里面是以xml的形式定义了包的路径以及api(js)对应原生的调用方法...,以及插件需要的权限声明(比如相机权限、位置权限、联系人权限等~)，打apk及ipa包后此文件会被融合~

README.md:这里是一些使用说明、注意事项等~，一般你将开发的插件共享在github上的时候会需要这个，如涉及版权及项目安全此文件可忽略~

  好了，咱们开始了~，首先按以上造型建文件和文件夹，我能说这是抄么-_-|||

  完毕，先写个原生的android代码吧(反正咱不会写oc d=====(￣▽￣*)b)， 一下样例是CordovaApkValidte.java =>

定义一个包名称(虽然文件最终都是集中放置的，但请想想大热天一个人穿着裤衩在溜街多辣眼睛啊(●￣(ｴ)￣●))，命名如下，写java的童鞋大概都知道，这里就不解释啦~：

package com.funnyZpC.integrityChecking.plugin;

然后就是cordova规范固定的写法，继承CordovaPlugin重写execute方法，你可以改，结果当然是不能用<(￣ˇ￣)/，exceute方法的形参图上已经说明，这儿就不必缀诉啦~

/**
     * Apk integrity checking
     * @author funnyZpC
     */
    public class CordovaApkValidate extends CordovaPlugin {
        /**
         * action:方法的动作，根据动作走相应的处理逻辑
         * args:js调用方法时传的参数，均以json的形式读入(这里未使用)
         * callbackContext:方法返回的对象，对象里面包好两个变量success和error,js的回调函数会用到
         * 
         */
        @Override
        public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {

以下是代码的主体部分，这只是一个很简单的插件，逻辑说明已经写进去了，自行阅读哈~

/**
             * 思路:根据cordova对象获取包的路径
             *             然实例化MessageDigest对象的SHA-1算法
             *             再讲当前包加载到输入流
             *             再按字节数组读取输入流获取大integer的值
             *             后将大integer转换成16进制的hashcode的表示
             *             后再将16进制扔给callbackContext对象返回
             */
            String apkPath=cordova.getActivity().getApplicationContext().getPackageCodePath();
              MessageDigest msgDigest = null;
            if (action.equals("getSHA1")) {
                try {
                            msgDigest = MessageDigest.getInstance("SHA-1");
                            byte[] bytes = new byte[1024];
                            int byteCount;
                            FileInputStream fis = new FileInputStream(new File(apkPath));
                            while ((byteCount = fis.read(bytes)) > 0){
                                msgDigest.update(bytes, 0, byteCount);
                            }
                            BigInteger bi = new BigInteger(1, msgDigest.digest());
                            callbackContext.success(bi.toString(16));
                            fis.close();
                } catch (Exception e) {
                    callbackContext.error("ERROR MESSAGE:"+e);
                    return false;
                }
            }
            return true;

在webstrom里面盲写没有引入包没有代码提示，bug率高，建议大家引入android SDK和cordova包在eclipse或idea里面写较nice~

雄关漫道真如铁，而今咱们只迈出了一步~，再接再厉哈(*^__^*)

下是js所调用的api：

1 cordova.define("cordova-plugin-integrity-checking.apkValidatePlugin", function(require, exports, module) {
 2 /*
 3 var exec = require('cordova/exec');
 4 
 5 exports.isDeviceRooted = function(success, error) {
 6     exec(success, error, "RootDetection", "isDeviceRooted", []);
 7 };
 8 */
 9 var exec = function (command, success, fail) {
10   cordova.exec(success, fail, "ApkValidatePlugin", command, []);//参数(回调成功,回调错误,别名,action名称,参数)
11 };
12 var apkValidate={};
13 apkValidate.getSHA1 = function (success, fail) {
14          return exec('getSHA1', success, fail);
15 };
16 
17 module.exports = apkValidate;
18 
19 });

一个完整的api包含api的id，以及一个回调，如第一行，这个api内部有一个核心(代码第10行)，里面包含了一些调用的参数，需要说明的是第三个参数是一个别名(可随意写)，这个名字需要对应到之后要说的plugin.xml里面的包的别名,第四个参数是action的名称，也就是刚刚在java文件里面写的action的名称(一定要对应啊~)，最后一个是传入的参数，别忘了这也是与CordovaApkValidate.java里面对应的，最后17行共享出来的是一个变量，方便打点调用，仿佛快成了~o(￣▽￣)d,别激动，这个会在最后的使用会详细讲解，现在安卓原生的逻辑已经写好了，api也已经写好，如何将两者结合起来，that is a trouble，but ，It's not trouble.不懂不懂(O_O)? ，下面就是嘿~

1 
 2 
 4     Integrity checking
 5     @funnyZpC
 6     Cordova Plugin for integrity checking
 7     Cordova,Integrity,Checking,Ecosystem:Cordova,Cordova-android
 8     MIT
 9     https://github.com/funnyZpC/cordova-plugin-integrity-checking
10     https://github.com/funnyZpC/cordova-plugin-integrity-checking/issues
11     
12         
13     
14     
15         
16     
17     
18     
19         
20             
21                 
22                 
23             
24         
25         
26         
27     
28 

以上，第一行需要明确定义插件的id，这个建议与外部的插件名一致(第一张图中的文件夹的名称)，14行中的路径需要参照api文件所在的相对路径填写，20行中定义的别名与api文件中的定义的调用别名一致，21行中的value值一定是上面java文件中最上面定义的package名+类名(这是个坑，我以前经常性写错，心伤~~~~(>_<)~~~~)，最后需要注意的是26行中的src的值是java文件的相对路径，还有target-dir也是相对路径(窃不要以为后面是包名，包也是文件夹((*￣^￣))，这些都不要写错，其他随意哈~<(*￣▽￣*)/，另外，如果开发的是一个比较复杂的插件，比如中间需要调用内存卡读写权限，你需要再定义一个config-file(与其他的config-file同级),具体如下(name的值是官方定义的，自行google)

1        
2             
3         

嗯~，貌似插件已近九成了~，下面该为命令准备一个package.json文件方便将插件添加到项目中：

请注意上图5~10行，其他地方随意哈~

以上两张图中，第一张图是在项目目录下打 "cordova plugin list"命令列出当前项目所用的所有的cordova插件，第二张图是在当前项目下将插件添加到项目中，只要不出现fail字样即插件添加成功，如果插件中需要添加变量，请在 命令后面 添加 “--veriable”(后面的英文单词是变量名)。。。。。。，添加成功，webstrom会自动刷新，这时候请看这里，看这里：

当前插件调用的方式是:

Cordova.apkValidate.getSHA1(function (successCallback) {

  //success logic~~~ },function (errorCallback) {

  //error logic~~~ })

你的项目有一个专门放置plugin的plugins的目录,目录下面有两个文件android.json和fetch.json,这两个文件里面都有插件的申明，以上三张图中第二和第三张，如没有请检查！，好了写了仨小时多该结束了\(^o^)/，顺便放两张图(构建平台后的文件)，读者自行思索，看有没有发现什么哈(∩_∩)