一個注解，兩種實現方式完美解決重復提交問題
作者：Springboot實戰案例錦集
冪等性是指一個操作或API請求，無論執行一次還是多次，結果都是相同的。在API設計中，冪等性是一種非常重要的屬性，因為它確保了在重試或并發請求時，系統狀態不會出現不一致的情況。
環境：Springboot3.0.5
什么是接口防重
接口防重是指在一定時間內只允許執行一次接口請求。這是為了防止由于重復提交和重復處理產生重復數據或相應錯誤。實現接口防重可以采用以下方法：
- 使用唯一標識符：在請求中包含一個唯一標識符（例如請求token），然后在對應接口判斷該唯一值在一定時間內是否被消費過，如果已被消費，則拒絕該請求。
- 使用時間戳、計數器等機制：記錄請求的時間或次數，并在一定范圍內拒絕重復請求。
- 采用Spring AOP理念：實現請求的切割，在請求執行到某個方法或某層時，開始攔截并進行防重處理。
這些方法有助于確保系統的一致性和穩定性，防止數據的重復提交和處理。
冪等與防重
API接口的冪等性和防重性是兩個不同的概念，盡管它們在某些方面有重疊之處。
- 冪等性
冪等性是指一個操作或API請求，無論執行一次還是多次，結果都是相同的。在API設計中，冪等性是一種非常重要的屬性，因為它確保了在重試或并發請求時，系統狀態不會出現不一致的情況。
在實現冪等性時，通常采用以下方法：
- 在請求中包含一個唯一標識符（例如請求ID），以便在處理請求時能夠識別和防止重復處理。
- 使用樂觀鎖或悲觀鎖機制來保證數據的一致性。
- 對于更新操作，可以通過比較新舊數據來判斷是否有變化，只有當數據發生改變時才執行更新操作。
- 防重性
防重性是指在一定時間內只允許執行一次操作或請求。它主要用于防止重復提交和重復處理。與冪等性不同，防重性主要關注的是防止數據重復，而冪等性則關注任何多次執行的結果都是相同的。
技術實現
方式1：通過AOP方式
自定義注解
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface PreventDuplicate {
/**
* 唯一標識通過header傳遞時的key
*
* @return
*/
String header() default "token" ;
/**
* 唯一標識通過請求參數傳遞時的key
*
* @return
*/
String param() default "token" ;
}自定義AOP切面
@Component
@Aspect
public class PreventDuplicateAspect {
public static final String PREVENT_PREFIX_KEY = "prevent:" ;
private final StringRedisTemplate stringRedisTemplate ;
private final HttpServletRequest request ;
public PreventDuplicateAspect(StringRedisTemplate stringRedisTemplate, HttpServletRequest request) {
this.stringRedisTemplate = stringRedisTemplate ;
this.request = request ;
}
@Around("@annotation(prevent)")
public Object preventDuplicate(ProceedingJoinPoint pjp, PreventDuplicate prevent) throws Throwable {
String key = prevent.header() ;
String value = null ;
if (key != null && key.length() > 0) {
value = this.request.getHeader(key) ;
} else {
key = prevent.param() ;
if (key != null && key.length() > 0) {
value = this.request.getParameter(key) ;
}
}
if (value == null || "".equals(value.trim())) {
return "非法請求" ;
}
// 拼接rediskey
String prevent_key = PREVENT_PREFIX_KEY + value ;
// 判斷redis中是否存在當前請求中攜帶的唯一標識數據, 刪除成功則存在
Boolean result = this.stringRedisTemplate.delete(prevent_key) ;
if (result != null && result.booleanValue()) {
return pjp.proceed() ;
} else {
return "請不要重復提交" ;
}
}
}生成唯一標識接口
@RestController
@RequestMapping("/generate")
public class GenerateController {
private final StringRedisTemplate stringRedisTemplate ;
public GenerateController(StringRedisTemplate stringRedisTemplate) {
this.stringRedisTemplate = stringRedisTemplate ;
}
@GetMapping("/token")
public String token() {
String token = UUID.randomUUID().toString().replace("-", "") ;
// 將生成的token存入redis中，設置有效期5分鐘
this.stringRedisTemplate.opsForValue().setIfAbsent(PreventDuplicateAspect.PREVENT_PREFIX_KEY + token, token, 5 * 60, TimeUnit.SECONDS) ;
return token ;
}
}業務接口
@RestController
@RequestMapping("/prevent")
public class PreventController {
@PreventDuplicate
@GetMapping("/index")
public Object index() {
return "index success" ;
}
}測試
先調用生成唯一接口獲取token值
圖片
調用業務接口，攜帶token值
第一次訪問, 正常
再次訪問
方式2：通過攔截器實現
自定義攔截器
@Component
public class PreventDuplicateInterceptor implements HandlerInterceptor {
private final StringRedisTemplate stringRedisTemplate ;
public PreventDuplicateInterceptor(StringRedisTemplate stringRedisTemplate) {
this.stringRedisTemplate = stringRedisTemplate ;
}
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
if (handler instanceof HandlerMethod hm) {
if (hm.hasMethodAnnotation(PreventDuplicate.class)) {
PreventDuplicate pd = hm.getMethodAnnotation(PreventDuplicate.class) ;
String key = pd.header() ;
String value = null ;
if (key != null && key.length() > 0) {
value = request.getHeader(key) ;
} else {
key = pd.param() ;
if (key != null && key.length() > 0) {
value = request.getParameter(key) ;
}
}
if (value == null || "".equals(value.trim())) {
response.setContentType("text/plain;charset=utf-8") ;
response.getWriter().println("非法請求") ;
return false ;
}
// 拼接rediskey
String prevent_key = PreventDuplicateAspect.PREVENT_PREFIX_KEY + value ;
// 判斷redis中是否存在當前請求中攜帶的唯一標識數據, 刪除成功則存在
Boolean result = this.stringRedisTemplate.delete(prevent_key) ;
if (result != null && result.booleanValue()) {
return true ;
} else {
response.setContentType("text/plain;charset=utf-8") ;
response.getWriter().println("請不要重復提交") ;
return false ;
}
}
}
return true ;
}
}配置攔截器
@Component
public class PreventWebConfig implements WebMvcConfigurer {
private final PreventDuplicateInterceptor duplicateInterceptor ;
public PreventWebConfig(PreventDuplicateInterceptor duplicateInterceptor) {
this.duplicateInterceptor = duplicateInterceptor ;
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(this.duplicateInterceptor).addPathPatterns("/**") ;
}
}測試
獲取token
第一次請求
再次請求
完畢！！！
責任編輯：武曉燕
來源：
Spring全家桶實戰案例源碼
