轉載於：https://www.cnblogs.com/zhengqing/p/11943530.html
一、前言
在某些情況下，由於網速慢，用戶操作有誤(連續點擊兩下提交按鈕)，頁面卡頓等原因，可能會出現表單數據重復提交造成數據庫保存多條重復數據。
存在如上問題可以交給前端解決，判斷多長時間內不能再次點擊保存按鈕，當然，如果存在聰明的用戶能夠繞過前端驗證，后端更應該去進行攔截處理，下面小編將基於 SpringBoot 2.1.8.RELEASE 環境通過 AOP切面 + 自定義校驗注解 + Redis緩存 來解決這一問題。
二、Spring Boot 校驗表單重復提交操作
1、pom.xml 中引入所需依賴
<!-- ================== 校驗表單重復提交所需依賴 ===================== --> <!-- AOP依賴 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <!-- Redis --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency>
2、application.yml 中引入Redis配置
spring: redis: # Redis數據庫索引（默認為0） database: 0 # Redis服務器地址 host: 127.0.0.1 # Redis服務器連接端口 port: 6379 timeout: 6000 # Redis服務器連接密碼（默認為空） # password: jedis: pool: max-active: 1000 # 連接池最大連接數（使用負值表示沒有限制） max-wait: -1 # 連接池最大阻塞等待時間（使用負值表示沒有限制） max-idle: 10 # 連接池中的最大空閑連接 min-idle: 5 # 連接池中的最小空閑連接
3、自定義注解 @NoRepeatSubmit
// 作用到方法上 @Target(ElementType.METHOD) // 運行時有效 @Retention(RetentionPolicy.RUNTIME) public @interface NoRepeatSubmit { /** * 默認時間3秒 */ int time() default 3 * 1000; }
4、AOP 攔截處理
注：這里redis存儲的key值可由個人具體業務靈活發揮，這里只是示例
ex：單用戶登錄情況下可以組合 token + url請求路徑 , 多個用戶可以同時登錄的話，可以再加上 ip地址
@Slf4j @Aspect @Component public class NoRepeatSubmitAop { @Autowired RedisUtil redisUtil; /** * <p> 【環繞通知】 用於攔截指定方法，判斷用戶表單保存操作是否屬於重復提交 <p> * * 定義切入點表達式： execution(public * (…)) * 表達式解釋： execution：主體 public:可省略 *：標識方法的任意返回值 任意包+類+方法(…) 任意參數 * * com.zhengqing.demo.modules.*.api ： 標識AOP所切服務的包名，即需要進行橫切的業務類 * .*Controller ： 標識類名，*即所有類 * .*(..) ： 標識任何方法名，括號表示參數，兩個點表示任何參數類型 * * @param pjp：切入點對象 * @param noRepeatSubmit:自定義的注解對象 * @return: java.lang.Object */ @Around("execution(* com.zhengqing.demo.modules.*.api.*Controller.*(..)) && @annotation(noRepeatSubmit)") public Object doAround(ProceedingJoinPoint pjp, NoRepeatSubmit noRepeatSubmit) { try { HttpServletRequest request = ((ServletRequestAttributes) Objects.requireNonNull(RequestContextHolder.getRequestAttributes())).getRequest(); // 拿到ip地址、請求路徑、token String ip = IpUtils.getIpAdrress(request); String url = request.getRequestURL().toString(); String token = request.getHeader(Constants.REQUEST_HEADERS_TOKEN); // 現在時間 long now = System.currentTimeMillis(); // 自定義key值方式 String key = "REQUEST_FORM_" + ip; if (redisUtil.hasKey(key)) { // 上次表單提交時間 long lastTime = Long.parseLong(redisUtil.get(key)); // 如果現在距離上次提交時間小於設置的默認時間 則 判斷為重復提交 否則 正常提交 -> 進入業務處理 if ((now - lastTime) > noRepeatSubmit.time()) { // 非重復提交操作 - 重新記錄操作時間 redisUtil.set(key, String.valueOf(now)); // 進入處理業務 ApiResult result = (ApiResult) pjp.proceed(); return result; } else { return ApiResult.fail("請勿重復提交!"); } } else { // 這里是第一次操作 redisUtil.set(key, String.valueOf(now)); ApiResult result = (ApiResult) pjp.proceed(); return result; } } catch (Throwable e) { log.error("校驗表單重復提交時異常: {}", e.getMessage()); return ApiResult.fail("校驗表單重復提交時異常!"); } } }
5、其中用到的Redis工具類
由於太多，這里就不直接貼出來了，可參考文末給出的案例demo源碼
三、測試
在需要校驗的方法上加上自定義的校驗注解 @NoRepeatSubmit 即可
@RestController public class IndexController extends BaseController { @NoRepeatSubmit @GetMapping(value = "/index", produces = "application/json;charset=utf-8") public ApiResult index() { return ApiResult.ok("Hello World ~ "); } }
這里重復訪問此 index api請求以模擬提交表單測試
第一次訪問 http://127.0.0.1:8080/index
多次刷新此請求，則提示請勿重復提交!
四、總結
實現思路
- 首先利用
AOP切面在進入方法前攔截進行表單重復提交校驗邏輯處理 - 通過
Redis的key-value鍵值對存儲 需要的邏輯判斷數據 【ex：key存儲用戶提交表單的api請求路徑，value存儲提交時間】 邏輯處理：
第一次提交時存入相應數據到redis中
當再次提交保存時從redis緩存中取出上次提交的時間與當前操作時間做判斷，
如果當前操作時間距離上次操作時間在我們設置的 ‘判斷為重復提交的時間(3秒內)’ 則為重復提交 直接 返回重復提交提示語句或其它處理，
否則為正常提交，進入業務方法處理...
補充
如果api遵從的是嚴格的Restful風格 即 @PostMapping 用於表單提交操作，則可不用自定義注解方式去判斷需要校驗重復提交的路徑，直接在aop切面攔截該請求路徑后，通過反射拿到該方法上的注解是否存在 @PostMapping 如果存在則是提交表單的api，即進行校驗處理，如果不存在即是其它的 @GetMapping 、 @PutMapping 、@DeleteMapping 操作 ...