RuoYi-vue框架之拦截器

最新推荐文章于 2025-01-08 22:25:52 发布

qq_44925434

最新推荐文章于 2025-01-08 22:25:52 发布

阅读量6.5k

点赞数 1

文章标签： vue.js javascript ecmascript ruoyi

本文链接：https://blog.csdn.net/qq_44925434/article/details/132641138

版权

本文详细介绍了RuoYi-vue框架中的前端拦截器，包括添加请求头的token、处理get请求参数、防止重复请求提交以及响应拦截器的逻辑。着重展示了如何在请求头中添加token，处理对象参数并检测重复提交。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

RuoYi-vue框架之前端拦截器

文章目录

RuoYi-vue框架之前端拦截器

前端拦截器

前置拦截器

文件位置：/src/utils/request.js

// request拦截器
service.interceptors.request.use(config => {
  // 是否需要设置 token
  const isToken = (config.headers || {}).isToken === false
  // 是否需要防止数据重复提交
  const isRepeatSubmit = (config.headers || {}).repeatSubmit === false
  if (getToken() && !isToken) {
    config.headers['Authorization'] = 'Bearer ' + getToken() // 让每个请求携带自定义token 请根据实际情况自行修改
  }
  // get请求映射params参数
  if (config.method === 'get' && config.params) {
    let url = config.url + '?' + tansParams(config.params);
    url = url.slice(0, -1);
    config.params = {};
    config.url = url;
  }
  if (!isRepeatSubmit && (config.method === 'post' || config.method === 'put')) {
    const requestObj = {
      url: config.url,
      data: typeof config.data === 'object' ? JSON.stringify(config.data) : config.data,
      time: new Date().getTime()
    }
    const sessionObj = cache.session.getJSON('sessionObj')
    if (sessionObj === undefined || sessionObj === null || sessionObj === '') {
      cache.session.setJSON('sessionObj', requestObj)
    } else {
      const s_url = sessionObj.url;                  // 请求地址
      const s_data = sessionObj.data;                // 请求数据
      const s_time = sessionObj.time;                // 请求时间
      const interval = 1000;                         // 间隔时间(ms)，小于此时间视为重复提交
      if (s_data === requestObj.data && requestObj.time - s_time < interval && s_url === requestObj.url) {
        const message = '数据正在处理，请勿重复提交';
        console.warn(`[${s_url}]: ` + message)
        return Promise.reject(new Error(message))
      } else {
        cache.session.setJSON('sessionObj', requestObj)
      }
    }
  }
  return config
}, error => {
    console.log(error)
    Promise.reject(error)
})

做了一下三件事情

1.在请求头中添加token
2.请求映射params参数
3.阻止重复请求提交

第一步见名知意

第二步，请求映射params参数

其实就是解析对象当get请求中带的参数中有对象或者数据中非默认值的时候，解析然后拼接成字符串
一下就是解析的代码

  // get请求映射params参数
  if (config.method === 'get' && config.params) {
  //请求为get且带有参数
    let url = config.url + '?' + tansParams(config.params);  //请求 + 参数处理（就是转换成字符串）
    url = url.slice(0, -1);   //去掉最后一位（应该是拼接的时候残留的拼接符号，所以要去掉） 
    config.params = {};   //复位 
    config.url = url;   //返回拼接处理完参数后的url
  }

其中tansParams可以看出来确实是转成字符串类型用&拼接，最后一位&要去掉

/**
* 参数处理
* @param {*} params  参数
*/
export function tansParams(params) {
  let result = ''
  for (const propName of Object.keys(params)) {
    const value = params[propName];
    var part = encodeURIComponent(propName) + "=";
    if (value !== null && value !== "" && typeof (value) !== "undefined") {
      if (typeof value === 'object') {
        for (const key of Object.keys(value)) {
          if (value[key] !== null && value[key] !== "" && typeof (value[key]) !== 'undefined') {
            let params = propName + '[' + key + ']';
            var subPart = encodeURIComponent(params) + "=";
            result += subPart + encodeURIComponent(value[key]) + "&";
          }
        }
      } else {
        result += part + encodeURIComponent(value) + "&";
      }
    }
  }
  return result
}

可以看出前端get请求参数做了统一的处理后面，有利于前后端传参的统一管理。
补充，对其他请求的参数处理

  if (!isRepeatSubmit && (config.method === 'post' || config.method === 'put')) {
    const requestObj = {
      url: config.url,
      data: typeof config.data === 'object' ? JSON.stringify(config.data) : config.data,
      //JOSN对象转换成JSON字符串
      time: new Date().getTime()
    }

Json对象与Json字符串的相互转化

var  str = '{"name":"lin","sex":"男","age":"23"}';
var  strToObj = JSON.parse(str);   //转换成对象
console.log(strToObj);//{name:"lin",sex:"男",age:"23"}

var  str= JSON.stringify(strToObj); //转换成字符串
console.log(str);//{"name":"lin","sex":"男","age":"23"}

第三步.阻止重复请求提交

const sessionObj = cache.session.getJSON('sessionObj')
    if (sessionObj === undefined || sessionObj === null || sessionObj === '') {
      cache.session.setJSON('sessionObj', requestObj)
    } else {
      const s_url = sessionObj.url;                  // 请求地址
      const s_data = sessionObj.data;                // 请求数据
      const s_time = sessionObj.time;                // 请求时间
      const interval = 1000;                         // 间隔时间(ms)，小于此时间视为重复提交
      if (s_data === requestObj.data && requestObj.time - s_time < interval && s_url === requestObj.url) {
        const message = '数据正在处理，请勿重复提交';
        console.warn(`[${s_url}]: ` + message)
        return Promise.reject(new Error(message))
      } else {
        cache.session.setJSON('sessionObj', requestObj)
      }
    }

响应拦截器

// 响应拦截器

service.interceptors.response.use(res => {
    // 未设置状态码则默认成功状态
    const code = res.data.code || 200;
    // 获取错误信息
    const msg = errorCode[code] || res.data.msg || errorCode['default']
    // 二进制数据则直接返回
    if (res.request.responseType ===  'blob' || res.request.responseType ===  'arraybuffer') {
      return res.data
    }
    if (code === 401) {
      if (!isRelogin.show) {
        isRelogin.show = true;
        MessageBox.confirm('登录状态已过期，您可以继续留在该页面，或者重新登录', '系统提示', { confirmButtonText: '重新登录', cancelButtonText: '取消', type: 'warning' }).then(() => {
          isRelogin.show = false;
          store.dispatch('LogOut').then(() => {
            location.href = '/index';
          })
      }).catch(() => {
        isRelogin.show = false;
      });
    }
      return Promise.reject('无效的会话，或者会话已过期，请重新登录。')
    } else if (code === 500) {
      Message({ message: msg, type: 'error' })
      return Promise.reject(new Error(msg))
    } else if (code === 601) {
      Message({ message: msg, type: 'warning' })
      return Promise.reject('error')
    } else if (code !== 200) {
      Notification.error({ title: msg })
      return Promise.reject('error')
    } else {
      return res.data
    }
  },
  error => {
    console.log('err' + error)
    let { message } = error;
    if (message == "Network Error") {
      message = "后端接口连接异常";
    } else if (message.includes("timeout")) {
      message = "系统接口请求超时";
    } else if (message.includes("Request failed with status code")) {
      message = "系统接口" + message.substr(message.length - 3) + "异常";
    }
    Message({ message: message, type: 'error', duration: 5 * 1000 })
    return Promise.reject(error)
  }
)

常规

后端拦截器

地址 framewor/src/main/java/com/ruoyi/framework/interceptor/RepeatSubmitInterceptor.java

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception
    {
        if (handler instanceof HandlerMethod)  //判断请求类型，不是方法就放行
        {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
            RepeatSubmit annotation = method.getAnnotation(RepeatSubmit.class);   //获取请求controller方法上的注解
            if (annotation != null)                        //有没有防重提交
            {
                if (this.isRepeatSubmit(request, annotation))    
                {
                    AjaxResult ajaxResult = AjaxResult.error(annotation.message());
                    ServletUtils.renderString(response, JSON.toJSONString(ajaxResult));
                    return false;
                }
            }
            return true;
        }
        else
        {
            return true;
        }
    }