update 重写 防重提交拦截器 支持全局与注解自定义 拦截时间配置配置 优化逻辑

This commit is contained in:
疯狂的狮子li 2021-07-30 19:10:54 +08:00
parent 39783f2b19
commit c65acd6a28
4 changed files with 136 additions and 149 deletions

View File

@ -107,6 +107,11 @@ token:
# 令牌有效期默认30分钟 # 令牌有效期默认30分钟
expireTime: 30 expireTime: 30
# 重复提交
repeat-submit:
# 全局间隔时间(毫秒)
intervalTime: 1000
# MyBatisPlus配置 # MyBatisPlus配置
# https://baomidou.com/config/ # https://baomidou.com/config/
mybatis-plus: mybatis-plus:

View File

@ -6,18 +6,24 @@ import java.lang.annotation.Inherited;
import java.lang.annotation.Retention; import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy; import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; import java.lang.annotation.Target;
import java.util.concurrent.TimeUnit;
/** /**
* 自定义注解防止表单重复提交 * 自定义注解防止表单重复提交
* *
* @author ruoyi * @author Lion Li
*
*/ */
@Inherited @Inherited
@Target(ElementType.METHOD) @Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)
@Documented @Documented
public @interface RepeatSubmit public @interface RepeatSubmit {
{
/**
* 默认使用全局配置
*/
int intervalTime() default 0;
TimeUnit timeUnit() default TimeUnit.MILLISECONDS;
} }

View File

@ -6,7 +6,7 @@ import com.ruoyi.common.utils.JsonUtils;
import com.ruoyi.common.utils.ServletUtils; import com.ruoyi.common.utils.ServletUtils;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod; import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter; import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpServletResponse;
@ -15,42 +15,36 @@ import java.lang.reflect.Method;
/** /**
* 防止重复提交拦截器 * 防止重复提交拦截器
* *
* @author ruoyi * 移除继承 HandlerInterceptorAdapter 过期类
* 改为实现 HandlerInterceptor 接口(官方推荐写法)
*
* @author Lion Li
*/ */
@Component @Component
public abstract class RepeatSubmitInterceptor extends HandlerInterceptorAdapter public abstract class RepeatSubmitInterceptor implements HandlerInterceptor {
{
@Override
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);
if (annotation != null)
{
if (this.isRepeatSubmit(request))
{
AjaxResult ajaxResult = AjaxResult.error("不允许重复提交,请稍后再试");
ServletUtils.renderString(response, JsonUtils.toJsonString(ajaxResult));
return false;
}
}
return true;
}
else
{
return super.preHandle(request, response, handler);
}
}
/** @Override
* 验证是否重复提交由子类实现具体的防重复提交的规则 public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
* throws Exception {
* @param request if (handler instanceof HandlerMethod) {
* @return HandlerMethod handlerMethod = (HandlerMethod) handler;
* @throws Exception Method method = handlerMethod.getMethod();
*/ RepeatSubmit annotation = method.getAnnotation(RepeatSubmit.class);
public abstract boolean isRepeatSubmit(HttpServletRequest request); if (annotation != null) {
if (this.isRepeatSubmit(annotation, request)) {
AjaxResult ajaxResult = AjaxResult.error("不允许重复提交,请稍后再试");
ServletUtils.renderString(response, JsonUtils.toJsonString(ajaxResult));
return false;
}
}
return true;
} else {
return HandlerInterceptor.super.preHandle(request, response, handler);
}
}
/**
* 验证是否重复提交由子类实现具体的防重复提交的规则
*/
public abstract boolean isRepeatSubmit(RepeatSubmit annotation, HttpServletRequest request);
} }

View File

@ -1,15 +1,19 @@
package com.ruoyi.framework.interceptor.impl; package com.ruoyi.framework.interceptor.impl;
import cn.hutool.core.convert.Convert;
import cn.hutool.core.io.IoUtil; import cn.hutool.core.io.IoUtil;
import cn.hutool.core.lang.Validator; import cn.hutool.core.lang.Validator;
import com.ruoyi.common.annotation.RepeatSubmit;
import com.ruoyi.common.constant.Constants; import com.ruoyi.common.constant.Constants;
import com.ruoyi.common.core.redis.RedisCache; import com.ruoyi.common.core.redis.RedisCache;
import com.ruoyi.common.filter.RepeatedlyRequestWrapper; import com.ruoyi.common.filter.RepeatedlyRequestWrapper;
import com.ruoyi.common.utils.JsonUtils; import com.ruoyi.common.utils.JsonUtils;
import com.ruoyi.framework.config.properties.RepeatSubmitProperties;
import com.ruoyi.framework.config.properties.TokenProperties;
import com.ruoyi.framework.interceptor.RepeatSubmitInterceptor; import com.ruoyi.framework.interceptor.RepeatSubmitInterceptor;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j; import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
@ -20,45 +24,34 @@ import java.util.concurrent.TimeUnit;
/** /**
* 判断请求url和数据是否和上一次相同 * 判断请求url和数据是否和上一次相同
* 如果和上次相同则是重复提交表单 有效时间为10秒内 * 如果和上次相同则是重复提交表单
* *
* @author ruoyi * @author Lion Li
*/ */
@Slf4j @Slf4j
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@Component @Component
public class SameUrlDataInterceptor extends RepeatSubmitInterceptor public class SameUrlDataInterceptor extends RepeatSubmitInterceptor {
{ public final String REPEAT_PARAMS = "repeatParams";
public final String REPEAT_PARAMS = "repeatParams";
public final String REPEAT_TIME = "repeatTime"; public final String REPEAT_TIME = "repeatTime";
// 令牌自定义标识 private final TokenProperties tokenProperties;
@Value("${token.header}") private final RepeatSubmitProperties repeatSubmitProperties;
private String header; private final RedisCache redisCache;
@Autowired
private RedisCache redisCache;
/** @SuppressWarnings("unchecked")
* 间隔时间单位: 默认10秒 @Override
* public boolean isRepeatSubmit(RepeatSubmit repeatSubmit, HttpServletRequest request) {
* 两次相同参数的请求如果间隔时间大于该参数系统不会认定为重复提交的数据 // 如果注解不为0 则使用注解数值
*/ long intervalTime = repeatSubmitProperties.getIntervalTime();
private int intervalTime = 10; if (repeatSubmit.intervalTime() > 0) {
intervalTime = repeatSubmit.timeUnit().toMillis(repeatSubmit.intervalTime());
public void setIntervalTime(int intervalTime) }
{ String nowParams = "";
this.intervalTime = intervalTime; if (request instanceof RepeatedlyRequestWrapper) {
} RepeatedlyRequestWrapper repeatedlyRequest = (RepeatedlyRequestWrapper) request;
@SuppressWarnings("unchecked")
@Override
public boolean isRepeatSubmit(HttpServletRequest request)
{
String nowParams = "";
if (request instanceof RepeatedlyRequestWrapper)
{
RepeatedlyRequestWrapper repeatedlyRequest = (RepeatedlyRequestWrapper) request;
try { try {
nowParams = IoUtil.readUtf8(repeatedlyRequest.getInputStream()); nowParams = IoUtil.readUtf8(repeatedlyRequest.getInputStream());
} catch (IOException e) { } catch (IOException e) {
@ -66,68 +59,57 @@ public class SameUrlDataInterceptor extends RepeatSubmitInterceptor
} }
} }
// body参数为空获取Parameter的数据 // body参数为空获取Parameter的数据
if (Validator.isEmpty(nowParams)) if (Validator.isEmpty(nowParams)) {
{ nowParams = JsonUtils.toJsonString(request.getParameterMap());
nowParams = JsonUtils.toJsonString(request.getParameterMap()); }
} Map<String, Object> nowDataMap = new HashMap<String, Object>();
Map<String, Object> nowDataMap = new HashMap<String, Object>(); nowDataMap.put(REPEAT_PARAMS, nowParams);
nowDataMap.put(REPEAT_PARAMS, nowParams); nowDataMap.put(REPEAT_TIME, System.currentTimeMillis());
nowDataMap.put(REPEAT_TIME, System.currentTimeMillis());
// 请求地址作为存放cache的key值 // 请求地址作为存放cache的key值
String url = request.getRequestURI(); String url = request.getRequestURI();
// 唯一值(没有消息头则使用请求地址) // 唯一值(没有消息头则使用请求地址)
String submitKey = request.getHeader(header); String submitKey = request.getHeader(tokenProperties.getHeader());
if (Validator.isEmpty(submitKey)) if (Validator.isEmpty(submitKey)) {
{ submitKey = url;
submitKey = url; }
}
// 唯一标识指定key + 消息头) // 唯一标识指定key + 消息头)
String cacheRepeatKey = Constants.REPEAT_SUBMIT_KEY + submitKey; String cacheRepeatKey = Constants.REPEAT_SUBMIT_KEY + submitKey;
Object sessionObj = redisCache.getCacheObject(cacheRepeatKey); Object sessionObj = redisCache.getCacheObject(cacheRepeatKey);
if (sessionObj != null) if (sessionObj != null) {
{ Map<String, Object> sessionMap = (Map<String, Object>) sessionObj;
Map<String, Object> sessionMap = (Map<String, Object>) sessionObj; if (sessionMap.containsKey(url)) {
if (sessionMap.containsKey(url)) Map<String, Object> preDataMap = (Map<String, Object>) sessionMap.get(url);
{ if (compareParams(nowDataMap, preDataMap) && compareTime(nowDataMap, preDataMap, intervalTime)) {
Map<String, Object> preDataMap = (Map<String, Object>) sessionMap.get(url); return true;
if (compareParams(nowDataMap, preDataMap) && compareTime(nowDataMap, preDataMap)) }
{ }
return true; }
} Map<String, Object> cacheMap = new HashMap<String, Object>();
} cacheMap.put(url, nowDataMap);
} redisCache.setCacheObject(cacheRepeatKey, cacheMap, Convert.toInt(intervalTime), TimeUnit.MILLISECONDS);
Map<String, Object> cacheMap = new HashMap<String, Object>(); return false;
cacheMap.put(url, nowDataMap); }
redisCache.setCacheObject(cacheRepeatKey, cacheMap, intervalTime, TimeUnit.SECONDS);
return false;
}
/** /**
* 判断参数是否相同 * 判断参数是否相同
*/ */
private boolean compareParams(Map<String, Object> nowMap, Map<String, Object> preMap) private boolean compareParams(Map<String, Object> nowMap, Map<String, Object> preMap) {
{ String nowParams = (String) nowMap.get(REPEAT_PARAMS);
String nowParams = (String) nowMap.get(REPEAT_PARAMS); String preParams = (String) preMap.get(REPEAT_PARAMS);
String preParams = (String) preMap.get(REPEAT_PARAMS); return nowParams.equals(preParams);
return nowParams.equals(preParams); }
}
/** /**
* 判断两次间隔时间 * 判断两次间隔时间
*/ */
private boolean compareTime(Map<String, Object> nowMap, Map<String, Object> preMap) private boolean compareTime(Map<String, Object> nowMap, Map<String, Object> preMap, long intervalTime) {
{ long time1 = (Long) nowMap.get(REPEAT_TIME);
long time1 = (Long) nowMap.get(REPEAT_TIME); long time2 = (Long) preMap.get(REPEAT_TIME);
long time2 = (Long) preMap.get(REPEAT_TIME); return (time1 - time2) < intervalTime;
if ((time1 - time2) < (this.intervalTime * 1000)) }
{
return true;
}
return false;
}
} }