--- highlight: a11y-dark --- ## 前言网络封装的目的，在于简洁，使用起来更加的方便，也易于我们进行相关动作的设置，如果，我们不封装，那么每次请求，就会重复大量的代码逻辑，如下代码，是官方给出的案例： ```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(ReturnDataType.STRING) //data 为返回的json字符串 ``` ### 装饰器请求 ```TypeScript @GET("url") private getData():Promise { 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包，[点击下载](https://github.com/AbnerMing888/HarmonyOsNet/raw/master/net.har) 下载之后，把har包复制项目中，目录自己创建，如下，我创建了一个libs目录，复制进去

引入之后，进行同步项目，点击Sync Now即可，当然了你也可以，将鼠标放置在报错处会出现提示，在提示框中点击Run '**ohpm install**'。需要注意，@app/net，是用来区分目录的，可以自己定义，比如@aa/bb等，关于静态共享包的创建和使用，请查看如下我的介绍，这里就不过多介绍。 [HarmonyOS开发：走进静态共享包的依赖与使用](https://juejin.cn/post/7274982412245876776) ### 查看是否引用成功无论使用哪种方式进行依赖，最终都会在使用的模块中，生成一个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