开箱即用的axios Api请求封装 拦截重复请求,并将请求结果共享给所有请求的地方。支持get/post等多种请求方式,支持文件上传,支持自定义headers

之前做项目的时候经常遇到个问题:相同url相同参数的接口,短时间内重复请求调用

产生的原因有多种:

按钮未做防抖/节流/锁,高频点击(实际上项目中所有按钮都加上防抖/节流/锁处理是不现实的);

相同信息同页面的异构展示,每个地方独立获取数据(不够优雅的架构等);

代码没优化好,但是历史代码逻辑复杂,不敢重构......

最开始想要做的优化方案是:对每一个请求做记录(通过url和param),请求发起前检测是否存在已发出的接口,如果有则打断。但是有一个问题,被打断的接口没有返回,不符合一些特殊的业务场景。

于是在原有的axios封装上不断优化,历时两天,终于撸出最终版:

目录结构如图。

首先封装工具函数:requestMeans.js

import qs from 'qs'; //参数编译
import { getToken } from '@/storage';

let pending = []; //用于存储每个ajax请求的取消函数和ajax标识
let task = {}; //用于存储每个ajax请求的处理函数,通过请求结果调用,以ajax标识为key

//请求开始前推入pending
export const pushPending = (item) => {
  pending.push(item);
};
//请求完成后取消该请求,从列表删除
export const removePending = (e) => {
  let key = e.baseURL + '?' + (e.method == 'post' ? e.data : qs.stringify(e.params));
  for (let p in pending) {
    if (pending[p].key === key) {
      //当前请求在列表中存在时
      pending[p].cancelToken(); //执行取消操作
      pending.splice(p, 1); //把这条记录从列表中移除
    }
  }
};

// 创建task
export const createTask = (key, resolve) => {
  let callback = (response) => {
    if (response.data.status === -1) {
      // 这里处理授权逻辑
    } else if (response.data.status) {
      // 这里做全局错误提示
    }
    resolve(response.data);
  };
  if (!task[key]) task[key] = [];
  task[key].push(callback);
};
// 处理task
export const handleTask = (key, response) => {
  for (let i = 0; task[key] && i < task[key].length; i++) {
    task[key][i](response);
  }
  task[key] = undefined;
};

// data处理:存在token则加入
export const dataAddToken = (data) => {
  const token = getToken();
  if (token) {
    data['token'] = token;
  }
  return data;
};

请求封装:request.js

import qs from 'qs'; //参数编译
import axios from 'axios';

import { pushPending, removePending, createTask, handleTask, dataAddToken } from './requestMeans';

const getHeaders = { 'Content-Type': 'application/json' } ;
const postHeaders = { 'Content-Type': 'application/x-www-form-urlencoded' } ;
const fileHeaders = { 'Content-Type': 'multipart/form-data' } ;

const baseURL = 'https://mock.apipost.cn/app/mock/project/f0a1c097-861b-473f-b0d4-a706fbe0af91';

//请求封装
export const request = (method, url, params, headers, preventRepeat = true, uploadFile = false) => {
  let key = baseURL + url + '?' + qs.stringify(params);
  return new Promise((resolve, reject) => {
    const instance = axios.create({
      baseURL: baseURL + url,
      headers,
      timeout: 30 * 1000,
    });

    instance.interceptors.request.use(
      (config) => {
        if (preventRepeat) {
          removePending(config); //防止多次触发请求
          config.cancelToken = new axios.CancelToken((cancelToken) => {
            pushPending({ key, cancelToken });
          });
        }
        return config;
      },
      (err) => {
        return Promise.reject(err);
      }
    );

    instance.interceptors.response.use(
      (response) => {
        if (preventRepeat) {
          removePending(response.config);
        }
        return response;
      },
      (error) => {
        return Promise.reject(error);
      }
    );

    // 请求执行前加入task
    createTask(key, resolve);

    instance(Object.assign({}, { method }, method === 'post' || method === 'put' ? { data: !uploadFile ? qs.stringify(params) : params } : { params }))
      .then((response) => {
        // 处理task
        handleTask(key, response);
      })
      .catch();
  });
};

// 定义对外Get、Post请求
export default {
  // 单独导出 用于put等非常规请求及需要特殊处理header的请求
  request,
  get(url, data = {}, preventRepeat = true) {
    data = dataAddToken(data);
    return request('get', url, data, getHeaders, preventRepeat, false);
  },
  post(url, data = {}, preventRepeat = true) {
    data = dataAddToken(data);
    return request('post', url, data, postHeaders, preventRepeat, false);
  },
  file(url, data = {}, preventRepeat = true) {
    return request('post', url, data, fileHeaders, preventRepeat, true);
  },
};

api封装:index.js

import Request from './request';

// 公用-获取验证码
export const postMerchantLoginCms = (data) => Request.post('/merchant/login/cms', data);

// 临时mock接口,用于测试封装功能
// export const getList = (data) => Request.get('/web-model-library/merchant/investigation', data);
export const getList = (data) => Request.post('/active/getRandModel', data);

使用方式:

import { getList } from "@/api";


 methods: {
     async getdata() {
      let data =await getList({a:1});
    },
}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
好的,以下是一个封装Axios 网络请求并区分 GET、POST 请求的示例代码: ```javascript import axios from 'axios'; const service = axios.create({ baseURL: 'http://localhost:3000', // 接口的基础路径,根据实际情况修改 timeout: 5000, // 请求超时时间 }); // 请求拦截器 service.interceptors.request.use( config => { // 在请求发送之前,可以在这里对请求进行一些处理,比如添加请求头、设置请求数据格式等 return config; }, error => { // 请求错误时,可以在这里进行一些处理,比如提示错误信息等 console.log(error); return Promise.reject(error); } ); // 响应拦截器 service.interceptors.response.use( response => { // 在响应数据返回之前,可以在这里对响应进行一些处理,比如过滤数据、统一处理错误码等 return response.data; }, error => { // 响应错误时,可以在这里进行一些处理,比如提示错误信息等 console.log(error); return Promise.reject(error); } ); // 封装一个 GET 请求 export function get(url, params) { return service({ url, method: 'get', params, }); } // 封装一个 POST 请求 export function post(url, data) { return service({ url, method: 'post', data, }); } ``` 在上述代码中,我们通过封装 `get` 和 `post` 方法来区分 GET 和 POST 请求。在这两个方法中,我们都是通过 `service()` 方法来发送请求,只是在配置中指定了不同的请求方法(method)、请求参数(params 或 data)。最后,我们将这两个方法导出,供其他地方使用。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值