鸿蒙【ArkTS】使用TS装饰器封装网络请求HTTP

Hik_0821

已于 2024-07-22 10:18:43 修改

阅读量4.9k

点赞数 19

文章标签：网络 harmonyos http

于 2024-02-21 20:36:49 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_60376559/article/details/136220149

版权

本文介绍了如何在HarmonyOS应用中使用@ohos.net.http模块进行网络请求，并通过TypeScript装饰器实现AOP（面向切面编程）风格，统一接口并管理网络权限和配置。作者详细展示了封装过程和示例代码，包括网络请求配置、核心类和装饰器的使用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在HarmonyOS应用开发中，通过HTTP访问网络，可以使用官方提供的@ohos.net.http模块。但是官方提供的直接使用不太好使用，需要封装下才好。这里采用TS的装饰器实现AOP效果完成前后端接口风格的统一

@ohos.net.http (数据请求)官方示例

// 引入包名
import http from '@ohos.net.http';

// 每一个httpRequest对应一个HTTP请求任务，不可复用
let httpRequest = http.createHttp();
// 用于订阅HTTP响应头，此接口会比request请求先返回。可以根据业务需要订阅此消息
// 从API 8开始，使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 8+
httpRequest.on('headersReceive', (header) => {
   
    console.info('header: ' + JSON.stringify(header));
});
httpRequest.request(
    // 填写HTTP请求的URL地址，可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定
    "EXAMPLE_URL",
    {
   
        method: http.RequestMethod.POST, // 可选，默认为http.RequestMethod.GET
        // 开发者根据自身业务需要添加header字段
        header: {
   
            'Content-Type': 'application/json'
        },
        // 当使用POST请求时此字段用于传递内容
        extraData: {
   
            "data": "data to send",
        },
        expectDataType: http.HttpDataType.STRING, // 可选，指定返回数据的类型
        usingCache: true, // 可选，默认为true
        priority: 1, // 可选，默认为1
        connectTimeout: 60000, // 可选，默认为60000ms
        readTimeout: 60000, // 可选，默认为60000ms
        usingProtocol: http.HttpProtocol.HTTP1_1, // 可选，协议类型默认值由系统自动指定
    }, (err, data) => {
   
        if (!err) {
   
            // data.result为HTTP响应内容，可根据业务需要进行解析
            console.info('Result:' + JSON.stringify(data.result));
            console.info('code:' + JSON.stringify(data.responseCode));
            // data.header为HTTP响应头，可根据业务需要进行解析
            console.info('header:' + JSON.stringify(data.header));
            console.info('cookies:' + JSON.stringify(data.cookies)); // 8+
            // 取消订阅HTTP响应头事件
            httpRequest.off('headersReceive');
            // 当该请求使用完毕时，调用destroy方法主动销毁
            httpRequest.destroy();
        } else {
   
            console.info('error:' + JSON.stringify(err));
            // 取消订阅HTTP响应头事件
            httpRequest.off('headersReceive');
            // 当该请求使用完毕时，调用destroy方法主动销毁。
            httpRequest.destroy();
        }
    }
);

声明网络权限

使用Stage模型的应用，需要在module.json5配置文件中声明权限。

{
   
    "module" : {
   
        "requestPermissions":[
           {
   
             "name": "ohos.permission.INTERNET"
           }
        ]
    }
}

封装实现步骤：

一、统一接口请求结果

export class ApiResult {
   
  code : string
  msg ?: string
  data ?: any
}

二、网络请求配置类

/**
 * <pre>
 * @desc  : 网络请求配置
 * </pre>
 */
export interface RequestOptions {
   

  /**
   * Request url.
   */
  url?: string;

  /**
   * Request method.
   */
  method?: RequestMethod; // default is GET

  /**
   * Additional data of the request.
   * extraData can be a string or an Object (API 6) or an ArrayBuffer(API 8).
   */
  extraData?: string | Object | ArrayBuffer;

  /**
   * Request url queryParams  .
   */
  queryParams ?