文档开发者中心
我的
|

HarmonyOS 5

在 ArkTS 中实现网络请求封装与错误重试机制

如何在 ArkTS 中实现网络请求封装与错误重试机制的代码呢?
点赞
收藏
回复
2
分享
举报
浏览138 发布于2025-12-10 03:11北京
全部评论
最多点赞
最新发布
最早发布

自己封装网络请求有点费劲哦! 不如直接用社区开源的实现方案:axios

https://ohpm.openharmony.cn/#/cn/home

cke_803.png

1楼回复于2025-12-10 03:37 来自北京

场景

我们现在虽然在请求时直接使用 @ohos.net.http 可行,但存在以下痛点:每次请求都要重复写 header 设置、超时配置、JSON 解析,网络不稳定时缺乏自动重试能力;无法统一处理 token 过期、401 未授权等通用错误;缺少请求/响应日志,调试困难等等问题存在,所以我们就需要封装一个可复用、健壮、易维护的 HTTP 客户端。

实现思路

核心点:基于 http.createHttp() 封装基础请求方法

一、支持 GET/POST,并自动解析 JSON 响应。

添加全局配置超时时间;

二、默认 header:Content-Type: application/json

三、实现拦截器机制

请求拦截器:自动注入 token、添加设备信息;

响应拦截器:统一处理业务错误码(如 code !== 200)、跳转登录页。

完整实现代码

收起
自动换行
深色代码主题
复制
import { http } from '@kit.NetworkKit'
import { promptAction, router } from '@kit.ArkUI'
//传输参数token
export const TOKEN_KEY: string = 'token'
//请求网络的基底址
export const BASE_URL: string = 'https://base_url/'
// 最外层数据封装类的
export class ResponsesData<T> {
  code: number = 0
  msg: string = ""
  data: T | null = null
}
interface EmptyInterface {}


// function requestHttp(url: url地址, method: 请求方法类型,默认为get, data?: 参数类型) : 返回类型是: Promise里面的T类型的数据
async function requestHttp<T>(url: string = '', method: http.RequestMethod = http.RequestMethod.GET, data?: object): Promise<T> {
  //创建一个网络请求
  const httpRequest = http.createHttp()
  //拼接地址
  let urlStr = BASE_URL + url
  //get方法需要自己拼接
  if (method = http.RequestMethod.GET) {
    //如果data里面有值并且里面有对象的时候
    if (data && Object.keys(data).length) {
      urlStr += "?" + Object.keys(data).map(key => {
        if (data[key]) {
          return `${key}=${data[key]}` // a=1 =>
        }
        return ""
      }).join('&') //['a=1','b=2','c=3']
    }
  }
  //设置请求对象
  let config: http.HttpRequestOptions = {
    //method同名方法赋值,参数名和属性名相同时只需要写一个method等价于method:method
    method,
    //超时时间
    readTimeout: 10000,
    //get的extraData参数在上面处理过了 在这儿不需要再传一遍
    extraData: method === http.RequestMethod.GET ? '' : data || {} as EmptyInterface,
    //响应参数的类型,指定为对象后有BUG,当结果有问题时,项目会直接瘫痪
    // expectDataType: http.HttpDataType.OBJECT,
    //请求头
    header: {
      'Content-Type': 'application/json',
      "Authorization": AppStorage.get(TOKEN_KEY) as string || ''
    }
  }
  //发请求
  try {

    const res = await httpRequest.request(urlStr, config)
    console.log('请求url地址', urlStr)
    //res.responseCode响应状态码,这里的401还会认为是请求成功
    if (res.responseCode === 401) {
      //401 token超时
      //删除持久化数据token
      AppStorage.set<string>(TOKEN_KEY, '')
      promptAction.showToast({ message: 'token超时!' })
      //回登录
      router.replaceUrl({
        url: 'pages/Login/LoginPage'
      })
      //返回错误 终止
      return Promise.reject(new Error('token超时!'))
    } else if (res.responseCode === 404) {
      promptAction.showToast({ message: '请求地址不正确!' })
      return Promise.reject(new Error('请求地址不正确!'))
    } else {
      //指定为字符串,然后再转成一个对象,类型是不明确的要使用泛型,返回第一层+泛型,泛型的定义是一个类和之前的有所差距
      const result = JSON.parse(res.result as string) as ResponsesData<T>
      //再判断返回的状态码进行处理,不是200都是失败
      if (result.code === 200) {
        return result.data as T
      } else {
        promptAction.showToast({ message: '服务器异常!' })
        return Promise.reject(new Error(result.msg))
      }
    }
  } catch (error) {
    promptAction.showToast({ message: error })
    return Promise.reject(error)
  }
  //执行最后销毁请求
  finally {
    //销毁请求请求结束
    httpRequest.destroy()
  }
}

//封装一个静态类的方法出来使用
export class Request {
  static get<T>(url: string, data?: object): Promise<T> {
    return requestHttp<T>(url, http.RequestMethod.GET, data)
  }

  static post<T>(url: string, data?: object): Promise<T> {
    return requestHttp<T>(url, http.RequestMethod.POST, data)
  }

  static put<T>(url: string, data?: object): Promise<T> {
    return requestHttp<T>(url, http.RequestMethod.PUT, data)
  }

  static delete<T>(url: string, data?: object): Promise<T> {
    return requestHttp<T>(url, http.RequestMethod.DELETE, data)
  }
}
展开全部
2楼回复于2025-12-10 05:03 来自北京
写回答
新增插入模板功能
一键使用模板,快速填写内容,轻松发帖~
知道了
  • 为了保障您的信息安全,请勿上传您的敏感个人信息(如您的密码等信息)和您的敏感资产信息(如关键源代码、签名私钥、调试安装包、业务日志等信息),且您需自行承担由此产生的信息泄露等安全风险。
  • 如您发布的内容为转载内容,请注明内容来源。

我要提问题

了解社区公约,与您携手共创和谐专业的开发者社区。