如何自定义alova的请求适配器

2023-11-30 00:02:00 浏览数 (1)

alova是一个轻量级的请求策略库,旨在简化接口的管理和使用。通过简单配置参数,您可以实现诸如共享请求、分页请求、表单提交、断点续传等复杂请求,而无需编写大量代码,从而提高开发效率、应用性能,并减少服务器压力。

在使用alova发送网络请求时,我们通常需要向请求头添加一些信息,比如身份验证令牌、公共参数等。alova提供了在全局和单个请求粒度上配置请求头的两种方式。添加请求头的方法与axios非常相似。

了解请求适配器

还记得如何创建Alova实例吗?

代码语言:javascript复制
const alovaInstance = createAlova({
   // ...
   requestAdapter: GlobalFetch()
});

是的,requestAdapter就是一个请求适配器。内部请求的发送和接收将依赖于请求适配器。GlobalFetch通过fetch api管理请求。在大多数情况下,我们可以使用它,但是当alova运行在不支持fetch api的环境中(如app、小程序)时,您需要替换一个支持当前环境的请求适配器。

编写自定义请求适配器

那么如何自定义请求适配器呢?非常简单,它实际上就是一个函数。每次发出请求时都会调用此函数,并返回一个对象。此对象包含诸如url、method、data、headers、timeout等请求相关数据集合。虽然字段有很多,但我们只需要访问我们需要的数据。

请求适配器结构

请求适配器将接收与请求相关的参数和当前请求的方法实例,并返回响应相关函数的集合。

代码语言:javascript复制
function CustomRequestAdapter(requestElements, methodInstance) {
   // 发送请求...
   return {
     async response() {
       // ...返回响应数据
     },
     async headers() {
       // 异步函数,返回响应头
     },
     abort() {
       // 中断请求,在手动中断请求章节中调用abort时会触发此函数
     },
     onDownload(updateDownloadProgress) {
       // 下载进度信息,updateDownloadProgress在内部被连续调用以更新下载进度
     },
     onUpload(updateUploadProgress) {
       // 上传进度信息,updateUploadProgress在内部被连续调用以更新上传进度
     }
   };
}

请求参数细节

requestElements

发送请求的相关元素,包括以下数据。

代码语言:javascript复制
interface RequestElements {
   // 请求url,其中包含了获取参数
   readonly url: string;

   // 请求类型,例如GET、POST、PUT等
   readonly type: MethodType;

   // 请求头信息,对象
   readonly headers: Arg;

   // 请求体信息
   readonly data?: RequestBody;
}

methodInstance

当前请求的方法实例

返回参数细节

response(必需)

一个异步函数,返回响应值,它将传递给全局响应拦截器(responded);

headers(必需)

一个异步函数,函数返回的响应头对象将传递给方法实例的transformData转换钩子函数;

abort(必需)

一个通用函数,用于中断请求。在手动中断请求章节中调用abort函数时,实际触发中断请求的函数是这个中断函数;

onDownload(可选)

一个普通函数,接收一个回调函数,用于更新下载进度。在此函数内自定义进度更新的频率。在此示例中,模拟每100毫秒更新一次。updateDownloadProgress回调函数接收两个参数,第一个参数是总大小,第二个参数是已下载的大小;

onUpload(可选)

一个普通函数,接收一个回调函数,用于更新上传进度。在

此函数内自定义进度更新的频率。在此示例中,模拟每100毫秒更新一次。updateUploadProgress回调函数接收两个参数,第一个参数是总大小,第二个参数是已上传的大小;

(案例)XMLHttpRequest请求适配器

以下是通过XMLHttpRequest发送请求的适配器示例。主要用于演示如何编写适配器。代码是不完整的,无法运行。

代码语言:javascript复制
function XMLHttpRequestAdapter(requestElements, methodInstance) {
   // 解构所需数据
   const { url, type, data, headers } = config;

   // 发送请求
   const xhr = new XMLHttpRequest();
   xhr.open(type, url);
   for (const key in headers) {
     xhr.setRequestHeader(key, headers[key]);
   }
   const responsePromise = new Promise((resolve, reject) => {
     xhr.addEventListener('load', event => {
       // 处理响应数据
       resolve(/* ... */);
     });
     xhr.addEventListener('error', event => {
       // 处理请求错误
       reject(/* ... */);
     });
   });

   xhr.send(JSON.stringify(data));

   return {
     // 返回响应数据的异步函数
     response: () => responsePromise,

     // 返回响应头的异步函数
     headers: () => responsePromise.then(() => xhr.getAllResponseHeaders()),
     abort: () => {
       xhr.abort();
     },

     // 下载进度信息,updateDownloadProgress在内部被连续调用以更新下载进度
     onDownload: updateDownloadProgress => {
       xhr.addEventListener('progress', event => {
         // 数据接收进度
         updateDownloadProgress(event.total, event.loaded);
       });
     },

     // 上传进度信息,updateUploadProgress在内部被连续调用以更新上传进度
     onUpload: updateUploadProgress => {
       xhr.upload.onprogress = event => {
         updateUploadProgress(event.total, event.loaded);
       };
     }
   };
}

结尾

以上是如何编写alova的自定义请求适配器,可以灵活处理不同的请求头设置要求。

我正在参与2023腾讯技术创作特训营第三期有奖征文,组队打卡瓜分大奖!

0 人点赞