SpringBoot+Redis 解決海量重復提交問題，yyds!

在實際的開發項目中,一個對外暴露的接口往往會面臨很多次請求，我們來解釋一下冪等的概念：任意多次執行所產生的影響均與一次執行的影響相同。按照這個含義，最終的含義就是對數據庫的影響只能是一次性的，不能重復處理。如何保證其冪等性，通常有以下手段：

1、數據庫建立唯一性索引，可以保證最終插入數據庫的只有一條數據。

2、token機制，每次接口請求前先獲取一個token，然后再下次請求的時候在請求的header體中加上這個token，后臺進行驗證，如果驗證通過刪除token，下次請求再次判斷token。

3、悲觀鎖或者樂觀鎖，悲觀鎖可以保證每次for update的時候其他sql無法update數據(在數據庫引擎是innodb的時候,select的條件必須是唯一索引,防止鎖全表)

4、先查詢后判斷，首先通過查詢數據庫是否存在數據，如果存在證明已經請求過了，直接拒絕該請求，如果沒有存在，就證明是第一次進來，直接放行。

redis 實現自動冪等的原理圖：

搭建 Redis 服務 API

1、首先是搭建redis服務器。

2、引入springboot中到的redis的stater，或者Spring封裝的jedis也可以，后面主要用到的api就是它的set方法和exists方法,這里我們使用springboot的封裝好的redisTemplate。

/** * redis工具類 */
@Component
public?class?RedisService {@Autowiredprivate?RedisTemplate redisTemplate;/** * 寫入緩存 * @param key * @param value * @return */public?boolean?set(final?String?key,?Object?value) {boolean?result =?false;try?{ValueOperations<Serializable,?Object> operations = redisTemplate.opsForValue();operations.set(key, value);result =?true;}?catch?(Exception e) {e.printStackTrace();}return?result;}/** * 寫入緩存設置時效時間 * @param key * @param value * @return */public?boolean?setEx(final?String?key,?Object?value, Long expireTime) {boolean?result =?false;try?{ValueOperations<Serializable,?Object> operations = redisTemplate.opsForValue();operations.set(key, value);redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);result =?true;}?catch?(Exception e) {e.printStackTrace();}return?result;}/** * 判斷緩存中是否有對應的value * @param key * @return */public?boolean?exists(final?String?key) {return?redisTemplate.hasKey(key);}/** * 讀取緩存 * @param key * @return */public?Object?get(final?String?key) {Object?result =?null;ValueOperations<Serializable,?Object> operations = redisTemplate.opsForValue();result = operations.get(key);return?result;}/** * 刪除對應的value * @param key */public?boolean?remove(final?String?key) {if?(exists(key)) {Boolean?delete?= redisTemplate.delete(key);return?delete;}return?false;}
}

自定義注解 AutoIdempotent

自定義一個注解，定義此注解的主要目的是把它添加在需要實現冪等的方法上，凡是某個方法注解了它，都會實現自動冪等。

后臺利用反射如果掃描到這個注解，就會處理這個方法實現自動冪等，使用元注解ElementType.METHOD表示它只能放在方法上，etentionPolicy.RUNTIME表示它在運行時。

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public?@interface?AutoIdempotent {}

token 創建和檢驗

token服務接口：我們新建一個接口，創建token服務，里面主要是兩個方法，一個用來創建token，一個用來驗證token。創建token主要產生的是一個字符串，檢驗token的話主要是傳達request對象，為什么要傳request對象呢？主要作用就是獲取header里面的token,然后檢驗，通過拋出的Exception來獲取具體的報錯信息返回給前端。

public?interface?TokenService?{/** * 創建token *?@return?*/public?String?createToken();/** * 檢驗token *?@param?request *?@return?*/public?boolean?checkToken(HttpServletRequest request)?throws?Exception;}

token的服務實現類：token引用了redis服務，創建token采用隨機算法工具類生成隨機uuid字符串,然后放入到redis中(為了防止數據的冗余保留,這里設置過期時間為10000秒,具體可視業務而定)，如果放入成功，最后返回這個token值。checkToken方法就是從header中獲取token到值(如果header中拿不到，就從paramter中獲取)，如若不存在,直接拋出異常。這個異常信息可以被攔截器捕捉到，然后返回給前端。

@Service
public?class?TokenServiceImpl?implements?TokenService?{@Autowiredprivate?RedisService redisService;/** * 創建token * *?@return?*/@Overridepublic?String?createToken()?{String str = RandomUtil.randomUUID();StrBuilder token =?new?StrBuilder();try?{token.append(Constant.Redis.TOKEN_PREFIX).append(str);redisService.setEx(token.toString(), token.toString(),10000L);boolean?notEmpty = StrUtil.isNotEmpty(token.toString());if?(notEmpty) {return?token.toString();}}catch?(Exception ex){ex.printStackTrace();}return?null;}/** * 檢驗token * *?@param?request *?@return?*/@Overridepublic?boolean?checkToken(HttpServletRequest request)?throws?Exception?{String token = request.getHeader(Constant.TOKEN_NAME);if?(StrUtil.isBlank(token)) {// header中不存在tokentoken = request.getParameter(Constant.TOKEN_NAME);if?(StrUtil.isBlank(token)) {// parameter中也不存在tokenthrow?new?ServiceException(Constant.ResponseCode.ILLEGAL_ARGUMENT,?100);}}if?(!redisService.exists(token)) {throw?new?ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION,?200);}boolean?remove = redisService.remove(token);if?(!remove) {throw?new?ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION,?200);}return?true;}
}

攔截器的配置

web配置類，實現WebMvcConfigurerAdapter，主要作用就是添加autoIdempotentInterceptor到配置類中，這樣我們到攔截器才能生效，注意使用@Configuration注解，這樣在容器啟動是時候就可以添加進入context中。

@Configuration
public?class?WebConfiguration?extends?WebMvcConfigurerAdapter?{@Resourceprivate?AutoIdempotentInterceptor autoIdempotentInterceptor;/** * 添加攔截器 *?@param?registry */@Overridepublic?void?addInterceptors(InterceptorRegistry registry)?{registry.addInterceptor(autoIdempotentInterceptor);super.addInterceptors(registry);}
}

攔截處理器：主要的功能是攔截掃描到AutoIdempotent到注解到方法,然后調用tokenService的checkToken()方法校驗token是否正確，如果捕捉到異常就將異常信息渲染成json返回給前端。

/** * 攔截器 */
@Component
public?class?AutoIdempotentInterceptor?implements?HandlerInterceptor?{@Autowiredprivate?TokenService tokenService;/** * 預處理 * *?@param?request *?@param?response *?@param?handler *?@return?*?@throws?Exception */@Overridepublic?boolean?preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)?throws?Exception?{if?(!(handler?instanceof?HandlerMethod)) {return?true;}HandlerMethod handlerMethod = (HandlerMethod) handler;Method method = handlerMethod.getMethod();//被ApiIdempotment標記的掃描AutoIdempotent methodAnnotation = method.getAnnotation(AutoIdempotent.class);if?(methodAnnotation !=?null) {try?{return?tokenService.checkToken(request);// 冪等性校驗, 校驗通過則放行, 校驗失敗則拋出異常, 并通過統一異常處理返回友好提示}catch?(Exception ex){ResultVo failedResult = ResultVo.getFailedResult(101, ex.getMessage());writeReturnJson(response, JSONUtil.toJsonStr(failedResult));throw?ex;}}//必須返回true,否則會被攔截一切請求return?true;}@Overridepublic?void?postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)?throws?Exception?{}@Overridepublic?void?afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)?throws?Exception?{}/** * 返回的json值 *?@param?response *?@param?json *?@throws?Exception */private?void?writeReturnJson(HttpServletResponse response, String json)?throws?Exception{PrintWriter writer =?null;response.setCharacterEncoding("UTF-8");response.setContentType("text/html; charset=utf-8");try?{writer = response.getWriter();writer.print(json);}?catch?(IOException e) {}?finally?{if?(writer !=?null)writer.close();}}
}

測試用例

模擬業務請求類，首先我們需要通過/get/token路徑通過getToken()方法去獲取具體的token，然后我們調用testIdempotence方法，這個方法上面注解了@AutoIdempotent，攔截器會攔截所有的請求，當判斷到處理的方法上面有該注解的時候，就會調用TokenService中的checkToken()方法，如果捕獲到異常會將異常拋出調用者，下面我們來模擬請求一下：

@RestController
public?class?BusinessController {@Resourceprivate?TokenService tokenService;@Resourceprivate?TestService testService;@PostMapping("/get/token")public?String??getToken(){String?token = tokenService.createToken();if?(StrUtil.isNotEmpty(token)) {ResultVo resultVo =?new?ResultVo();resultVo.setCode(Constant.code_success);resultVo.setMessage(Constant.SUCCESS);resultVo.setData(token);return?JSONUtil.toJsonStr(resultVo);}return?StrUtil.EMPTY;}@AutoIdempotent@PostMapping("/test/Idempotence")public?String?testIdempotence() {String?businessResult = testService.testIdempotence();if?(StrUtil.isNotEmpty(businessResult)) {ResultVo successResult = ResultVo.getSuccessResult(businessResult);return?JSONUtil.toJsonStr(successResult);}return?StrUtil.EMPTY;}
}

使用postman請求，首先訪問get/token路徑獲取到具體到token：