我家小花儿

这个屌丝很懒，什么也没留下！

热门标签

ionic + cordova 插件创建最详细教程_ionic 中的fileservice 是原生方法m

作者：我家小花儿 | 2024-06-23 06:07:10

踩

ionic 中的fileservice 是原生方法m

l 介绍

本文将细致讲解cordova插件的创建、编写、配置、发布，涉及aar+jar+so、静态资源、四大组件等。

l 环境准备

1.node

2.ionic

3.cordova

4.plugman

plugman是用于安装和卸载用于Apache Cordova项目的插件的命令行工具, 安装plugman

$ npm install -g plugman
复制代码1
2

5.AndroidStudio

l 一切都要从一个简单cordova插件开始

l 创建ionic项目

用于测试cordova的插件

ionic start CordovaProject blank
复制代码1
2

此时cordovaProject下会生成如下结构

在添加platforms和plugins之后，可以在此目录下打包

CordovaProject$ cordova build android
复制代码1
2

l 创建插件

创建一个最简单的Toast插件

plugins$ plugman create --name ThsToast --plugin_id cordova-plugin-ths-toast --plugin_version 1.0.0
复制代码1
2

创建插件的完整模版：为了方便在插件开发过程中进行测试，将插件创建在 cordovaPluginProject 项目目录下的 plugins 文件夹下

plugman platform add 创建ThsToast插件的平台基础代码

进入具体的插件目录下，创建插件安卓和iOS平台基础代码

cordova-plugin-ths-toast$ plugman platform add --platform_name android
cordova-plugin-ths-toast$ plugman platform add --platform_name ios
复制代码1
2
3

添加之后将在cordova-plugin-ths-toast目录下产生android和ios两个目录, 生成的java文件内容如图所示

重命名ThsToast插件目录名称（可选）

接着手动将ThsToast目录重命名为和上述plugin_id一样的值：cordova-plugin-ths-toast，命名方式和cordova插件命名规范保持一致，ths是公司的统一标识，通常是英文字符串

重命名ThsToast插件目录下android目录java代码中的package包名和api方法名

需要将默认的包名改为[反向域值].cordova.[插件name]，要注意的是，plugin.xml中配置的java文件target-dir输出目录需要和这里包名目录匹配，如 plugin.xml

<source-file src="src/android/ThsToast.java" target-dir="src/org/apache/cordova/thstoast" />
复制代码1
2

注意：起名不要和安卓原生方法冲突了，比如这里ThsToast如果改成Toast，就会和android.widget.Toast中的Toast类重名，主要是区分是系统的还是公司的插件

l 插件配置

ThsToast插件目录下的plugin.xml配置js调用方法名和资源文件输出路径

添加完平台后，cordova-plugin-ths-toast 目录下的 plugin.xml 文件将添加如下内容修改 plugin.xml 文件内容如下

<?xml version='1.0' encoding='utf-8'?>
<plugin id="cordova-plugin-ths-toast" version="1.0.0" xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android">
    <name>Toast</name>
    <js-module name="ThsToast" src="www/ThsToast.js">
        <!-- target修改, 通过window.ThsToast.show或ThsToast.show即可调用api -->
        <clobbers target="ThsToast" />
    </js-module>
<span class="hljs-tag">&lt;<span class="hljs-name">platform</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"android"</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">config-file</span> <span class="hljs-attr">parent</span>=<span class="hljs-string">"/*"</span> <span class="hljs-attr">target</span>=<span class="hljs-string">"res/xml/config.xml"</span>&gt;</span>
        <span class="hljs-tag">&lt;<span class="hljs-name">feature</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"ThsToast"</span>&gt;</span>
        <span class="hljs-comment">&lt;!-- param value修改，[包名].[文件名] --&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">param</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"android-package"</span> <span class="hljs-attr">value</span>=<span class="hljs-string">"cn.com.ths.thstoast.ThsToast"</span> /&gt;</span>
        <span class="hljs-tag">&lt;/<span class="hljs-name">feature</span>&gt;</span>
    <span class="hljs-tag">&lt;/<span class="hljs-name">config-file</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">config-file</span> <span class="hljs-attr">parent</span>=<span class="hljs-string">"/*"</span> <span class="hljs-attr">target</span>=<span class="hljs-string">"AndroidManifest.xml"</span> /&gt;</span>
    <span class="hljs-comment">&lt;!-- target-dir修改，最终打包出的java文件完整目录路径 --&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">source-file</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"src/android/ThsToast.java"</span> <span class="hljs-attr">target-dir</span>=<span class="hljs-string">"src/cn/com/ths/thstoast"</span> /&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">platform</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">platform</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"ios"</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">config-file</span> <span class="hljs-attr">parent</span>=<span class="hljs-string">"/*"</span> <span class="hljs-attr">target</span>=<span class="hljs-string">"config.xml"</span>&gt;</span>
        <span class="hljs-tag">&lt;<span class="hljs-name">feature</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"ThsToast"</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">param</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"ios-package"</span> <span class="hljs-attr">value</span>=<span class="hljs-string">"ThsToast"</span> /&gt;</span>
        <span class="hljs-tag">&lt;/<span class="hljs-name">feature</span>&gt;</span>
    <span class="hljs-tag">&lt;/<span class="hljs-name">config-file</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">source-file</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"src/ios/ThsToast.m"</span> /&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">platform</span>&gt;</span>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1
2
3
4
5
6
7
8

</plugin>
复制代码

ThsToast插件目录下的www/xxx.js 修改js api对象和调用函数

修改exports处理逻辑，增强可读性（可选)

暴露给js的api方法名通过plugin.xml配置

www/xxx.js中export的ThsToast在plugin.xml中是通过clobbers的target值暴露给js调用的，如果target值改为toast，通过target.show即可调用插件api

<js-module name="ThsToast" src="www/ThsToast.js">
    <!-- 通过window.ThsToast.show或ThsToast.show即可调用api -->
    <clobbers target="ThsToast" />
</js-module>
复制代码1
2
3
4
5

exec函数干了什么

www/xxx.js中的exec函数可以理解为java中暴露给js的回调方法，用于触发java的excute方法，该js函数传的'show'和[arg0]，success,error参数将会以action和args，callbackContext.success，callbackContext.error参数的形式传入java中的excute方法

@Override
    public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
        ……
    }
复制代码1
2
3
4
5

l 在ThsToast插件根目录里写好README，小盆友看了也会用

cordova-plugin-ths-toast$ touch README.md
复制代码1
2

一个简单模版

# cordova-plugin-ths-toast
弹出提示框 cordova插件
## 支持平台
1
2
3
4

Android

## 安装插件

|```

通过npm 安装插件

cordova plugin add cordova-plugin-ths-toast

通过github安装

cordova plugin add https://github.com/THS-FE/cordova-plugin-ths-toast

通过本地文件路径安装

cordova plugin add 文件路径
|```
说明： ionic 项目命令前加上ionic，即ionic cordova plugin xxxxx

参数说明：

1. DEFAULT_DELAY 默认提示框延迟弹出的毫秒数

配置文件修改

在config.xml文件中 platform name=“android” 节点下添加以下配置

|xml <preference name="DEFAULT_DELAY" value="1000"/> |

使用方法

显示提示框

|```javascript
/**

显示提示框
@param text 显示文字
@param success 成功的回调函数
*/
showToast(text, success) {
try {
ThsToast.show(text, success, err => {
console.log(‘err’, err);
this.commUtilProvider.showToast(‘显示提示框失败’);
})
}
catch (err) {
console.log(err);
}
};
|```

隐藏提示框

|```javascript
/**

隐藏提示框
@param success 成功的回调函数
*/
hideToast(success) {
try {
ThsToast.hide(success, err => {
console.log(‘err’, err);
this.commUtilProvider.showToast(‘隐藏提示框失败’);
})
}
catch (err) {
console.log(err);
}
};
|```

说明：使用ts 进行开发时，需要在文件上变声明下declare const ThsToast;

|typescript import { Component, OnInit, Input } from '@angular/core'; declare const ThsToast; @Component({ selector: 'app-explore-container', templateUrl: './explore-container.component.html', styleUrls: ['./explore-container.component.scss'], }) |

常见错误

后续更新
|```
复制代码

l 给ThsToast插件加上package.json，准备发布到npm

进入ThsToast插件根目录下

第一种方式：npm init

cordova-plugin-ths-toast$ npm init
复制代码1
2

第二种方式：plugman createpackagejson（推荐）

cordova-plugin-ths-toast$ plugman createpackagejson ./
复制代码1
2

上面的命令都将创建一个 package.json 文件，但第二种方式相对于npm init的优点是会生成"cordova"和"keywords"两个属性。

"cordova"用于说明插件支持的平台，"keywords" 规定可以在cordova官网通过关键字搜索到该cordova插件，"engines"表示插件依赖的各平台版本号，详细内容请参考cordova创建插件

{
  "name": "cordova-plugin-ths-toast",
  "version": "1.0.0",
  "description": "",
  "cordova": {
    "id": "cordova-plugin-ths-toast",
    "platforms": [
      "android",
      "ios"
    ]
  },
  "keywords": [
    "ecosystem:cordova",
    "cordova-android",
    "cordova-ios",
    "toast",
    "cordova-plugin-ths-toast"
  ],
  engines: {
    cordovaDependencies: {
        "1.0.0":  { "cordova-android": ">4.0.0" },
        ">1.0.0": { "cordova-android": ">5.0.0" }
    }
  },
  "author": "",
  "license": "ISC"
}
复制代码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

注意：** "name"属性表示插件在npm仓库中的唯一id，"cordova"中的"id"必须和name保持一致，因为要通过此id才能找到具体哪个插件的平台支持**，比如安装时就是通过name的值在npm仓库中查找对应插件并安装：

cordova plugin add cordova-plugin-ths-toast
复制代码1
2

这里可以搜索keywords中的插件

l 发布插件到git

上传到公司仓库: github.com/THS-FE

注意github地址一定要发布到公司git仓库，不然无法修改和维护源代码

l 发布插件到npm

每次发布记得更新版本号，不然无法发布

cordova-plugin-ths-toast$ npm login // 没有账号则需要到官网申请，登录过一次后就不用登了
cordova-plugin-ths-toast$ npm publish
复制代码1
2
3

l 安装插件

cordova plugin add cordova-plugin-ths-toast
复制代码1
2

l 使用插件

js环境

ThsToast.show()
复制代码1
2

ts环境

declare const ThsToast;
ThsToast.show()
复制代码1
2
3

l 插件效果演示

l cordova开发进阶

l 开发进阶之插件配置

活动

<platform name="android">
    <config-file target="AndroidManifest.xml" parent="/manifest/application">
		<activity android:name="cn.com.ths.thstoast.MyActivity"/>
    </config-file>
</platform>
复制代码1
2
3
4
5
6

广播

静态注册

<platform name="android">
    <!-- 自定义的广播接收器 -->
    <receiver android:name="cn.com.ths.thstoast.MyBroadcastReceiver" android:enabled="true">
        <intent-filter>
            <!-- 飞行模式开/关广播 -->
            <action android:name="android.intent.action.AIRPLANE_MODE" />
            <category android:name="$PACKAGE_NAME" />
        </intent-filter>
    </receiver>
</platform>
复制代码1
2
3
4
5
6
7
8
9
10
11

服务

<platform name="android">
   <service
        android:name="cn.com.ths.thstoast.MyService"
        android:enabled="true"
        android:exported="true" />
</platform>
复制代码1
2
3
4
5
6
7

内容提供者

<platform name="android">
    <!-- 访问其他应用的内容需要配置应用读写权限 -->
    <uses-permission android:name="android.permission.READ_CALENDAR"/>
    <uses-permission android:name="android.permission.WRITE_CALENDAR"/>
<span class="hljs-comment">&lt;!-- 如果不是上面Calendar这种系统provider(android.provider.*)，则需要注册 --&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">provider</span>
    <span class="hljs-attr">android:name</span>=<span class="hljs-string">"org.apache.cordova.provider.TestContentProvider"</span>
    <span class="hljs-attr">android:authorities</span>=<span class="hljs-string">"org.apache.cordova.provider.testprovider"</span>
    <span class="hljs-attr">android:exported</span>=<span class="hljs-string">"false"</span> /&gt;</span>
1
2
3
4
5
1
2
3
4
5

</platform>
复制代码

jar+aar+so配置

jar配置

<platform name="android">
    <lib-file src="src/android/libs/jpush-android-3.0.1.jar" />
</platform>    
复制代码1
2
3
4

so配置

so 路径

so是在NDK平台开发的，NDK是用来给安卓手机开发软件用的，但是和SDK不同的是它用的是C语言，而SDK用的是Java语言。NDK开发的软件在安卓的环境里是直接运行的，一般只能在特定的CPU指令集的机器上运行。

so配置通常配置在libs目录下

so plugin.xml配置，注意输出路径子目录也要改

<source-file src="src/android/libs/armeabi/libjcore110.so" target-dir="libs/armeabi" />
    <source-file src="src/android/libs/armeabi-v7a/libjcore110.so" target-dir="libs/armeabi-v7a" />
    <source-file src="src/android/libs/arm64-v8a/libjcore110.so" target-dir="libs/arm64-v8a" />
    <source-file src="src/android/libs/x86/libjcore110.so" target-dir="libs/x86" />
    <source-file src="src/android/libs/x86_64/libjcore110.so" target-dir="libs/x86_64" />
</source-file>        
复制代码1
2
3
4
5
6
7

aar配置

aar文件配置

aar和jar类似，但是他包含了所有资源，class以及res资源文件，aar和gradle通常放在libs下

gradle配置

gradle中要在repositories中配置flatDir，dependencies中配置compile的aar包

repositories{
    jcenter()
    flatDir{
        dirs 'libs'
    }
}
1
2
3
4
5
6
7

dependencies {
compile ‘com.android.support:appcompat-v7:23.1.0’
compile(name:‘ijkplayer-java-debug’, ext:‘aar’)
compile(name:‘giraffeplayer-debug’, ext:‘aar’)
}
复制代码

aar plugin.xml

 <platform name="android">
    <framework src="src/android/libs/giraffeplayer-build.gradle" custom="true" type="gradleReference" />
    <resource-file src="src/android/libs/giraffeplayer-debug.aar" target="libs/giraffeplayer-debug.aar" />
    <resource-file src="src/android/libs/ijkplayer-java-debug.aar" target="libs/ijkplayer-java-debug.aar" />
</platform>    
复制代码1
2
3
4
5
6

静态资源和java文件

静态资源路径

静态资源规定放在src/android/res目录下

静态资源输出目录配置通过resource-file和source-file配置当前路径和输出路径，静态资源默认路径是src/android/res/xxx, 输出路径是res/xxx

<platform name="android">
        <source-file src="src/android/res/drawable-hdpi/jpush_richpush_btn_selector.xml" target-dir="res/drawable" />
        <source-file src="src/android/res/drawable-hdpi/jpush_richpush_progressbar.xml" target-dir="res/drawable" />
    <span class="hljs-tag">&lt;<span class="hljs-name">source-file</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"src/android/res/drawable-hdpi/jpush_ic_richpush_actionbar_back.png"</span> <span class="hljs-attr">target-dir</span>=<span class="hljs-string">"res/drawable-hdpi"</span> /&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">source-file</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"src/android/res/drawable-hdpi/jpush_ic_richpush_actionbar_divider.png"</span> <span class="hljs-attr">target-dir</span>=<span class="hljs-string">"res/drawable-hdpi"</span> /&gt;</span>

    <span class="hljs-tag">&lt;<span class="hljs-name">source-file</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"src/android/res/layout/jpush_popwin_layout.xml"</span> <span class="hljs-attr">target-dir</span>=<span class="hljs-string">"res/layout"</span> /&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">source-file</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"src/android/res/layout/jpush_webview_layout.xml"</span> <span class="hljs-attr">target-dir</span>=<span class="hljs-string">"res/layout"</span> /&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">source-file</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"src/android/res/layout/test_notification_layout.xml"</span> <span class="hljs-attr">target-dir</span>=<span class="hljs-string">"res/layout"</span> /&gt;</span>

    <span class="hljs-tag">&lt;<span class="hljs-name">source-file</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"src/android/res/values/jpush_style.xml"</span> <span class="hljs-attr">target-dir</span>=<span class="hljs-string">"res/values"</span> /&gt;</span>
1
2
3
4
5
6
7
8
1
2
3
4

</platform>
复制代码

java文件路径

java文件通常放在src/android目录下

java文件输出目录配置默认路径是src/android/Xxx.java 输出目录是src/包/名/字/，注意target-dir是目录路径，target才是文件路径。

<platform name="android">
    <source-file src="src/android/MyReceiver.java" target-dir="src/cn/jpush/phonegap" />
    <source-file src="src/android/JPushPlugin.java" target-dir="src/cn/jpush/phonegap" />
</platform>
复制代码1
2
3
4
5

meta-data

拿一个分享插件举例做示范

plugin.xml：配置preference，用于接收用户传参variable的值，config-file中配置meta-data, 保存参数键值信息用于给java类调用。

    <preference name="WEIXIN_APP_ID" />
<span class="hljs-tag">&lt;<span class="hljs-name">platform</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"android"</span>&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">preference</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"WEIXIN_APP_ID"</span> <span class="hljs-attr">value</span>=<span class="hljs-string">"WEIXIN_APP_ID"</span> /&gt;</span>

    <span class="hljs-comment">&lt;!-- 友盟 AK --&gt;</span>
    <span class="hljs-tag">&lt;<span class="hljs-name">meta-data</span>
        <span class="hljs-attr">android:name</span>=<span class="hljs-string">"WEIXIN_APP_ID"</span>
        <span class="hljs-attr">android:value</span>=<span class="hljs-string">"WEIXIN_APP_ID"</span> &gt;</span>
    <span class="hljs-tag">&lt;/<span class="hljs-name">meta-data</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">platform</span>&gt;</span>    
1
2
3
4
5
6
7
8
9
1
2

复制代码

权限

当需要使用系统的某个功能时，一定要加上权限询问配置，所有的权限在这查看

<platform name="android">
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
</platform>
复制代码1
2
3
4
5
6
7
8
9
10
11
12

l 开发进阶之插件实现

开启活动

简单来说，活动相当于angular的page，vue的vue，是一个可包含组件（fragment）的ui页面。

开启普通活动

// 应用上下文
Context context = cordova.getActivity().getApplicationContext();
String pkgName  = context.getPackageName();
1
2
3
4

// 打开app应用
Intent intent = context
.getPackageManager()
.getLaunchIntentForPackage(pkgName);

// 打开XxxActivity
// Intent intent=new Intent(cordova.getActivity(), XxxActivity.class);

// 打开应用必须要加 CATEGORY_LAUNCHER
intent.addCategory(Intent.CATEGORY_LAUNCHER);

intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK | Intent.FLAG_ACTIVITY_SINGLE_TOP);

// 启动应用
context.startActivity(intent);

// 启动活动
// cordova.getActivity().startActivity(intent);

// 启动有返回值的活动
// cordova.startActivityForResult((CordovaPlugin) this, intent, 0);
复制代码

本插件中开启活动代码

public class ThsToast extends CordovaPlugin {
    private static final String TAG = "ThsToast";
    @Override
    public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
        Log.d(TAG, "start execute!");
    <span class="hljs-comment">// 启动活动</span>
    <span class="hljs-type">Intent</span> <span class="hljs-variable">intent</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">Intent</span>(cordova.getActivity(), MyActivity.class);
    cordova.getActivity().startActivity(intent);
}
1
2
3
4
1
2
3
4
5
6

}
复制代码

启动活动演示：

打开第三方Android SDK活动如:百度地图uri

// 如果有百度地图 uri详情：http://lbsyun.baidu.com/index.php?title=uri/api/android
Intent intent = Intent.parseUri("intent://map/direction?"
                        + "origin="+options.getOrigin4Baidu()
                        + "&destination="+options.getDestination4Baidu()
                        + "&mode="+options.getModel4Baidu()
                        + "&coord_type=wgs84&referer=Autohome|GasStation#Intent;scheme=bdapp;package=com.baidu.BaiduMap;end",0);
1
2
3
4
5
6
7

cordova.getActivity().startActivity(intent);
复制代码

使用广播

广播其实就是一个在app范围内的事件推送和接受中心，类似于iframe的postMessage。

在cordova项目中使用和原生广播没有区别，一般静态广播用在插件比较多，如果是动态广播，则需要在activity中通过registerReceiver注册

public class ThsToast extends CordovaPlugin {
    private static final String TAG = "ThsToast";
    @Override
    public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
        Log.d(TAG, "start execute!");
   <span class="hljs-comment">// 动态注册广播：</span>
    <span class="hljs-type">MyBroadcastReceiver</span> <span class="hljs-variable">myReceiver</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">MyBroadcastReceiver</span>();
    <span class="hljs-type">IntentFilter</span> <span class="hljs-variable">itFilter</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">IntentFilter</span>();
    itFilter.addAction(<span class="hljs-string">"android.intent.action.AIRPLANE_MODE"</span>);
    cordova.getContext().registerReceiver(myReceiver, itFilter);
}
1
2
3
4
5
6
1
2
3
4
5
6

}
复制代码

android/MyBroadcastReceiver.java

public class MyBroadcastReceiver extends BroadcastReceiver {
     private String ACTION_BOOT = "android.intent.action.AIRPLANE_MODE";
<span class="hljs-meta">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">onReceive</span><span class="hljs-params">(Context context, Intent intent)</span> {
    <span class="hljs-type">String</span> <span class="hljs-variable">action</span> <span class="hljs-operator">=</span> intent.getAction();
    <span class="hljs-keyword">if</span> (ACTION_BOOT.equals(action)) {
        Toast.makeText(context, <span class="hljs-string">"切换飞行模式！"</span>, Toast.LENGTH_SHORT).show();
    }
}
1
2
3
4
5
6
7
1
2
3

}
复制代码

广播效果演示：

使用服务

服务可以同步或执行一些小任务、小进程，甚至对其他进程的ui页面做操作，可类比angular的service服务。

和原生Service一样的用法

public class ThsToast extends CordovaPlugin {
    private static final String TAG = "ThsToast";
    @Override
    public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
        Log.d(TAG, "start execute!");
   <span class="hljs-comment">// 启动服务</span>
    cordova.getContext().startService(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Intent</span>(cordova.getActivity(), MyService.class));
}
1
2
3
1
2
3
4
5
6

}
复制代码

使用内容提供者

内容提供者其实是一个手机系统范围的API调度中心，比如可以读取和修改通讯录和相册的内容。

使用jar+aar+so

使用jar

jar包可以理解为api的集合，解压后全部是编译好的class，但是不包含资源文件，可以直接使用使用其中的类。 jar包路径通常位于libs目录下查看依赖的api源文件

使用so

通常在jar中使用

使用aar

例如跳转activity

使用meta-data

保存用户添加插件时传入的参数键值对象

meta-data 在java中获取参数对象

Plugin.java：通过cordova.getActivity().getPackageManager().getApplicationInfo(cordova.getActivity().getPackageName(), PackageManager.GET_META_DATA)获取参数存储的对象appInfo，再通过appInfo.metaData.getType(key)取得参数value，getType有getString、getInt……

meta-data 如何传参

传入插件参数有两种办法，

1.用cordova 安装时利用--variable key=value 传入

cordova plugin add cordova-plugin-share --variable WEIXIN_APP_ID=xxx --variable WEIXIN_APP_SECRET=xxx 
复制代码1
2

2.添加插件完成后，在项目的config.xml中手动添加，cordova build后生效

<plugin name="cordova-plugin-share" spec="1.0.0">
    <variable name="WEIXIN_APP_ID" value="xxx" />
    <!--...-->
</plugin>
复制代码1
2
3
4
5

使用权限

    import android.Manifest;
<span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-type">String</span> <span class="hljs-variable">WRITE</span> <span class="hljs-operator">=</span> Manifest.permission.WRITE_EXTERNAL_STORAGE;
<span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-type">String</span> <span class="hljs-variable">READ</span> <span class="hljs-operator">=</span> Manifest.permission.READ_EXTERNAL_STORAGE;
<span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-type">int</span> <span class="hljs-variable">REQ_CODE</span> <span class="hljs-operator">=</span> <span class="hljs-number">0</span>;

<span class="hljs-meta">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-type">boolean</span> <span class="hljs-title function_">execute</span><span class="hljs-params">(String action, JSONArray args, CallbackContext callbackContext)</span> <span class="hljs-keyword">throws</span> JSONException {
    <span class="hljs-keyword">if</span> (action.equals(<span class="hljs-string">"show"</span>)) {
        <span class="hljs-built_in">this</span>.args = args;
        <span class="hljs-built_in">this</span>.callbackContext = callbackContext;

        <span class="hljs-keyword">if</span> (cordova.hasPermission(READ) &amp;&amp; cordova.hasPermission(WRITE)) {
            <span class="hljs-comment">// 有权限则跳转活动</span>
            <span class="hljs-built_in">this</span>.launchActivity();
        } <span class="hljs-keyword">else</span> {
            <span class="hljs-comment">// 若没有权限则请求</span>
            <span class="hljs-built_in">this</span>.getPermission();
        }
        <span class="hljs-keyword">return</span> <span class="hljs-literal">true</span>;
    }
    <span class="hljs-keyword">return</span> <span class="hljs-literal">false</span>;
}

<span class="hljs-comment">/**
* 请求权限
**/</span>
<span class="hljs-keyword">protected</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">getPermission</span><span class="hljs-params">()</span> {
    cordova.requestPermissions(<span class="hljs-built_in">this</span>, REQ_CODE, <span class="hljs-keyword">new</span> <span class="hljs-title class_">String</span>[]{WRITE, READ});
}

<span class="hljs-meta">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">onRequestPermissionResult</span><span class="hljs-params">(<span class="hljs-type">int</span> requestCode, String[] permissions,
                                      <span class="hljs-type">int</span>[] grantResults)</span> <span class="hljs-keyword">throws</span> JSONException {
    <span class="hljs-keyword">for</span> (<span class="hljs-type">int</span> r : grantResults) {
        <span class="hljs-keyword">if</span> (r == PackageManager.PERMISSION_DENIED) {
            <span class="hljs-built_in">this</span>.callbackContext.sendPluginResult(<span class="hljs-keyword">new</span> <span class="hljs-title class_">PluginResult</span>(PluginResult.Status.ERROR, PERMISSION_DENIED_ERROR));
            <span class="hljs-keyword">return</span>;
        }
    }

    <span class="hljs-keyword">switch</span> (requestCode) {
        <span class="hljs-keyword">case</span> REQ_CODE:
            launchActivity();
            <span class="hljs-keyword">break</span>;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
1
2

复制代码

使用生命周期和常用钩子

excute：执行插件方法

调用插件执行方法。第一个参数action是调用的方法名，第二个参数args是传入的参数数组，第三个参数CallbackContext是传入的回调函数上下文，可以通过callbackContext.success(message)和callbackContext.error(errorMessage)传入回调参数;

@Override
public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
}
复制代码1
2
3
4

initialize：初始化

在插件构造函数执行和字段初始化之后调用，此时尚未执行excute方法。

@Override
public void initialize (CordovaInterface cordova, CordovaWebView webView) {}
复制代码1
2
3

pluginInitialize：无参初始化

在插件构造函数执行和字段初始化之后调用，没有参数，此时尚未执行excute方法，pluginInitialize 不支持 cordova 3.0-3.5 。

@Override
protected void pluginInitialize() {}
复制代码1
2
3

插件初始化到执行的过程执行顺序如下，依次是initialize、pluginInitialize、execute：

2020-09-03 00:20:34.928 19307-19435/com.ths.exam.lilin D/ThsToast: start initialize!
2020-09-03 00:20:34.928 19307-19435/com.ths.exam.lilin D/ThsToast: start pluginInitialize!
2020-09-03 00:20:34.929 19307-19435/com.ths.exam.lilin D/ThsToast: start execute!
复制代码1
2
3
4

onStart：活动开始周期

活动正在被启动，已经可见，但是还没位于前台。

@Override
public void onStart() {}
复制代码1
2
3

onResume：活动恢复周期

活动位于前台，并且可以与用户交互了。

/**
 * 当活动将开始与用户互动时调用。
 *
 * @param multitasking 表示是否为应用程序打开了多任务
 */
@Override
public void onResume(boolean multitasking) {
    super.onResume(multitasking);
    // deviceready();
}
复制代码1
2
3
4
5
6
7
8
9
10
11

onPause：活动暂停周期

活动处于正在停止的状态，通常当要离开这活动的时候会被调用。接下去onStop()马上会被调用，如果是弹出一个对话框，那么onStop不会被调用。

/**
 * 在系统即将开始恢复上一个活动时调用
 *
 * @param multitasking 表示是否为应用程序打开了多任务
 */
@Override
public void onPause(boolean multitasking) {
    super.onPause(multitasking);
}
复制代码1
2
3
4
5
6
7
8
9
10

onStop：活动停止周期

活动即将停止，活动完全不可见。

/**
 * 活动停止前调用
 */
@Override
public void onStop() {
    super.onStop();
}
复制代码1
2
3
4
5
6
7
8

onReset：活动重置周期

这个方法表示活动正在重新启动，活动由停止状态恢复为运行状态，通常由上一个活动返回到这个活动时，这个活动会调用此方法。

/**
 * 当视图导航时调用
 */
@Override
public void onReset() {}
复制代码1
2
3
4
5
6

onActivityResult：返回活动数据

当从另一个活动返回到当前活动时，当前活动中的onActivityResult可接收刚才活动的返回数据。

@Override
public void onActivityResult(int requestCode, int resultCode, Intent intent) {
    super.onActivityResult(requestCode, resultCode, intent);
}
复制代码1
2
3
4
5

onDestroy：活动销毁周期

活动完全销毁前调用，可以在这做一些资源释放的操作。

/**
 * 活动销毁前调用
 */
@Override
public void onDestroy() {
    // deviceready = false;
}
复制代码1
2
3
4
5
6
7
8

l 总结

本文从创建一个简单的cordova自定义插件，到四大组件的配置和使用，以及如何导入和使用jar、aar、so、静态资源方面做了详细讲解，最后归纳了常用的生命周期和回调方法。看到这，我们应该已经具备独立创建和改写插件的基本能力，剩下的就只有自己多看多用cordova-plugin，实践出真知，若有总结不到位或者遗漏的地方，还请各位朋友多多指出，共同交流完善！如果这篇文章对前端或其他方向的你有所帮助或者启发，记得点个赞哦亲：）

下载文中演示的插件

cordova plugin add cordova-plugin-ths-toast

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/我家小花儿/article/detail/748911

ionic + cordova 插件创建 最详细教程_ionic 中的fileservice 是原生方法m

l 介绍

l 环境准备

l 一切都要从一个简单cordova插件开始

l 创建ionic项目

l 创建插件

创建一个最简单的Toast插件

plugman platform add 创建ThsToast插件的平台基础代码

重命名ThsToast插件目录名称（可选）

重命名ThsToast插件目录下android目录java代码中的package包名和api方法名

l 插件配置

ThsToast插件目录下的plugin.xml配置js调用方法名和资源文件输出路径

ThsToast插件目录下的www/xxx.js 修改js api对象和调用函数

修改exports处理逻辑，增强可读性（可选)

暴露给js的api方法名通过plugin.xml配置

exec函数干了什么

l 在ThsToast插件根目录里写好README，小盆友看了也会用

通过npm 安装插件

通过github安装

通过本地文件路径安装

配置文件修改

使用方法

常见错误

l 给ThsToast插件加上package.json，准备发布到npm

l 发布插件到git

l 发布插件到npm

l 安装插件

l 使用插件

l 插件效果演示

l cordova开发进阶

l 开发进阶之插件配置

活动

广播

服务

内容提供者

jar+aar+so配置

jar配置

so配置

so 路径

so plugin.xml配置，注意输出路径子目录也要改

aar配置

aar文件配置

gradle配置

aar plugin.xml

静态资源和java文件

静态资源路径

静态资源输出目录配置 通过resource-file和source-file配置当前路径和输出路径，静态资源默认路径是src/android/res/xxx, 输出路径是res/xxx

java文件路径

java文件输出目录配置 默认路径是src/android/Xxx.java 输出目录是src/包/名/字/，注意target-dir是目录路径，target才是文件路径。

meta-data

权限

l 开发进阶之插件实现

开启活动

开启普通活动

打开第三方Android SDK活动 如:百度地图uri

使用广播

使用服务

使用内容提供者

使用jar+aar+so

使用jar

使用so

使用aar

使用meta-data

meta-data 在java中获取参数对象

meta-data 如何传参

使用权限

使用生命周期和常用钩子

excute：执行插件方法

initialize：初始化

pluginInitialize：无参初始化

onStart：活动开始周期

onResume：活动恢复周期

onPause：活动暂停周期

onStop：活动停止周期

onReset：活动重置周期

onActivityResult：返回活动数据

onDestroy：活动销毁周期

l 总结

ionic + cordova 插件创建最详细教程_ionic 中的fileservice 是原生方法m

静态资源输出目录配置通过resource-file和source-file配置当前路径和输出路径，静态资源默认路径是src/android/res/xxx, 输出路径是res/xxx

java文件输出目录配置默认路径是src/android/Xxx.java 输出目录是src/包/名/字/，注意target-dir是目录路径，target才是文件路径。

打开第三方Android SDK活动如:百度地图uri