HarmonyOS开发:基于http开源一个网络请求库

前言

网络封装的目的,在于简洁,使用起来更加的方便,也易于我们进行相关动作的设置,如果,我们不封装,那么每次请求,就会重复大量的代码逻辑,如下代码,是官方给出的案例:

TypeScript 复制代码
// 引入包名
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();
        }
    }
);

以上的案例,每次请求书写这么多代码,在实际的开发中,是无法承受的,所以基于此,封装是很有必要的,把公共的部分进行抽取包装,固定不变的参数进行初始化设置,重写基本的请求方式,这是我们封装的基本宗旨。

我们先看一下封装之后的调用方式:

异步请求

TypeScript 复制代码
Net.get("url").requestString((data) => {
  //data 为 返回的json字符串
})

同步请求

TypeScript 复制代码
const data = await Net.get("url").returnData<string>(ReturnDataType.STRING)
//data 为 返回的json字符串

装饰器请求

TypeScript 复制代码
@GET("url")
private getData():Promise<string> {
  return null
}

封装之后,不仅使用起来更加的便捷,而且还拓展了请求类型,满足不同需求的场景。

本篇的文章内容大致如下:

1、net库主要功能点介绍

2、net库快速依赖使用

3、net库全局初始化

4、异步请求介绍

5、同步请求介绍

6、装饰器请求介绍

7、上传下载介绍

8、Dialog加载使用

9、相关总结

一、net库主要功能点介绍

目前net库一期已经开发完毕,har包使用,大家可以看第二项,截止到发文前,所支持的功能如下:

■ 支持全局初始化

■ 支持统一的BaseUrl

■ 支持全局错误拦截

■ 支持全局头参拦截

■ 支持同步方式请求(get/post/delete/put/options/head/trace/connect)

■ 支持异步方式请求(get/post/delete/put/options/head/trace/connect)

■ 支持装饰器方式请求(get/post/delete/put/options/head/trace/connect)

■ 支持dialog加载

■ 支持返回Json字符串

■ 支持返回对象

■ 支持返回数组

■ 支持返回data一层数据

■ 支持上传文件

■ 支持下载文件

□ 数据缓存开发中......

二、net库快速依赖使用

私服和远程依赖,由于权限和审核问题,预计需要等到2024年第一季度面向所有开发者,所以,只能使用本地静态共享包和源码 两种使用方式,本地静态共享包类似Android中的aar依赖,直接复制到项目中即可,目前源码还在优化中,先暴露静态共享包这一使用方式。

本地静态共享包har包使用

首先,下载har包,点击下载

下载之后,把har包复制项目中,目录自己创建,如下,我创建了一个libs目录,复制进去

引入之后,进行同步项目,点击Sync Now即可,当然了你也可以,将鼠标放置在报错处会出现提示,在提示框中点击Run 'ohpm install'

需要注意,@app/net,是用来区分目录的,可以自己定义,比如@aa/bb等,关于静态共享包的创建和使用,请查看如下我的介绍,这里就不过多介绍。

HarmonyOS开发:走进静态共享包的依赖与使用

查看是否引用成功

无论使用哪种方式进行依赖,最终都会在使用的模块中,生成一个oh_modules文件,并创建源代码文件,有则成功,无则失败,如下:

三、net库全局初始化

推荐在AbilityStage进行初始化,初始化一次即可,初始化参数可根据项目需要进行选择性使用。

TypeScript 复制代码
Net.getInstance().init({
  baseUrl: "https://www.vipandroid.cn", //设置全局baseurl
  connectTimeout: 10000, //设置连接超时
  readTimeout: 10000, //设置读取超时
  netErrorInterceptor: new MyNetErrorInterceptor(), //设置全局错误拦截,需要自行创建,可在这里进行错误处理
  netHeaderInterceptor: new MyNetHeaderInterceptor(), //设置全局头拦截器,需要自行创建
  header: {}, //头参数
  resultTag: []//接口返回数据参数,比如data,items等等
})

1、初始化属性介绍

初始化属性,根据自己需要选择性使用。

|----------------------|-----------------------|-----------------------------------|
| 属性 | 类型 | 概述 |
| baseUrl | string | 一般标记为统一的请求前缀,也就是域名 |
| connectTimeout | number | 连接超时,默认10秒 |
| readTimeout | number | 读取超时,默认10秒 |
| netErrorInterceptor | INetErrorInterceptor | 全局错误拦截器,需继承INetErrorInterceptor |
| netHeaderInterceptor | INetHeaderInterceptor | 全局请求头拦截器,需继承INetHeaderInterceptor |
| header | Object | 全局统一的公共头参数 |
| resultTag | Array | 接口返回数据参数,比如data,items等等 |

2、设置请求头拦截

关于全局头参数传递,可以通过以上的header参数或者在请求头拦截里均可,如果没有同步等逻辑操作,只是固定的头参数,建议直接使用header参数。

名字自定义,实现INetHeaderInterceptor接口,可在netHeader方法里打印请求头或者追加请求头。

TypeScript 复制代码
import { HttpHeaderOptions, NetHeaderInterceptor } from '@app/net'

class MyNetHeaderInterceptor implements NetHeaderInterceptor {
  getHeader(options: HttpHeaderOptions): Promise<Object> {
    //可以进行接口签名,传入头参数
    return null
  }
}

HttpHeaderOptions对象

返回了一些常用参数,可以用于接口签名等使用。

TypeScript 复制代码
export class HttpHeaderOptions {
  url?: string //请求地址
  method?: http.RequestMethod //请求方式
  header?: Object //头参数
  params?: Object //请求参数
}

3、设置全局错误拦截器

名字自定义,实现INetErrorInterceptor接口,可在httpError方法里进行全局的错误处理,比如统一跳转,统一提示等。

TypeScript 复制代码
import { NetError } from '@app/net/src/main/ets/error/NetError';
import { INetErrorInterceptor } from '@app/net/src/main/ets/interceptor/INetErrorInterceptor';

export class MyNetErrorInterceptor implements INetErrorInterceptor {
  httpError(error: NetError) {
    //这里进行拦截错误信息

  }
}
NetError对象

可通过如下方法获取错误code和错误描述信息。

TypeScript 复制代码
/*
   * 返回code
   * */
getCode():number{
  return this.code
}

/*
* 返回message
* */
getMessage():string{
  return this.message
}

四、异步请求介绍

1、请求说明

为了方便数据的针对性返回,目前异步请求提供了三种请求方法,在实际的 开发中,大家可以针对需要,选择性使用。

request方法
TypeScript 复制代码
Net.get("url").request<TestModel>((data) => {
  //data 就是返回的TestModel对象
})

此方法,针对性返回对应的data数据对象,如下json,则会直接返回需要的data对象,不会携带外层的code等其他参数,方便大家直接的拿到数据。

{
  "code": 0,
  "message": "数据返回成功",
  "data": {}
}

如果你的data是一个数组,如下json:

{
  "code": 0,
  "message": "数据返回成功",
  "data": []
}

数组获取

TypeScript 复制代码
Net.get("url").request<TestModel[]>((data) => {
  //data 就是返回的TestModel[]数组
})

//或者如下

Net.get("url").request<Array<TestModel>>((data) => {
  //data 就是返回的TestModel数组
})

可能大家有疑问,如果接口返回的json字段不是data怎么办?如下:

举例一

{
  "code": 0,
  "message": "数据返回成功",
  "items": {}
}

举例二

{
  "code": 0,
  "message": "数据返回成功",
  "models": {}
}

虽然网络库中默认取的是json中的data字段,如果您的数据返回类型字段有多种,如上json,可以通过全局初始化resultTag进行传递或者局部setResultTag传递即可。

全局设置接口返回数据参数【推荐】

全局设置,具体设置请查看上边的全局初始化一项,只设置一次即可,不管你有多少种返回参数,都可以统一设置。

TypeScript 复制代码
 Net.getInstance().init({
  resultTag: ["data", "items", "models"]//接口返回数据参数,比如data,items等等
})

局部设置接口返回数据参数

通过setResultTag方法设置即可。

TypeScript 复制代码
Net.get("")
  .setResultTag(["items"])
  .request<TestModel>((data) => {

  })
requestString方法

requestString就比较简单,就是普通的返回请求回来的json字符串。

TypeScript 复制代码
Net.get("url").requestString((data) => {
  //data 为 返回的json字符串
})
requestObject方法

requestObject方法也是获取对象,和request不同的是,它不用设置返回参数,因为它是返回的整个json对应的对象, 也就是包含了code,message等字段。

TypeScript 复制代码
Net.get("url").requestObject<TestModel>((data) => {
  //data 为 返回的TestModel对象
})

为了更好的复用共有字段,你可以抽取一个基类,如下:

TypeScript 复制代码
export class ApiResult<T> {
  code: number
  message: string
  data: T
}

以后就可以如下请求:

TypeScript 复制代码
Net.get("url").requestObject<ApiResult<TestModel>>((data) => {
  //data 为 返回的ApiResult对象
})
回调函数

回调函数有两个,一个成功一个失败,成功回调必调用,失败可选择性调用。

只带成功

TypeScript 复制代码
Net.get("url").request<TestModel>((data) => {
  //data 为 返回的TestModel对象
})

成功失败都带

TypeScript 复制代码
Net.get("url").request<TestModel>((data) => {
  //data 为 返回的TestModel对象
}, (error) => {
  //失败
})

2、get请求

TypeScript 复制代码
 Net.get("url").request<TestModel>((data) => {
  //data 为 返回的TestModel对象
})

3、post请求

TypeScript 复制代码
Net.post("url").request<TestModel>((data) => {
  //data 为 返回的TestModel对象
})

4、delete请求

TypeScript 复制代码
 Net.delete("url").request<TestModel>((data) => {
  //data 为 返回的TestModel对象
})

5、put请求

TypeScript 复制代码
Net.put("url").request<TestModel>((data) => {
  //data 为 返回的TestModel对象
})

6、其他请求方式

除了常见的请求之外,根据系统api所提供的,也封装了如下的请求方式,只需要更改请求方式即可,比如Net.options。

OPTIONS
HEAD
TRACE
CONNECT

7、各个方法调用

除了正常的请求方式之外,你也可以调用如下的参数:

|---------------------------|-------------------------------|-------------------------|
| 方法 | 类型 | 概述 |
| setHeaders | Object | 单独添加请求头参数 |
| setBaseUrl | string | 单独替换BaseUrl |
| setParams | string / Object / ArrayBuffer | 单独添加参数,用于post |
| setConnectTimeout | number | 单独设置连接超时 |
| setReadTimeout | number | 单独设置读取超时 |
| setExpectDataType | http.HttpDataType | 设置指定返回数据的类型 |
| setUsingCache | boolean | 使用缓存,默认为true |
| setPriority | number | 设置优先级 默认为1 |
| setUsingProtocol | http.HttpProtocol | 协议类型默认值由系统自动指定 |
| setResultTag | Array | 接口返回数据参数,比如data,items等等 |
| setContext | Context | 设置上下文,用于下载文件 |
| setCustomDialogController | CustomDialogController | 传递的dialog控制器,用于展示dialog |

代码调用如下:

TypeScript 复制代码
Net.get("url")
  .setHeaders({})//单独添加请求头参数
  .setBaseUrl("")//单独替换BaseUrl
  .setParams({})//单独添加参数
  .setConnectTimeout(10000)//单独设置连接超时
  .setReadTimeout(10000)//单独设置读取超时
  .setExpectDataType(http.HttpDataType.OBJECT)//设置指定返回数据的类型
  .setUsingCache(true)//使用缓存,默认为true
  .setPriority(1)//设置优先级 默认为1
  .setUsingProtocol(http.HttpProtocol.HTTP1_1)//协议类型默认值由系统自动指定
  .setResultTag([""])//接口返回数据参数,比如data,items等等
  .setContext(this.context)//设置上下文,用于上传文件和下载文件
  .setCustomDialogController()//传递的dialog控制器,用于展示dialog
  .request<TestModel>((data) => {
    //data 为 返回的TestModel对象
  })

五、同步请求介绍

同步请求需要注意,需要await关键字和async关键字结合使用。

TypeScript 复制代码
 private async getTestModel(){
  const testModel = await Net.get("url").returnData<TestModel>()
}

1、请求说明

同步请求和异步请求一样,也是有三种方式,是通过参数的形式,默认直接返回data层数据。

返回data层数据

和异步种的request方法类似,只返回json种的data层对象数据,不会返回code等字段。

TypeScript 复制代码
 private async getData(){
  const data = await Net.get("url").returnData<TestModel>()
  //data为 返回的 TestModel对象
}
返回Json对象

和异步种的requestObject方法类似,会返回整个json对象,包含code等字段。

TypeScript 复制代码
 private async getData(){
  const data = await Net.get("url").returnData<TestModel>(ReturnDataType.OBJECT)
  //data为 返回的 TestModel对象
}
返回Json字符串

和异步种的requestString方法类似。

TypeScript 复制代码
private async getData(){
  const data = await Net.get("url").returnData<string>(ReturnDataType.STRING)
  //data为 返回的 json字符串
}
返回错误

异步方式有回调错误,同步方式如果发生错误,也会直接返回错误,结构如下:

{
  "code": 0,
  "message": "错误信息"
}

除了以上的错误捕获之外,你也可以全局异常捕获,

2、get请求

TypeScript 复制代码
const data = await Net.get("url").returnData<TestModel>()

3、post请求

TypeScript 复制代码
const data = await Net.post("url").returnData<TestModel>()

4、delete请求

TypeScript 复制代码
const data = await Net.delete("url").returnData<TestModel>()

5、put请求

TypeScript 复制代码
const data = await Net.put("url").returnData<TestModel>()

6、其他请求方式

除了常见的请求之外,根据系统api所提供的,也封装了如下的请求方式,只需要更改请求方式即可,比如Net.options

OPTIONS
HEAD
TRACE
CONNECT

7、各个方法调用

除了正常的请求方式之外,你也可以调用如下的参数:

|---------------------------|-------------------------------|-------------------------|
| 方法 | 类型 | 概述 |
| setHeaders | Object | 单独添加请求头参数 |
| setBaseUrl | string | 单独替换BaseUrl |
| setParams | string / Object / ArrayBuffer | 单独添加参数,用于post |
| setConnectTimeout | number | 单独设置连接超时 |
| setReadTimeout | number | 单独设置读取超时 |
| setExpectDataType | http.HttpDataType | 设置指定返回数据的类型 |
| setUsingCache | boolean | 使用缓存,默认为true |
| setPriority | number | 设置优先级 默认为1 |
| setUsingProtocol | http.HttpProtocol | 协议类型默认值由系统自动指定 |
| setResultTag | Array | 接口返回数据参数,比如data,items等等 |
| setContext | Context | 设置上下文,用于下载文件 |
| setCustomDialogController | CustomDialogController | 传递的dialog控制器,用于展示dialog |

代码调用如下:

TypeScript 复制代码
const data = await Net.get("url")
  .setHeaders({})//单独添加请求头参数
  .setBaseUrl("")//单独替换BaseUrl
  .setParams({})//单独添加参数
  .setConnectTimeout(10000)//单独设置连接超时
  .setReadTimeout(10000)//单独设置读取超时
  .setExpectDataType(http.HttpDataType.OBJECT)//设置指定返回数据的类型
  .setUsingCache(true)//使用缓存,默认为true
  .setPriority(1)//设置优先级 默认为1
  .setUsingProtocol(http.HttpProtocol.HTTP1_1)//协议类型默认值由系统自动指定
  .setResultTag([""])//接口返回数据参数,比如data,items等等
  .setContext(this.context)//设置上下文,用于上传文件和下载文件
  .setCustomDialogController()//传递的dialog控制器,用于展示dialog
  .returnData<TestModel>()
//data为 返回的 TestModel对象

六、装饰器请求介绍

网络库允许使用装饰器的方式发起请求,也就是通过注解的方式,目前采取的是装饰器方法的形式。

1、请求说明

装饰器和同步异步有所区别,只返回两种数据类型,一种是json字符串,一种是json对象,暂时不提供返回data层数据。 在使用的时候,您可以单独创建工具类或者ViewModel或者直接使用,都可以。

返回json字符串
TypeScript 复制代码
@GET("url")
private getData():Promise<string> {
  return null
}
返回json对象
TypeScript 复制代码
@GET("url")
private getData():Promise<TestModel> {
  return null
}

2、get请求

TypeScript 复制代码
@GET("url")
private getData():Promise<TestModel> {
  return null
}

3、post请求

TypeScript 复制代码
@POST("url")
private getData():Promise<TestModel> {
  return null
}

4、delete请求

TypeScript 复制代码
@DELETE("url")
private getData():Promise<TestModel> {
  return null
}

5、put请求

TypeScript 复制代码
@PUT("url")
private getData():Promise<TestModel> {
  return null
}

6、其他请求方式

除了常见的请求之外,根据系统api所提供的,也封装了如下的请求方式,只需要更改请求方式即可,比如@OPTIONS。

OPTIONS
HEAD
TRACE
CONNECT

当然,大家也可以使用统一的NET装饰器,只不过需要自己设置请求方法,代码如下:

@NET("url", { method: http.RequestMethod.POST })
private getData():Promise<string> {
  return null
}

7、装饰器参数传递

直接参数传递

直接参数,在调用装饰器请求时,后面添加即可,一般针对固定参数。

TypeScript 复制代码
@GET("url", {
  baseUrl: "", //baseUrl
  header: {}, //头参数
  params: {}, //入参
  connectTimeout: 1000, //连接超时
  readTimeout: 1000, //读取超时
  isReturnJson: true//默认false 返回Json字符串,默认返回json对象
})
private getData():Promise<string> {
  return null
}
动态参数传递

动态参数适合参数可变的情况下传递,比如分页等情况。

TypeScript 复制代码
@GET("url")
private getData(data? : HttpOptions):Promise<string> {
  return null
}

调用时传递

TypeScript 复制代码
private async doHttp(){
  const data = await this.getData({
    baseUrl: "", //baseUrl
    header: {}, //头参数
    params: {}, //入参
    connectTimeout: 1000, //连接超时
    readTimeout: 1000, //读取超时
    isReturnJson: true//默认false 返回Json字符串,默认返回json对象
  })
}
装饰器参数传递

使用DATA装饰器,DATA必须在上!

TypeScript 复制代码
@DATA({
  baseUrl: "", //baseUrl
  header: {}, //头参数
  params: {}, //入参
  connectTimeout: 1000, //连接超时
  readTimeout: 1000, //读取超时
  isReturnJson: true//默认false 返回Json字符串,默认返回json对象
})
@GET("url")
private getData():Promise<string> {
  return null
}

七、上传下载介绍

1、上传文件

TypeScript 复制代码
Net.uploadFile("")//上传的地址
  .setUploadFiles([])//上传的文件 [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }]
  .setUploadData([])//上传的参数 [{ name: "name123", value: "123" }]
  .setProgress((receivedSize, totalSize) => {
    //监听上传进度
  })
  .request((data) => {
    if (data == UploadTaskState.COMPLETE) {
      //上传完成
    }
  })
方法介绍

|----------------|--------|--------------------------------------------------------------------|
| 方法 | 类型 | 概述 |
| uploadFile | string | 上传的地址 |
| setUploadFiles | Array | 上传的文件数组 |
| setUploadData | Array | 上传的参数数组 |
| setProgress | 回调函数 | 监听进度,receivedSize下载大小, totalSize总大小 |
| request | 无 | 请求上传,data类型为UploadTaskState,有三种状态:START(开始),COMPLETE(完成),ERROR(错误) |

其他方法
删除上传进度监听
TypeScript 复制代码
uploadRequest.removeProgressCallback()
删除上传任务
TypeScript 复制代码
uploadRequest.deleteUploadTask((result) => {
  if (result) {
    //成功
  } else {
    //失败
  }
})

2、下载文件

TypeScript 复制代码
Net.downLoadFile("http://10.47.24.237:8888/harmony/log.har")
  .setContext(EntryAbility.context)
  .setFilePath(EntryAbility.filePath)
  .setProgress((receivedSize, totalSize) => {
    //监听下载进度
  })
  .request((data) => {
    if (data == DownloadTaskState.COMPLETE) {
      //下载完成
    }
  })
方法介绍

|--------------|---------|---------------------------------------------------------------------------------|
| 方法 | 类型 | 概述 |
| downLoadFile | string | 下载的地址 |
| setContext | Context | 上下文 |
| setFilePath | string | 下载后保存的路径 |
| setProgress | 回调函数 | 监听进度,receivedSize下载大小, totalSize总大小 |
| request | 无 | 请求下载,data类型为DownloadTaskState,有四种状态:START(开始),COMPLETE(完成),PAUSE(暂停),REMOVE(结束) |

其他方法
移除下载的任务
TypeScript 复制代码
    downLoadRequest.deleteDownloadTask((result) => {
  if (result) {
    //移除成功
  } else {
    //移除失败
  }
})
暂停下载任务
TypeScript 复制代码
downLoadRequest.suspendDownloadTask((result) => {
  if (result) {
    //暂停成功
  } else {
    //暂停失败
  }
})
重新启动下载任务
TypeScript 复制代码
downLoadRequest.restoreDownloadTask((result) => {
  if (result) {
    //成功
  } else {
    //失败
  }
})
删除监听下载进度
TypeScript 复制代码
downLoadRequest.removeProgressCallback()

八、Dialog加载使用

1、定义dialog控制器

NetLoadingDialog是net包中自带的,菊花状弹窗,如果和实际业务不一致,可以更换。

TypeScript 复制代码
private mCustomDialogController = new CustomDialogController({
  builder: NetLoadingDialog({
    loadingText: '请等待...'
  }),
  autoCancel: false,
  customStyle: true
})

2、调用传递控制器方法

此方法会自动显示和隐藏dialog,如果觉得不合适,大家可以自己定义即可。

TypeScript 复制代码
setCustomDialogController(this.mCustomDialogController)

九、相关总结

开发环境如下:

DevEco Studio 4.0 Beta2,Build Version: 4.0.0.400

Api版本:9

hvigorVersion:3.0.2

目前呢,暂时不支持缓存,后续会逐渐加上,大家在使用的过程中,需要任何的问题,都可以进行反馈,都会第一时间进行解决。