uniapp Android 原生插件开发（Module 扩展为例·2022）（一）

2023-02-12 1000

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： uniapp Android 原生插件开发（Module 扩展为例·2022）

前言

本文只介绍uniapp原生插件开发流程，Android studio（后面称编辑器）以及 java 环境的安装请自行查找相关文档解决；阅读本文者须具备基本的java、android以及uniapp相关知识及开发能力。

准备

SDK 文件

下载

首先下载uniapp原生插件开发SDK，下载地址见App离线SDK下载

解压

解压后相关文件如下图，我们只需要用到里面的示例工程UniPlugin-Hello-AS来进行插件开发就好

示例工程导入

打开Android Studio，新建工程导入

选择UniPlugin-Hello-AS项目，点击OK完成工程导入

插件开发

Module 创建

选择新建 Module

Module 类型选择

选择Android Library，然后下一步

Module 信息配置

配置模块名以及模块最低支持的Android SDK版本等信息，然后点击Finish完成Module创建。

文件配置

build.gradle文件打开

将编辑器文件视图切换到Project，选择我们刚创建的Module目录，然后打开其根目录下的build.gradle文件

build.gradle文件配置

加入以下配置，dependencies里面的初始配置可以删除或注释掉，然后点击同步

//导入aar需要的配置
repositories {
    flatDir {
        dirs 'libs'
    }
}
dependencies {
    //必须添加的依赖
    compileOnly 'androidx.recyclerview:recyclerview:1.0.0'
    compileOnly 'androidx.legacy:legacy-support-v4:1.0.0'
    compileOnly 'androidx.appcompat:appcompat:1.0.0'
    compileOnly 'com.alibaba:fastjson:1.1.46.android'
    compileOnly fileTree(include: ['uniapp-v8-release.aar'], dir: '../app/libs')
}

配置混淆文件

打开Module根目录下的proguard-rules.pro文件，在最后一行末尾加入以下代码

-keep public class * extends io.dcloud.feature.uniapp.common.UniModule{*;}

创建Module类

新建类文件

在Module的项目文件夹下创建Module类test

继承UniModule 类

uniapp的Module扩展必须继承UniModule类

功能开发

方法定义

定义一个sayHi方法，传入姓名时自动返回Hi + 姓名；编写扩展方法必须遵循以下两点原则：

扩展方法必须加上@UniJSMethod (uiThread = false or true) 注解。UniApp 会根据注解来判断当前方法是否要运行在 UI 线程，和当前方法是否是扩展方法。

UniApp是根据反射来进行调用 Module 扩展方法，所以Module中的扩展方法必须是 public 类型。

数据返回

数据使用UniJSCallback结果回调，具体是使用invoke调用JavaScript的回调方法返回数据。更多可以参考官方文档，invoke需要传入一个Object类型的返回数据，：

源码

至此，一个简单的原生插件就已经开发完成，源码如下：

package com.ss.test;
import com.alibaba.fastjson.JSONObject;
import io.dcloud.feature.uniapp.annotation.UniJSMethod;
import io.dcloud.feature.uniapp.bridge.UniJSCallback;
import io.dcloud.feature.uniapp.common.UniModule;
public class test extends UniModule {
    @UniJSMethod(uiThread = true)
    public void sayHi (String name, UniJSCallback callback) {
        if (callback != null) {
            JSONObject data = new JSONObject();
            data.put("re", "Hi " + name);
            callback.invoke(data);
        }
    }
}