Harmony os Next——Retrofit网络库的使用和封装

这里写目录标题

  • Harmony os Next——Retrofit网络库的使用和封装
  • 描述
  • Retrofit的使用
    • BaseService
    • 部分功能使用
      • GET
      • POST
    • 创建拦截器
    • 创建实例
    • 全局封装

Harmony os Next——Retrofit网络库的使用和封装

描述

Retrofit作为Android平台最为常用的一个第三方网络库,搭配Kotlin的协程,使用极为便捷。通过Harmony的工作人员的努力,制作出的Retrofit For Harmony Library依旧十分强大。
通过在oh-package.json5文件中添加如下依赖即可完成装配,具体版本可以查看retrofit api

“@ohos/retrofit”: “2.0.1-rc.0”

同时也可以通过添加httpclient为其添加拦截器等

“@ohos/httpclient”: “2.0.0-rc.9”,

Retrofit的使用

BaseService

需要创建一个类继承BaseService。同时可以在类名上方加一个@BasePath("/")注解。
意味在BaseUrl后面补全一个/。因为在后面通过ServiceBuilder创建AppService实例时,需要指定BaseUrl,例如BaseUrlhttps://api.xxxx.com,在类上面添加注解@BasePath("/"),便会自动在BaseUrl后面加一个/,后面的具体接口就不需要加/,例如有一个获取天气的子接口api/weather,最终拼凑的就是https://api.xxxx.com/api/weather

@BasePath("/")
class AppService extends BaseService{
}

部分功能使用

GET

其中NetworkConstants.GET_WEATHER就是上述举例的api/weather,在其前面使用GET注解进行包裹,然后可以通过@Query传递参数。最后返回的数据是通过异步的方式返回。Promise<Response<...>>为固定返回参数,BaseModel<WeatherModel>为api接口返回的JSON数据格式,可根据项目自行定义

@BasePath("/")
class AppService extends BaseService{@GET(NetworkConstants.GET_WEATHER)async getWeather(@Query("cityId") cityId: string): Promise<Response<BaseModel<WeatherModel>>> { return {} as Response<BaseModel<WeatherModel>> }
}

POST

GET使用一致,通过POST注解进行包裹,同样可以使用@Field进行参数传递,其中 @FormUrlEncoded注解是给此方法添加如下参数头

‘content-type’: ‘application/x-www-form-urlencoded;charset=utf-8’

@BasePath("/")
class AppService extends BaseService{@FormUrlEncoded@POST(NetworkConstants.TEST_API)async postTestApi(@Field("testId")testId : string): Promise<Response<BaseModel<TestModel>>> { return {} as Response<BaseModel<TestModel>> }
}

创建拦截器

以打印日子拦截器为例,可以将每一个API请求的方法、参数、URL、返回结果等进行打印输出,便于测试。具体如下

class LoggingInterceptor implements Interceptor{async intercept(chain: Chain): Promise<Response> {try {let request = chain.requestI()let requestBody: RequestBody = request.bodylet url = request.url as HttpUrlconst connectResponse = await chain.proceedI(chain.requestI())let startMessage = `-->${request.method} ${url.url} ${connectResponse.protocol ?? ''}`let contentType: string = requestBody.contentlet endMessage = `--> END ${request.method}`Logger.info(`Headers:${JSON.stringify(request.headers)}`)Logger.info(startMessage)Logger.info(contentType)Logger.info(endMessage)return connectResponse} catch (error) {return new Promise<Response>((resolve, reject) => {let request = chain.requestI()let response = chain.proceedI(request)response.then((data) => {resolve(data)}).catch((err: Error) => {reject(err)});})}}
}

创建实例

通过addInterceptor便可以添加上述我们创建的日志打印拦截器
通过setEndpoint可以设置BASEURL
通过在build函数里面指定需要创建的BaseService子类

let client: HttpClient = new  HttpClient.Builder().setConnectTimeout(5, TimeUnit.SECONDS).setReadTimeout(5, TimeUnit.SECONDS).addInterceptor(loggingInterceptor).build()export const appService = new ServiceBuilder().setEndpoint(NetworkConstants.BASEURL).setClient(client).build(AppService)

全局封装

通过创建一个全局范型方法baseApiRequest,将api请求的异常进行集中处理,只对其成功返回的结果和错误进行返回,可以避免重复异常处理

export function baseApiRequest<T>(apiCall: Promise<Response<T>>,onSuccess: (result: T) => void,onFailed: (error: ResourceStr) => void
) {apiCall.then((result: Response<T>) => {if (result.isSuccessful() && result.code() == HttpStatusCode.SUCCESS) {onSuccess(result.result)} else {onFailed(result.message())}}).catch((error: Error) => {if (error as IOException) {//网络错误onFailed($r('app.string.HH_Public_DisconnectNetwork'))}else {onFailed(error.message)}})
}

具体使用如下所示,就此我们就可以将一个网络请求接口简化到下面方法一样

baseApiRequest(appService.getWeather(citeId),(result) => {if (result.code === HttpStatusCode.SUCCESS) {//successful} else {//failed-error codepromptAction.showToast({ message: result.message })}},(error) => {//failedLogger.info(`${error}`)promptAction.showToast({ message: error })})

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【TensorFlow深度学习】循环神经网络RNN的基本结构与功能

循环神经网络RNN的基本结构与功能 循环神经网络&#xff08;RNN&#xff09;的基本结构与功能&#xff1a;时间序列数据的深度解析RNN的基本结构功能与应用场景代码示例&#xff1a;TensorFlow实现简单RNN结语 循环神经网络&#xff08;RNN&#xff09;的基本结构与功能&#x…

QT 如何在 QListWidget 的选项中插入自定义组件

有时我们需要 QListWidget 完成更复杂的操作&#xff0c;而不仅限于添加文本或者图标&#xff0c;那么就会使用到 setItemWidget 函数&#xff0c;但是这也会伴生一个问题&#xff0c;插入自定义组件后&#xff0c;QListWidget 对选项点击事件的获取会收到阻塞&#xff0c;因…

Docker安装启动Mysql

1、安装Docker&#xff08;省略&#xff09; 网上教程很多 2、下载Mysql5.7版本 docker pull mysql:5.7 3、查看镜像是够下载成功 docker images 4、启动镜像&#xff0c;生成容器 docker run --name mysql5.7 -p 13306:3306 -e MYSQL_ROOT_PASSWORD123456 -d mysql:5.7 5…

内网-2(代理)

一、代理概述 1、代理服务器(proxy server)&#xff1a;代理网络用户去取得网络信息&#xff0c;介于浏览器与web服务器之间的一条服务器。 注&#xff1a;为了方便&#xff0c;以下用B来代表浏览器的主机&#xff0c;S来代表服务器的主机。 2、正向代理和反向代理 正向代…

MySQL学习——查询示例(三)

1 计算每天的访问 以下示例显示了如何使用位组函数来计算用户每月访问网页的天数。 CREATE TABLE t1 (year YEAR, month INT UNSIGNED, day INT UNSIGNED); INSERT INTO t1 VALUES(2000,1,1),(2000,1,20),(2000,1,30),(2000,2,2), (2000,2,23),(2000,2,23); 示例表包含表示用…

CMU FAR Planner 在已知和未知环境中进行高效的导航任务算法详解

FAR Planner: Fast, Attemptable Route Planner using Dynamic Visibility Update 本文将介绍一种基于可视图的路径规划框架FAR Planner,它能够在已知和未知环境中进行高效的导航任务。 摘要 论文提出了一种能够处理已知和未知环境中导航任务的基于可视图的规划框架。该规划…

easyocr.Reader().readtext()说明

easyocr.Reader().readtext() 是 EasyOCR 库中的一个方法&#xff0c;用于从图像中提取文本。 该方法的作用是从给定的图像中读取文本&#xff0c;并返回一个包含检测到的文本及其对应位置的列表。 以下是该方法的参数和返回值&#xff1a; readtext(image, decodergreedy, …

PolarCTF 2024夏季个人挑战赛 个人WP

【WEB】审计 直接给源码&#xff0c;php特性 秒了&#xff0c;有个特殊的东西 0e215962017&#xff0c;他md5后的值是本身 【WEB】扫扫看 敏感目录flag.php 【WEB】debudao 查看网页源码&#xff08;里面的flag是错的&#xff09; 查看网络 【WEB】ExX? 开题 扫一下&#…

R语言 | 安装ggpubr R包时编译语句中出现 WARNING: ignoring environment value of R_HOME 而报错

在安装 ggpubr 时&#xff0c;出现报错。 1. 环境介绍 系统&#xff1a;CentOS7.9 $ R --version R version 4.3.2 (2023-10-31) – “Eye Holes” $ gcc --version gcc (GCC) 12.3.0 2. 缺少cmake $ sudo yum install cmake3> system("/usr/bin/cmake3 --versio…

法国工程师数电练习题——有限状态机

1. 有限状态机 1.1 问题背景描述 给定的有限状态机由其状态图表示&#xff0c;具有两个输入E1和E2以及一个输出S。状态机为下图。请为以下输入序列绘制这个Moore机的时序图&#xff1a; 1) 在t50纳秒时&#xff0c;E1E211 2) 在t150纳秒时&#xff0c;E1E200 …

Redis教程(十九):Redis的Redisson布隆过滤器

传送门&#xff1a;Redis教程汇总篇&#xff0c;让你从入门到精通 布隆过滤器 布隆过滤器&#xff08;Bloom Filter&#xff09;是一种空间效率极高的概率型数据结构&#xff0c;用于快速检测一个元素是否存在于一个集合中。由于其独特的特性&#xff0c;布隆过滤器可以在需要…

1.盒模型及其应用(溢出、外边距塌陷)

一、盒模型 盒模型详解-CSDN博客 CSS学习笔记3&#xff1a;CSS三大特性、盒子模型-CSDN博客 1.盒模型组成 &#xff08;1&#xff09;padding padding和border都会撑大盒子&#xff0c;margin不会. 如果没有指定盒子的width/height&#xff0c;那么padding不会撑大盒子。 &am…

Nvidia Jetson/Orin +FPGA+AI大算力边缘计算盒子:公路智能巡检解决方案

项目背景 中国公路网络庞大&#xff0c;总里程超过535万公里&#xff0c;高速公路里程位居世界前列。面对基础设施存量的不断增长&#xff0c;公路养护管理已迈入“建管养并重”的新时代。随着养护支出的逐年攀升&#xff0c;如何提升养护效率、降低管理成本&#xff0c;成为亟…

YOLOv10:实时端到端目标检测的新突破

目标检测作为计算机视觉领域的一个核心问题&#xff0c;其关键在于能够在图像中准确识别并定位对象。随着深度学习技术的发展&#xff0c;基于深度神经网络的目标检测方法不断涌现&#xff0c;其中YOLO&#xff08;You Only Look Once&#xff09;系列算法以其优异的实时性和准…

推荐几个开源的c#的工作流引擎组件

以下是一个.NET Core领域可以推荐使用的流程引擎的表格&#xff1a; 名称 生产厂家 下载地址 支持二开 独立部署 ccflow 济南驰骋信息技术有限公司 https://gitee.com/opencc 是 是 Elsa Elsa Workflows GitHub - elsa-workflows/elsa-core: A .NET workflows li…

C++类和对象下篇

&#x1f407; &#x1f525;博客主页&#xff1a; 云曦 &#x1f4cb;系列专栏&#xff1a;[C] &#x1f4a8;路漫漫其修远兮 吾将而求索 &#x1f49b; 感谢大家&#x1f44d;点赞 &#x1f60b;关注&#x1f4dd;评论 文章目录 &#x1f4d4;1、再谈构造函数&#x1f4f0;…

使用 el-autocomplete 实现远程搜索功能

在现代Web应用中&#xff0c;提供高效且用户友好的搜索体验至关重要。Element UI&#xff08;一个为Vue.js设计的桌面端UI框架&#xff09;中的el-autocomplete组件正是为了满足这一需求而设计的&#xff0c;它能够实现自动补全与异步搜索功能。本文将通过一个示例来介绍如何使…

【C++】类和对象——构造和析构函数

目录 前言类的六个默认构造函数构造函数1.构造函数的概念2.构造函数的特性 初始化列表1.构造函数整体赋值2.初始化列表 析构函数1.析构函数的概念2.析构函数的特性 前言 类和对象相关博客&#xff1a;【C】类和对象   我们前面一个内容已经讲了关于类好对象的初步的一些知识&…

Python量化交易学习——Part5:通过相关系数选择对收益率影响比重大的因子(1)

上一节中我们学习了如何通过单因子策略进行股票交易,在实际的股市中,因子(也就是指标)数量往往非常之多,比如市盈率/市净率/净资产收益率等,在使用这些因子的过程中,我们会发现有的因子与收益率为正相关,有的因子为负相关,而有些因子几乎完全无关。 所以我们可以通过计…

k8s笔记——kubernetes中的三种IP

kubernetes概念 Master&#xff1a;集群控制节点&#xff0c;每个集群需要至少一个master节点负责集群的管控 Node&#xff1a;工作负载节点&#xff0c;由master分配容器到这些node工作节点上&#xff0c;然后node节点上的docker负责容器的运行 Pod&#xff1a;kubernetes的…