1. 准备工作
1.1 下载HBuilder离线打包Android版SDK( 5+SDK),并将其中的UniPlugin-Hello-AS工程导入AndroidStudio
1.2 在UniPlugin-Hello-AS工程中创建插件Module,并编辑Module的build.gradle文件使Module具备开发uni-app插件的能力
(1) 添加依赖库
- 注释默认的基础依赖库:Android Studio默认会在dependencies节点下添加一些基本依赖库,如下图红框内的引用注释掉 或 改为compileOnly依赖方式
注意
:libs文件夹下的jar文件已改为compileOnly方式引用了,故当离线工程调试时需要把插件中用到的jar文件在app工程的build.gradle中配置相应的jar文件implementation引入,否则导致应用闪退等问题。至于插件中用到的jar文件在打插件包时文件到底放在什么位置请留意插件打包文档。
- 新增以下引用(出现底色标红表示当前引用版本与compileSdkVersion版本不同,忽略即可)
compileOnly "com.android.support:recyclerview-v7:26.1.0"
compileOnly "com.android.support:support-v4:26.1.0"
compileOnly "com.android.support:appcompat-v7:26.1.0"
注意
:dependencies节点添加依赖库时需使用compileOnly依赖方式, 防止打包时与其他插件资源库冲突导致打包失败。
(2) 导入uniapp-release.aar
repositories {
flatDir {
dirs 'libs'
}
}
compileOnly fileTree(dir: '../app/libs', include: ['uniapp-release.aar'])
注意
:此处dir需根据具体工程目录配置,当前写法仅适用于UniPlugin-Hello-AS工程
2. 插件开发与配置
2.1 插件开发示例
package uni.liy.plugin.mytest;
import android.util.Log;
import android.widget.Toast;
import com.alibaba.fastjson.JSONObject;
import com.taobao.weex.WXSDKEngine;
import com.taobao.weex.annotation.JSMethod;
import com.taobao.weex.bridge.JSCallback;
import java.util.HashMap;
import java.util.Map;
public class MyTestWXModule extends WXSDKEngine.DestroyableModule {
private JSCallback myCallback;
@JSMethod(uiThread = true)
public void showToast(String msg){
Toast.makeText(mWXSDKInstance.getContext(),msg,Toast.LENGTH_SHORT).show();
}
@JSMethod(uiThread = true)
public void getResult(JSONObject options, JSCallback jsCallback){
myCallback = jsCallback;
Map<String,String> map = new HashMap<>();
try{
Object name = "yang";//默认姓名
Object sex = "man";//默认性别
name = options.get("name") == null ? name : options.get("name");
sex = options.get("sex") == null ? sex : options.get("sex");
Log.d("liyliyliy", name.toString() + "," + sex.toString());
map.put("success","true");
map.put("姓名",name.toString());
map.put("性别",sex.toString());
myCallback.invoke(map);
}catch (Exception e){
map.put("fail:",e.getMessage());
map.put("姓名","");
map.put("性别","");
myCallback.invoke(map);
}
}
@Override
public void destroy() {
}
}
备注:该插件源码中使用到了json解析,故需在插件Module的build.gradle文件中添加相应的依赖库 implementation 'com.alibaba:fastjson:1.2.59'
apply plugin: 'com.android.library'
android {
compileSdkVersion 28
defaultConfig {
minSdkVersion 16
targetSdkVersion 28
versionCode 1
versionName "1.0"
testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
}
repositories {
flatDir {
dirs 'libs'
}
}
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
compileOnly fileTree(dir: '../app/libs', include: ['uniapp-release.aar'])
/*implementation 'com.android.support:appcompat-v7:28.0.0'
testImplementation 'junit:junit:4.12'
androidTestImplementation 'com.android.support.test:runner:1.0.2'
androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'*/
compileOnly "com.android.support:recyclerview-v7:26.1.0"
compileOnly "com.android.support:support-v4:26.1.0"
compileOnly "com.android.support:appcompat-v7:26.1.0"
implementation 'com.alibaba:fastjson:1.2.59'
}
2.2 插件配置(本地注册)
编辑UniPlugin-Hello-AS工程下 “app” Module根目录assets/dcloud_uniplugins.json文件,在nativePlugins节点下进行注册
{
"nativePlugins": [
{
"hooksClass": "",
"plugins": [
{
"type": "module",
"name": "My-Test",
"class": "uni.liy.plugin.mytest.MyTestWXModule"
}
]
}
]
}
3. 插件打包与使用
3.1 插件打包
(1) 编译生成module的aar文件:选择Gradle—>插件module—>Tasks—>build—>assembleRelease(双击运行生成module的aar文件)
(2) 将编译依赖库文件或仓储代码放入libs目录下或配置到package.json中
(3) 在package.json填写必要的信息
完整的android 插件包:一级目录以插件id命名,对应package.json中的id字段;一级目录下存放android文件夹和package.json文件
- android文件: 里面存放
.aar
文件 (插件包)、libs
文件夹(存放插件包依赖的第三方 .jar文件和.so文件)- package.json:插件信息
3.2 uniapp中使用原生插件
(1) uniapp项目中配置本地插件
将插件包放到uniapp项目nativeplugins目录下(无该目录则创建),然后在manifest.json中配置App本地插件
(2) uniapp中调用插件示例
test1:function(){
const myTest = uni.requireNativePlugin('My-Test');
myTest.showToast("插件测试Toast提醒");
},
test2:function(){
const myTest = uni.requireNativePlugin('My-Test');
var options = {
name:"liy",
sex:"woman"
};
myTest.getResult(options, res => {//options为参数,res为回调结果
console.log("获取结果:" + JSON.stringify(res));
});
}
本文链接地址: uniapp安卓原生插件开发