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

最新推荐文章于 2024-10-04 22:38:52 发布
最新推荐文章于 2024-10-04 22:38:52 发布
阅读量639 收藏 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
关注
HarmonyOs开发之———使用HTTP访问网络资源
this_is_bug的博客
07-03 356
HarmonyOs开发之 应用通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。
【HarmonyOS】ArkTS开发@Styles装饰器和@Extend装饰器详解
一键难忘的博客
11-25 1365
在大型应用中，每个组件都需要单独设置样式，这往往导致大量的冗余代码。为了解决这一问题，ArkTS引入了@Styles装饰器，允许将多条样式设置提炼成一个方法，并在组件声明的位置轻松调用。// 全局样式定义@Component// 在组件内定义样式})build() {// 使用全局样式// 使用组件内定义的样式.fancy()上述代码展示了如何使用@Styles定义全局和组件内的样式，并通过不同的方法进行调用。
鸿蒙【ArkTS】使用TS装饰器封装网络请求HTTP
weixin_60376559的博客
02-21 3929
在HarmonyOS应用开发中，通过HTTP访问网络，可以使用官方提供的@ohos.net.http模块。但是官方提供的直接使用不太好使用，需要封装下才好。这里采用TS的装饰器实现AOP效果 完成前后端接口风格的统一
鸿蒙HarmonyOS之封装Http请求工具类
qq_46269365的博客
09-29 606
1、可新建一个ets文件存放请求对象RequestBean和请求接收ResponseBean等对象。2、编写请求方法，传入请求参数，设置Url，处理请求结果等。3、调用，返回请求成功后的数据结果，可进行后续处理。
【HarmonyOS开发】ArkTs使用Http封装
qq_23334071的博客
12-22 2465
应用可以通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。
在 ArkTS 网络请求中，重新封装一下 http 模块
最新发布
读心悦
10-04 1080
注意，这个封装假设服务器返回的是JSON格式的数据，并在成功响应时将其解析为JavaScript对象。如果服务器返回的是其他格式的数据，你需要相应地修改解析逻辑。模块可以提供一个更简洁、更易于使用的API，同时隐藏底层细节，使开发者能够更专注于业务逻辑。以下是一个简单的示例，展示了如何重新封装鸿蒙系统的。方法，分别用于发起GET和POST请求。此外，这个封装没有处理请求超时、重试机制等高级功能。如果你需要这些功能，可以在封装中添加相应的逻辑。在这个封装中，我们创建了一个。在ArkTS中，重新封装。
【鸿蒙应用ArkTS开发系列】- http网络库使用讲解和封装
枫的专栏
05-12 8827
现在网上的应用，基本都是网络应用，需要进行联网获取数据，而常用的联网获取数据的方式有http、socket、websocket等。在鸿蒙应用、服务中，stage模式开发下，鸿蒙官方为我们提供了一个网络组件库 http ,我们通过即可以完成引用。@ohos.net.http (数据请求)该组件提供HTTP数据请求能力。应用可以通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。具体查看官网。
HTTP开发ARKTS
04-13
【HTTP开发ARKTS】在 HarmonyOS 应用开发中，HTTP 数据请求是应用程序与服务器进行数据交互的关键技术。本文将详细介绍如何使用 ArkTS 开发华为云平台应用端的 HTTP 功能，以及相关的开发步骤和接口说明。 首先，...
HarmonyOS鸿蒙开发指南:基于ArkTS开发 公共事件与通知
sybh的博客
01-10 1968
HarmonyOS通过CES（Common Event Service，公共事件服务）为应用程序提供订阅、发布、退订公共事件的能力。公共事件可分为系统公共事件和自定义公共事件。系统公共事件：系统将收集到的事件信息，根据系统策略发送给订阅该事件的用户程序。例如：系统关键服务发布的系统事件（例如：hap安装，更新，卸载等）。自定义公共事件：应用自定义一些公共事件用来实现跨应用的事件通信能力。每个应用都可以按需订阅公共事件，订阅成功且公共事件发布，系统会把其发送给应用。
从零开始的HarmonyOS Next开发指南：打造HarmonyOS NEXT元服务
一键难忘的博客
05-26 5744
DevEco Studio 4.0是一个集成开发环境（IDE），专门为开发者提供一站式的HarmonyOS应用和服务开发支持。以下是DevEco Studio 4.0的一些主要特点：高效智能代码编辑：支持多种语言，如ArkTS、JavaScript、C/C++等，提供代码高亮、智能补齐、错误检查、自动跳转、格式化、查找等功能，以提升代码编写的效率。低代码可视化开发：拥有丰富的UI界面编辑能力，支持自由拖拽组件和可视化数据绑定，能够快速预览效果，所见即所得。
鸿蒙OS开发实例：【工具类封装-http请求】
m0_62167422的博客
03-27 939
import http from '@ohos.net.http'; import promptAction from '@ohos.promptAction'; 封装HTTP接口请求类，提供格式化的响应信息输出功能。 使用 DevEco Studio 3.1.1 Release 及以上版本，API 版本为 api 9 及以上。
封装网络请求 鸿蒙APP HarmonyOS ArkTS
cui884658的博客
07-16 1123
依据 Element-Admin 封装网络请求
HarmonyOS鸿蒙ArkTS，封装http网络请求
qq_62787048的博客
01-25 1925
HarmonyOS鸿蒙ArkTS，封装http网络请求
HarmonyOS鸿蒙ArkTS/ArkUI项目，封装http网络请求，封装公共API以及调用请求的过程实现。
薛定谔的猫的博客
01-04 3961
我们在日常当中开发鸿蒙项目的时候，调用@ohos.net.http (数据请求)方法去请求接口，整个组件的语法糖会很繁琐，我们对@ohos.net.http (数据请求)方法进行一下二次公共API接口封装http网络请求，实现接口的简单方便快捷的调用。
【HarmonyOS Arkts笔记】http网络请求封装
风度
03-05 560
【代码】【HarmonyOS Arkts笔记】http网络请求封装
ArkTs封装网络请求并发起一个Get请求
胡世林的博客
01-02 2077
本文讲的是封装下ArkTs的HTTP请求，做一下公共的拦截，并使用这个lib发起一次请求。
鸿蒙 - arkTs：网络请求封装和使用
Erek的前端博客；
12-25 2227
鸿蒙 - arkTs：网络请求封装和使用
【arkTs】应用开发之http数据请求+调用大模型示例
cocoduco的博客
04-29 975
【代码】【OpenHarmony】arkts应用开发之http数据请求+调用大模型示例。
鸿蒙ArkTs使用axios发起网络请求并对请求参数加密
DL-ZhangTeng的博客
08-22 729
【代码】鸿蒙ArkTs使用axios发起网络请求并对请求参数加密。
HarmonyOS下ArkTS开发纯净浏览器实例教程
ArkTS（ARK TypeScript）是基于TypeScript的开发语言，专为HarmonyOS应用设计，提供了一套开发接口和工具链，以方便开发者用更熟悉的前端技术栈来构建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、付费专栏及课程。

余额充值