阅读 77

axios 一般够用封装

这是我参与8月更文挑战的第1天,活动详情查看:8月更文挑战

前言

对 axios 封装进行够用层面的剖析。至于axios的一些其它东东请自行了解。

Axios 封装

1,构建全局的axios总实例

首先在整个项目中引入axios的包;然后构建一个用于管理请求的文件http.js,在该文件中进行主要的二次封装。

// http.js
import axios from "axios";

const instance = axios.create({
  timeout: 15000,
  // baseURL: "http://127.0.0.1:7001",
});

// 添加请求拦截器
// instance.interceptors.request.use();

// 添加响应拦截器
// instance.interceptors.response.use();

export const api = async (url, method = "get", targrt) => {
  const info = await instance({
    url,
    method,
    ...targrt,
  });
  return info;
};
复制代码

在http.js 中新建一个 axios 实例,设置一些基础配置,如请求过期时间(baseurl一般是通过配置文件来设置,用于适配不同环境);然后再设置对应的拦截器:在请求拦截器中按业务需求可以在此处设置请求头中的token信息用于校验用户信息;在响应拦截器中主要的作用是进行错误处理,在错误处理函数中根据错误体做出对应的业务处理,如错误提示。

2,添加一些可能有用的方法

中止请求

在工作中我还真没用上过这个方法,因为此需求场景一般是按钮短时间重复点击或搜索 中止请求要用上axios中cancelToken属性。 首先定义一个用于记录当前处于 pending 状态的请求的Map对象,在请求拦截其中进行对应请求pinding状态记录,在响应拦截器中移除对应请求的pending状态记录。(对于相同的请求,可自行决定是用最开始的还是最新的)

错误重传

错误重传顾名思义,是请求发生了错误,需自动发起一个新的完全一样的请求。error的config详细记录了错误请求的config数据,故发起一次错误重传就是让全局的axios实例带上此config再次进行一次数据请求。

以上两种方法具体实现参考本文 # axios 请求终极封装【取消重复请求,请求失败自动重试,请求接口数据缓存】

这些方式代码主要放置于拦截器中,样例如下:

// http.js
// 添加请求拦截器
instance.interceptors.request.use(
  function (config) {
    // 在发送请求之前做些什么
    removePendingRequest(config);
    addPendingRequest(config);
    return config;
  },
  function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
  }
);

// 添加响应拦截器
instance.interceptors.response.use(
  (response) => {
    // 对响应数据做点什么
    removePendingRequest(response.config);
    return response;
  },
  (error) => {
    // 对响应错误做点什么
    requestAgainSend(error, instance);
    removePendingRequest(error.config); // cancleToken 中断请求
    if (Object.keys(error)[0] === "message") {
      console.log("原来同一请求已被中断");
      return;
    }
    return Promise.reject(error);
  }
);
复制代码

源码在这里(index.js 为本文提到的 http.js,中止请求和错误重传代码在 auxiliary.js 中),本文的分享就结束了,欢迎大家提出宝贵建议!(ps: 感觉主要做的还是一些记录.......)

文章分类
前端
文章标签