【Uniapp】Uniapp Android原生插件开发指北

前言

在uniapp开发中当HBuilderX中提供的能力无法满足App功能需求,需要通过使用Andorid/iOS原生开发实现时,或者是第三方公司提供的是Android的库,这时候可使用App离线SDK开发原生插件来扩展原生能力。

插件类型有两种,Module模式和Component模式

Module模式:能力扩展,无嵌入窗体的UI控件。大部分插件都是属于此类,比如调用计步器API。代码写法为通过js进行require,然后调用该插件对象的方法。如涉及一些弹出框、全屏ui,也仍然属于Module模式。类似于前端里的js sdk。
Component模式:在窗体中内嵌显示某个原生ui组件。比如窗体局部内嵌某个地图厂商的map组件,上下混排其他前端内容,就需要把这个原生地图sdk封装为Component模式。代码写法与vue组件相同,在template里写组件标签。类似于前端里的vue组件。

本文主要讨论的是Module模式的开发。

开发环境准备

开发环境:JAVA环境 jdk1.8 和Android X
Android studio,最新的Hbuilderx,最新的离线uniSdk

插件必须在uni-sdk的基础上进行开发,可以快速的下载离线uni-sdk,导入UniPlugin-Hello-AS示例工程,也可以自己新建一个原生android项目,拷贝不要的包和资源进行开发。

开发原生插件

1、导入uni插件原生项目(离线uni-sdk中解压),并且成功编译。打开后目录如下:
在这里插入图片描述

Module插件的开发,是一个Module构建成一个插件aar,因为需要新建一个插件实现新的功能。

2、创建Module

在现有Android项目中创建library的Module。例如uniplugin_readcard,配置刚创建的Module的build.gradle信息。

//导入aar需要的配置
repositories {
	flatDir {
		dirs 'libs'
	}
}
dependencies {
	//必须添加的依赖
	compileOnly 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0',
	compileOnly 'androidx.core:core:1.1.0'
	compileOnly 'androidx.fragment:fragment:1.1.0'
	compileOnly 'androidx.appcompat:appcompat:1.1.0'
	compileOnly 'androidx.recyclerview:recyclerview:1.1.0'
	compileOnly 'com.alibaba:fastjson:1.2.83'

	compileOnly fileTree(include: ['uniapp-v8-release.aar'], dir: '../app/libs')
}

此处的lib aar都在APP模块下有,不需要额外的导入。uniapp-v8-release.aar是扩展module主要依赖库,必须导入此依赖库!打包成插件时候不需要打包进入这些依赖库,只需要打包进去你额外添加的依赖库。
在这里插入图片描述
在这里插入图片描述
如图,新的module下,新建两个文件,ReadModule和ReadCard_AppProxy,
如果项目需要导入so包、aar或者jar包,导入放到libs下,

在这里插入图片描述

ReadModule 是暴露于外的核心的类,需要继承于UniModule ,打包插件时候需要配置到package.json的class位置。

public class ReadModule extends UniModule  {

    @UniJSMethod (uiThread = true)
    public void showToastAAA(JSONObject options, UniJSCallback jsCallback) {
        Toast.makeText(mUniSDKInstance.getContext(), "Hello", Toast.LENGTH_SHORT).show();

        JSONObject result = new JSONObject();
        try {
            result.put("cardno", "hello");
            jsCallback.invoke(result);

        } catch (JSONException e) {
            throw new RuntimeException(e);
        }
    }

   @UniJSMethod (uiThread = true)
    public void showTest(UniJSCallback jsCallback) {
        Toast.makeText(mUniSDKInstance.getContext(), "Hello", Toast.LENGTH_SHORT).show();

        JSONObject result = new JSONObject();
        try {
            result.put("cardno", "hello");
            jsCallback.invoke(result);

        } catch (JSONException e) {
            throw new RuntimeException(e);
        }
    }



    @SuppressLint("MissingPermission")
    @UniJSMethod (uiThread = true)
    public void piccrequest(JSONObject options, UniJSCallback jsCallback) {

        TelephonyManager telephonyManager = (TelephonyManager)mUniSDKInstance.getContext().getSystemService(Context.TELEPHONY_SERVICE);
        if (telephonyManager != null) {

            Map<String,String> result = new HashMap<>();
            result.put("imei",  telephonyManager.getDeviceId().toString());
            jsCallback.invoke(result);

        }

    }

注意

1)对外暴露的方法需要添加 @UniJSMethod (uiThread = true),并且设置为public 。
2)JSONObject options可以接收uniapp传过来的数据,也可以为空。
3)jscallback回调的时候,可以用JSONObject 存放数据,回调json数据,但是某些时候回调不到,可以切换成Map。

{
    "name": "ReadCardModule",
    "id": "ReadCardModule", 
    "version": "1.0.0",
    "description": "读卡",
    "_dp_type":"nativeplugin",
    "_dp_nativeplugin":{
        "android": {
			"integrateType":"aar",
            "plugins": [
                {
                    "type": "module",
                    "name": "ReadCardModule", 
                    "class": "uni.dcloud.io.uniplugin_read.ReadModule"
                }
                
            ]
        }
    }
}

注意
1)package.json的class的路径是Module 中ReadModule 的路径
2)name、id、name可以起同一个名字,避免出现错误
3)plugins的name名字用作于uniapp中的引用。

var testModule = uni.requireNativePlugin("ReadCardModule")

3、如果项目中需要进行第三方库初始化,可以新建一个ReadCard_AppProxy 实现UniAppHookProxy并且配置到 ,即可在oncreate中进行初始化。

public class ReadCard_AppProxy implements UniAppHookProxy {
    @Override
    public void onCreate(Application application) {
        //可写初始化触发逻辑
    }

    @Override
    public void onSubProcessCreate(Application application) {
        //子进程初始化回调
    }
}

在UniPlugin-Hello-AS工程下 “app” Module根目录assets/dcloud_uniplugins.json文件,在hooksClass节点添加你创建实现UniAppHookProxy接口的实体类完整名称填入其中即可 (有些需要初始化操作的需求可以在此处添加逻辑,无特殊操作仅使用第一种方式注册即可无需集成UniAppHookProxy接口)

开发完成后,在gradle中进行assembleRelease,即可打包成插件的aar,

在这里插入图片描述

打包给uniapp端或者上传插件市场的文件如下,package.json就是上文所描述的配置文件,Android文件夹中,项目的so包和jar包放到libs下项目所依赖的aar和打包的插件aar放到Android目录下,资源文件放到res或者assets下。

千万不要放错位置!!
千万不要放错位置!!
千万不要放错位置!!

在这里插入图片描述
在这里插入图片描述

如此,一个基础的插件开发就算完成,理论上可以交给uniapp端进行使用。copy上面的文件夹放到nativeplugins下面,mainifest.json中原生插件选择一下,然后制作自定义基座打包,就可以进行使用了。

var myPlugin= uni.requireNativePlugin("ReadCardModule")

myPlugin.piccrequest({  
 }, (res) => {  
    // 处理原生方法返回的结果  
    console.log('读卡结果:', res);  
  
}, (err) => {  
    // 处理调用插件时发生的错误  
    console.error('调用插件失败:', err);  
  
});

但是uniapp端使用插件需要自定义基座和云打包时间特别长,Android模块需要保证自己的插件没有问题,是通顺的,再给uniapp使用比较好。因此,再开发完成后,在Android studio中对uniapp进行离线打包和测试是比较重要的

uniapp插件调试

1、离线打包

对于不熟悉Android的人来说,离线打包有时候难度很大。

1)hbuilder中打包资源包。

条件准备

申请离线appkey
申请离线appkey包括两部分:生成签名证书 和 申请离线appkey

生成签名证书
dcloud官方文档:https://ask.dcloud.net.cn/article/35777

签名证书用jdk自带的工具keytool生成:

keytool -genkey -alias androidPluginKey -keyalg RSA -keysize 2048 -validity 36500 -keystore androidPluginKey.keystore

androidPluginKey是证书别名,可修改为自己想设置的字符,建议使用英文字母和数字
在这里插入图片描述

申请离线appkey

在这里插入图片描述

打包资源

在这里插入图片描述

把资源配置到Android studio项目中

把资源包复制到项目中
在这里插入图片描述

配置证书

确保appid+签名证书+应用包名都一致
在这里插入图片描述

在dcloud_control.xml填写uniappId

在这里插入图片描述

在主app中添加上插件的libary

implementation project(':uniplugin_readcard') 

注册插件
在androidStudio的assets里面新建dcloud_uniplugins.json,并注册插件信息

在这里插入图片描述

如此就完成了uniapp离线打包的配置,即可在此基础上进行调试,

每次调试时在uniapp中进行修改->打包离线资源包->替换掉Android studio中的资源包。

uniapp插件使用

在hbuilder的根目录下新建nativeplugins文件夹,把把上面的文件夹(包含lib aar等资源的)放到内部
f在这里插入图片描述

打开manifest.json进行插件的选择
在这里插入图片描述

使用插件

在项目中所需要用到的地方,引用插件,调用即可,

var myPlugin= uni.requireNativePlugin("ReadCardModule")

myPlugin.piccrequest({  
 }, (res) => {  
    // 处理原生方法返回的结果  
    console.log('读卡结果:', res);  
  
}, (err) => {  
    // 处理调用插件时发生的错误  
    console.error('调用插件失败:', err);  
  
});

制作自定义基座

代码完成后,可以进行自定义基座打包,即可完成开发。
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/911364.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

linux进程的状态之环境变量

我们在前面了解了进程的状态及相关概念 接下来我们接着上一篇进程的状态接着了解环境变量 进程的状态 文章目录 目录 文章目录 前言 二、环境变量 1、常见环境变量 2、查看环境变量 3、修改PATH 4、HOME 5、PATH ​编辑 6、和环境变量相关的命令 三、环境变量的组织…

揭秘集装箱箱号自动识别原理,箱号识别算法

集装箱箱号自动识别算法是一种高效且实用的软件工具。它利用相机、手机或其他摄像头捕获集装箱箱号图像&#xff0c;并通过深度学习的OCR&#xff08;光学字符识别&#xff09;识别技术对集装箱号码进行准确识别。要想进行集装箱箱号识别&#xff0c;需要以下几个基本步骤&…

AndroidLab:一个系统化的Android代理框架,包含操作环境和可复现的基准测试,支持大型语言模型和多模态模型。

2024-10-31&#xff0c;由清华大学和北京大学共同创建的AndroidLab数据集&#xff0c;为安卓自主代理的训练和评估提供了一个包含操作环境、行动空间和可复现基准的系统框架&#xff0c;这对于推动安卓代理技术的发展具有重要意义。 数据集地址&#xff1a;Android Instruct|A…

使用axois自定义基础路径,自动拼接前端服务器地址怎么办

请求路径&#xff1a; http://localhost:5173/http://pcapi-xiaotuxian-front-devtest.itheima.net/home/category/head 很明显多拼接了路径地址 查看基础路径文件发现&#xff1a; //axios基础封装 import axios from axiosconst httpInstance axios.create({baseURL: /h…

Densenet模型花卉图像分类

项目源码获取方式见文章末尾&#xff01; 600多个深度学习项目资料&#xff0c;快来加入社群一起学习吧。 《------往期经典推荐------》 项目名称 1.【基于CNN-RNN的影像报告生成】 2.【卫星图像道路检测DeepLabV3Plus模型】 3.【GAN模型实现二次元头像生成】 4.【CNN模型实现…

【Mysql NDB Cluster 集群(CentOS 7)安装笔记一】

Mysql NDB Cluster 集群(CentOS 7)安装笔记 NDB集群核心概念 NDBCLUSTER(也称为NDB)是一个内存存储引擎,提供高可用性和数据保存功能。 NDBCLUSTER存储引擎可以配置一系列故障转移和负载平衡选项,但从集群级别的存储引擎开始是最容易的。NDB集群的NDB存储引擎包含一整套…

Pattern program MPAT 详解

本文为VIP文章,主要介绍Pattern中元素与格式、常用指令、地址&数据产生指令等。 目录 一、pattern概述 二:Pattern构成元素 1、pattern构成元素:MPAT、END 2、pattern构成元素:pattern file name 3、pattern构成元素:SDEF 4、Pattern构成元素:REGISETR 5、Pa…

【通义灵码】AI编码新时代

目录 一.初识灵码&#xff0c;开启新篇 安装 登录 二.灵码相伴&#xff0c;探索新境 实时续写 自然生成 单元测试生成 解释代码 优化建议 快捷键 三.智慧流转&#xff0c;高效开发 驱动移植 LVGL框架 项目总结 四.融合创新&#xff0c;携手同行 一.初识灵码&#…

RabbitMQ客户端应用开发实战

这一章节我们将快速完成RabbitMQ客户端基础功能的开发实战。 一、回顾RabbitMQ基础概念 这个RabbitMQ的核心组件&#xff0c;是进行应用开发的基础。 二、RabbitMQ基础编程模型 RabbitMQ提供了很多种主流编程语言的客户端支持。这里我们只分析Java语言的客户端。 上一章节提…

PySide6百炼成真(2)

文章目录 1.简单的登录页面2.简单的计算器 本篇根据前面所学做两个小demo 制作一个简单的登录页面制作一个计算器 因为还没有学习布局流等,所以就只能拖拉到设计师中. 1.简单的登录页面 下面就到计算器了,在图形界面中计算器就跟我们编程语言的hello,world一样,所以一定要自己…

群控系统服务端开发模式-应用开发-上传工厂开发

现在的文件、图片等上传基本都在使用oss存储。而现在常用的oss存储有阿里云、腾讯云、七牛云、华为云等&#xff0c;但是用的最多的还是前三种。而我主要封装的是本地存储、阿里云存储、腾讯云存储、七牛云存储。废话不多说&#xff0c;直接上传设计图及说明&#xff0c;就一目…

服务器被病毒入侵如何彻底清除?

当服务器遭遇病毒入侵时&#xff0c;彻底清除病毒是确保系统安全和数据完整性的关键步骤。这一过程不仅需要技术上的精准操作&#xff0c;还需要严密的计划、合理的资源调配以及后续的防范措施。以下是一篇关于如何在服务器被病毒入侵时彻底清除病毒的详细指南。 一、初步响应与…

修改 title标题图标

路径 \web\views\webclient_templates.xml \web\static\src\webclient\webclient.js 再升级web模块

docker安装zookeeper,以及zk可视化界面介绍

1. zookeeper 1.1. zookeeper简单介绍 ZooKeeper 是一个分布式的开源协调服务&#xff0c;最初由 Apache Hadoop 项目开发&#xff0c;用于构建分布式应用程序。它提供了一个简单的接口&#xff0c;允许开发人员实现诸如配置维护、域名服务、分布式同步、组服务等常见任务。Z…

Excel 无法打开文件

Excel 无法打开文件 ‘新建 Microsoft Excel 工作表.xlsx",因为 文件格式或文件扩展名无效。请确定文件未损坏&#xff0c;并且文件扩展名与文件的格式匹配。

idea配置maven仓库

下载Maven并配置文件内容 maven下载网址&#xff1a;Maven – Download Apache Maven 下载到D盘&#xff1a;D:\apache-maven-3.9.9 创建maven-repository文件夹作为本地仓库 修改conf文件夹下的setting.xml文件内容 在里面添加一条&#xff0c;指定本地仓库&#xff0c;下载…

L1G3000 提示工程(Prompt Engineering)

什么是Prompt(提示词)? Prompt是一种灵活、多样化的输入方式&#xff0c;可以用于指导大语言模型生成各种类型的内容。什么是提示工程? 提示工程是一种通过设计和调整输入(Prompts)来改善模型性能或控制其输出结果的技术。 六大基本原则: 指令要清晰提供参考内容复杂的任务拆…

C#与C++交互开发系列(十九):跨进程通信之套接字(Sockets)

1、前言 套接字&#xff08;Sockets&#xff09;是一种强大的通信方式&#xff0c;可以在同一台设备或网络上的不同设备之间进行通信。C# 和 C 都支持套接字编程&#xff0c;这使得在它们之间实现跨进程通信成为可能。本文将介绍如何通过套接字实现 C# 和 C 程序的跨进程通信&…

Python | Leetcode Python题解之第538题把二叉搜索树转换为累加树

题目&#xff1a; 题解&#xff1a; class Solution:def convertBST(self, root: TreeNode) -> TreeNode:def getSuccessor(node: TreeNode) -> TreeNode:succ node.rightwhile succ.left and succ.left ! node:succ succ.leftreturn succtotal 0node rootwhile nod…

几个docker可用的镜像源

几个docker可用的镜像源 &#x1f490;The Begin&#x1f490;点点关注&#xff0c;收藏不迷路&#x1f490; sudo rm -rf /etc/docker/daemon.json sudo mkdir -p /etc/dockersudo tee /etc/docker/daemon.json <<-EOF {"registry-mirrors": ["https://d…