【HarmonyOS开发】ArkTS HTTP 工具类封装

于 2024-05-22 18:12:15 发布
阅读量441 收藏 10
点赞数 4
文章标签： harmonyos http 华为
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_51522235/article/details/139126242
版权

前言

在鸿蒙系统中进行网络请求是应用开发中的一个常见需求。本文将详细介绍如何使用自定义的MyHttpUtil类来简化HTTP请求的实现，并探讨其具体实现细节。MyHttpUtil是基于鸿蒙系统的ArkTS编写的一个实用工具类，可以有效地管理和发起HTTP请求。

1. 背景

在现代应用开发中，网络请求是必不可少的一部分。无论是获取远程数据还是提交用户信息，都需要通过HTTP请求与服务器进行通信。鸿蒙系统提供了强大的网络库，但直接使用这些库进行网络请求可能会显得繁琐且易出错。因此，封装一个通用的HTTP请求工具类可以大大简化开发过程。

2. MyHttpUtil类的实现

导入必要模块

首先，我们需要导入一些必要的模块，包括HTTP库、全局数据、偏好设置工具、日志工具、吐司工具等：

import http from '@ohos.net.http';
import GlobalData from '../global/GlobalData';
import PreferenceKey from '../preference/PreferenceKey';
import PreferencesUtil from '../preference/PreferencesUtil';
import DebugLogUtil, { LogStyle } from '../utils/DebugLogUtil';
import ToastUtils from '../utils/ToastUtils';
import HttpConnectAPI from './HttpConnectAPI';

定义请求方法和URL类型枚举

接下来，我们定义一些常用的请求方法和基础URL类型：

export enum RequestMethod {
  OPTIONS = "OPTIONS",
  GET = "GET",
  HEAD = "HEAD",
  POST = "POST",
  PUT = "PUT",
  DELETE = "DELETE",
  TRACE = "TRACE",
  CONNECT = "CONNECT"
}

export enum BaseURLType {
  COMMON,
  SPECIAL
}

MyHttpUtil类的静态属性和方法

我们定义了静态属性和方法，用于配置和发起HTTP请求：

export class MyHttpUtil {
  private static readonly LOG_TAG: string = "====MyHttpUtil====";
  private static httpInstance = http.createHttp();
  public static READ_TIME_OUT: number = 60000; // 单位：毫秒
  public static CONNECT_TIME_OUT: number = 60000; // 单位：毫秒

  public static async makeRequest(
    url: string,
    method: RequestMethod,
    data: Record<string, number | string>,
    mBaseURLType: BaseURLType,
    showErrorToast: boolean = false,
    successCallback: (result: Record<string, any>) => void,
    errorCallback: (error: string) => void
  ): Promise<void> {
    // 确保 URL 有效
    if (!url) {
      errorCallback('URL 不能为空');
      return;
    }

    // 检查并获取用户的Token和OpenID
    if (!GlobalData.getInstance().USER_INFO_TOKEN || !GlobalData.getInstance().USER_INFO_OPEN_ID) {
      GlobalData.getInstance().USER_INFO_TOKEN = await PreferencesUtil.getInstance().get(PreferenceKey.USER_INFO_TOKEN_VALUE, '') as string;
      GlobalData.getInstance().USER_INFO_OPEN_ID = await PreferencesUtil.getInstance().get(PreferenceKey.USER_INFO_OPEN_ID_VALUE, '') as string;
    }

    // 配置请求头
    let mHeaderMap: Record<string, string> = {
      'content-type': 'application/json;charset=UTF-8',
      'connection': 'keep-alive',
      'accessToken': GlobalData.getInstance().USER_INFO_TOKEN,
      'openId': GlobalData.getInstance().USER_INFO_OPEN_ID,
      'version': GlobalData.getInstance().API_VERSION
    };

    // 配置请求选项
    let options: http.HttpRequestOptions = {
      method: method,
      header: mHeaderMap,
      readTimeout: MyHttpUtil.READ_TIME_OUT,
      connectTimeout: MyHttpUtil.CONNECT_TIME_OUT,
      extraData: method !== RequestMethod.GET ? JSON.stringify(data) : undefined,
    };

    // 根据URL类型选择基础URL
    switch (mBaseURLType) {
      case BaseURLType.COMMON:
        url = HttpConnectAPI.BaseIOVURL + url;
        break;
      case BaseURLType.SPECIAL:
        break;
      default:
        url = HttpConnectAPI.BaseIOVURL + url;
    }

    // 处理GET请求的查询参数
    if (method === RequestMethod.GET && Object.keys(data).length > 0) {
      let queryString = Object.keys(data).map(key => `${encodeURIComponent(key)}=${encodeURIComponent(data[key])}`).join('&');
      url += `?${queryString}`;
    }

    try {
      // 发起HTTP请求
      let response: http.HttpResponse = await MyHttpUtil.httpInstance.request(url, options);
      let result: Record<string, any> = JSON.parse(response.result.toString());

      DebugLogUtil.log(LogStyle.LEVEL_DEBUG, MyHttpUtil.LOG_TAG, `url====${url}====method====${method}====header====${JSON.stringify(response.header)}====responseCode====${response.responseCode}`);

      // 处理成功响应
      if (response.responseCode === 200) {
        DebugLogUtil.log(LogStyle.LEVEL_DEBUG, MyHttpUtil.LOG_TAG, `url====${url}====method====${method}====header====${JSON.stringify(response.header)}====responseCode====${response.responseCode}====Data====${JSON.stringify(result)}`);
        successCallback(result);
      } else {
        // 处理错误响应
        if (showErrorToast) {
          ToastUtils.showToast('接口业务错误信息');
        }
        DebugLogUtil.log(LogStyle.LEVEL_ERROR, MyHttpUtil.LOG_TAG, `url====${url}====method====${method}====header====${JSON.stringify(response.header)}====ErrorResponseCode====${response.responseCode}`);
        errorCallback(response.responseCode.toString());
      }
    } catch (error) {
      // 处理请求异常
      DebugLogUtil.log(LogStyle.LEVEL_ERROR, MyHttpUtil.LOG_TAG, `url====${url}====method====${method}====Exception====${error}`);
      errorCallback(error);
    }
  }
}

3. 代码详解

导入必要模块：
我们首先导入了鸿蒙系统的HTTP库以及一些实用工具模块。

请求方法和URL类型枚举：
定义了HTTP请求的各种方法（如GET、POST等）和基础URL类型（COMMON和SPECIAL）。

静态属性和方法：

  • LOG_TAG：用于日志记录的标签。
  • httpInstance：创建一个HTTP实例用于发起请求。
  • READ_TIME_OUT和CONNECT_TIME_OUT：配置请求的超时时间。
  • makeRequest方法：核心方法，用于发起HTTP请求。

请求头和选项配置：
在makeRequest方法中，我们首先确保URL有效，然后检查用户的Token和OpenID，并配置请求头和选项。

基础URL选择：
根据不同的基础URL类型选择合适的URL。

处理GET请求的查询参数：
对于GET请求，我们将查询参数附加到URL上。

发起HTTP请求并处理响应：
使用httpInstance发起请求，并处理成功和失败的响应，进行日志记录和错误处理。

4. 使用示例

import http from '@ohos.net.http';
import GlobalData from '../global/GlobalData';
import PreferenceKey from '../preference/PreferenceKey';
import PreferencesUtil from '../preference/PreferencesUtil';
import DebugLogUtil, { LogStyle } from '../utils/DebugLogUtil';
import ToastUtils from '../utils/ToastUtils';
import HttpConnectAPI from './HttpConnectAPI';

export enum RequestMethod {
  OPTIONS = "OPTIONS",
  GET = "GET",
  HEAD = "HEAD",
  POST = "POST",
  PUT = "PUT",
  DELETE = "DELETE",
  TRACE = "TRACE",
  CONNECT = "CONNECT"
}

export enum BaseURLType {
  COMMON,
  SPECIAL
}

export class MyHttpUtil {
  private static readonly LOG_TAG: string = "====MyHttpUtil====";
  private static httpInstance = http.createHttp();
  public static READ_TIME_OUT: number = 60 1000
  public static CONNECT_TIME_OUT: number = 60 1000

  public static async makeRequest(
    url: string,
    method: http.RequestMethod,
    data: Record<string, number | string,
    mBaseURLType: BaseURLType,
    showErrorToast: boolean = false,
    successCallback: (result: Record<string, Object) => void,
    errorCallback: (error: string) => void
  ): Promise<void{
    // 确保 URL 有效
    if (!url) {
      errorCallback('URL 不能为空');
      return;
    }

    if(GlobalData.getInstance().USER_INFO_TOKEN == null || GlobalData.getInstance().USER_INFO_TOKEN.length == 0 || GlobalData.getInstance().USER_INFO_OPEN_ID == null || GlobalData.getInstance().USER_INFO_OPEN_ID.length == 0){
      GlobalData.getInstance().USER_INFO_TOKEN = await PreferencesUtil.getInstance().get(PreferenceKey.USER_INFO_TOKEN_VALUE, '') as string
      GlobalData.getInstance().USER_INFO_OPEN_ID = await PreferencesUtil.getInstance().get(PreferenceKey.USER_INFO_OPEN_ID_VALUE, '') as string
    }

    let mHeaderMap: Record<string, number | string= {
      'content-type': 'application/json;charset=UTF-8',
      'connection': 'keep-alive',
      'accessToken': GlobalData.getInstance().USER_INFO_TOKEN,
      'openId': GlobalData.getInstance().USER_INFO_OPEN_ID,
      'version': GlobalData.getInstance().API_VERSION
    };

    let options: http.HttpRequestOptions = {
      method: method,
      header: mHeaderMap,
      readTimeout: MyHttpUtil.READ_TIME_OUT,
      connectTimeout: MyHttpUtil.CONNECT_TIME_OUT,
      extraData: method != http.RequestMethod.GET ? JSON.stringify(data) : undefined, // 根据请求方法设置数据参数
    };

    switch (mBaseURLType) {
      case BaseURLType.COMMON:
        url = HttpConnectAPI.BaseIOVURL url
        break;
      case BaseURLType.SPECIAL:
        url = url
        break;
      default:
        url = HttpConnectAPI.BaseIOVURL url
    }

    // 如果是 GET 请求，并且有查询参数，则将查询参数附加到 URL 上
    if (method === http.RequestMethod.GET && Object.keys(data).length 0) {
      let queryString = Object.keys(data).map(key => `${encodeURIComponent(key)}=${encodeURIComponent(data[key])}`).join('&');
      url += `?${queryString}`;
    }

    try {
      // 使用同一个 http 实例发起请求
      let response: http.HttpResponse = await MyHttpUtil.httpInstance.request(url, options);
      let result:Record<string, Object= JSON.parse(response.result.toString());

      DebugLogUtil.log(LogStyle.LEVEL_DEBUG, MyHttpUtil.LOG_TAG,'url====' url '====method====' method '====header====' JSON.stringify(response.header) '====responseCode====' response.responseCode);

      // 处理成功响应
      if (response.responseCode === 200) {
        DebugLogUtil.log(LogStyle.LEVEL_DEBUG, MyHttpUtil.LOG_TAG,'url====' url '====method====' method '====header====' JSON.stringify(response.header) '====responseCode====' response.responseCode '====Data====' +JSON.stringify(result));
        successCallback(result);
      } else {
        // 处理错误响应
        if (showErrorToast) {
          ToastUtils.showToast('接口业务错误信息');
        }
        DebugLogUtil.log(LogStyle.LEVEL_ERROR, MyHttpUtil.LOG_TAG,'url====' url '====method====' method '====header====' JSON.stringify(response.header) '====ErrorResponseCode====' response.responseCode);
        errorCallback(response.responseCode.toString());
      }
    } catch (error) {
      // 处理请求异常
      DebugLogUtil.log(LogStyle.LEVEL_ERROR, MyHttpUtil.LOG_TAG,'url====' url '====method====' method '====Exception====' error);
      errorCallback(error);
    }
  }

}

下面是一个使用MyHttpUtil类发起GET请求的示例：

async userLoginResult(userPhone: string, userPassword: string) {
    let params: Record<string, number | string> = {
      'phone': userPhone.toString(),
      'password': passwordDigest.toString(),
    };
await MyHttpUtil.makeRequest(HttpConnectAPI.API_USER_LOGIN, RequestMethod.GET, params, BaseURLType.COMMON, false,
  async (result) => {
    this.mLoginModelBean = JSON.parse(JSON.stringify(result))
  }, (error) => {
    this.mCustomDialogController.close()

    ToastUtils.showToast($r('app.string.toast_login_page_content3'))
  })
}

在这个示例中，我们调用了makeRequest方法，传入了请求的URL、方法、参数、URL类型和回调函数。

5. 总结

通过封装一个通用的HTTP请求工具类MyHttpUtil，我们可以在鸿蒙系统中更方便地进行网络请求。该工具类不仅简化了请求的配置和处理，还提供了日志记录和错误处理的功能，极大地提高了开发效率和代码的可维护性。

Android程序Su
关注
  • 4
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
HarmonyOS ArkTS 三方库的基本使用（十六）
Chen_xiaobao的博客
01-03 2023
常用的三方库可以分为UI、动画、网络、图片、多媒体、数据存储、安全、工具等。@ohos/lottie是基于lottie-web开发，集成在三方库社区内的开源版本，是HarmonyOS系统中复杂动画的一种解决方案。启动动画：APP logo动画的播放。加载动画：网络请求的loading动画。上下拉刷新动画：请求更多资源时的刷新动画。按钮动画：切换按钮、编辑按钮、播放按钮等按钮的切换过渡动画。视图转场动画：一些场景的转场添加动画能够提升用户体验。
鸿蒙【ArkTS】使用TS装饰器封装网络请求HTTP
weixin_60376559的博客
02-21 1873
在HarmonyOS应用开发中，通过HTTP访问网络，可以使用官方提供的@ohos.net.http模块。但是官方提供的直接使用不太好使用，需要封装下才好。这里采用TS的装饰器实现AOP效果 完成前后端接口风格的统一
【HarmonyOS开发】ArkTs使用Http封装
qq_23334071的博客
12-22 2113
应用可以通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。
HarmonyOS鸿蒙ArkTS，封装http网络请求
qq_62787048的博客
01-25 1620
HarmonyOS鸿蒙ArkTS，封装http网络请求
HarmonyOS鸿蒙ArkTS/ArkUI项目，封装http网络请求，封装公共API以及调用请求的过程实现。
薛定谔的猫的博客
01-04 3078
我们在日常当中开发鸿蒙项目的时候，调用@ohos.net.http (数据请求)方法去请求接口，整个组件的语法糖会很繁琐，我们对@ohos.net.http (数据请求)方法进行一下二次公共API接口封装http网络请求，实现接口的简单方便快捷的调用。
ArkTS - 网络请求
m0_56308072的博客
01-06 2125
应用通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。前端开发肯定都使用过一个叫的，它是是一个基于的网络请求库，可以用于浏览器和 node.js，它是前端最流行的发送ajax请求的第三方库。如果你不知道什么是promise，推荐看看我的上一篇博客。
【鸿蒙应用ArkTS开发系列】- http网络库使用讲解和封装
枫的专栏
05-12 8197
现在网上的应用，基本都是网络应用，需要进行联网获取数据，而常用的联网获取数据的方式有http、socket、websocket等。在鸿蒙应用、服务中，stage模式开发下，鸿蒙官方为我们提供了一个网络组件库 http ,我们通过即可以完成引用。@ohos.net.http (数据请求)该组件提供HTTP数据请求能力。应用可以通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。具体查看官网。
OpenHarmony开发实战：健康生活应用（ArkTS）
最新发布
shudaoshanQAQ的博客
04-12 854
本篇Codelab介绍了如何实现一个简单的健康生活应用
HarmonyOS鸿蒙ArkTS证件照生成模板
02-04
HarmonyOS鸿蒙操作系统引入了一种新的编程语言——ArkTS，它是专门为HarmonyOS设计的，旨在提高开发效率和跨平台兼容性。 ArkTS是TypeScript的方言，它结合了JavaScript的灵活性和静态类型的强安全性，使得开发人员...
HarmonyOS 开发平台和工具
02-11
HarmonyOS 开发平台整体介绍 HarmonyOS 开发平台新能力
HarmonyOS开发工具DevEco Studio介绍
02-11
 功能强大易用的HarmonyOS移动应用开发工具对HarmonyOS系统的发展至关 重要， 3.0 Beta1版本的DevEco Studio已经支持通过可视化布局编辑器构建界 面， 功能越来越齐全和稳定。  本章主要介绍DevEco Studio开发...
HarmonyOS开发工具与平台
04-27
HarmonyOS4.17日上号开发者大会现场PPT资料分享。
基于鸿蒙HarmonyOS，使用ArkTS开发纯净的浏览器（小狐狸浏览器）.zip
02-07
在本项目中，我们将探讨如何基于华为的鸿蒙HarmonyOS操作系统，利用 ArkTS 开发一个纯净的浏览器应用，以“小狐狸浏览器”为例。鸿蒙系统是华为面向物联网时代推出的一款全新分布式操作系统，旨在提供跨平台、跨设备...
ArkTS - 数据持久化
m0_56308072的博客
01-08 2146
应用数据持久化，是指应用将内存中的数据通过文件或数据库的形式保存到设备上。内存中的数据形态通常是任意的数据结构或数据对象，存储介质上的数据形态可能是文本、数据库、二进制文件等。持久（Persistence），即把数据（如中的对象）保存到可永久保存的存储设备中（如磁盘）。持久化的主要应用是将内存中的数据存储在关系型的数据库中，当然也可以存储在磁盘文件中、XML数据文件中等等。HarmonyOS标准系统支持典型的存储数据形态，包括用户首选项、键值型数据库、关系型数据库。
Harmony网络请求工具类axios
海阔天空
09-01 2604
Harmony网络请求工具类
鸿蒙OS开发实例：【工具类封装-http请求】
m0_62167422的博客
03-27 815
import http from '@ohos.net.http'; import promptAction from '@ohos.promptAction'; 封装HTTP接口请求类，提供格式化的响应信息输出功能。 使用 DevEco Studio 3.1.1 Release 及以上版本，API 版本为 api 9 及以上。
OpenHarmony开发实战：手势截屏（ArkTS）
shudaoshanQAQ的博客
04-12 927
本篇Codelab基于手势处理和截屏能力，介绍了手势截屏的实现过程
鸿蒙（HarmonyOS）版Retrofit网络请求框架
maniuT的博客
03-25 1556
蒹葭(JianJia)是一款鸿蒙系统上的网络请求框架，其实就是将安卓的Retrofit移植到鸿蒙系统上，我将鸿蒙版的Retrofit命名为蒹葭(JianJia)。蒹葭不仅能实现Retrofit的功能，还会提供一些Retrofit没有的功能。Retrofit不支持动态替换域名，国内的应用一般都是有多个域名的，蒹葭支持动态替换域名。
鸿蒙HarmonyOS开发学习笔记
01-21
鸿蒙HarmonyOS开发学习笔记，详细介绍每一个组件的用法、参数、属性等，还补充了一些在官网课程中没讲到的内容，相信了解了这部分内容会帮助你更好的利用ArkTS进行鸿蒙应用开发。 当然也有不足的地方，我会持续更新补充。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Android程序Su

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值