Spring Boot + Redis 解決重復提交問題，還有誰不會？？-有解無憂

作者｜慕容千語
來源：https://www.jianshu.com/p/c806003a8530

前言

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

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，

推薦一個 Spring Boot 基礎教程及實戰示例：
https://github.com/javastacks/spring-boot-best-practice

/**
 * redis工具類
 */
@Component
public class RedisService {

    @Autowired
    private RedisTemplate redisTemplate;

    /**
     * 寫入快取
     * @param key
     * @param value
     * @return
     */
    public boolean set(finalString 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(finalString 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(finalString key) {
        return redisTemplate.hasKey(key);
    }

    /**
     * 讀取快取
     * @param key
     * @return
     */
    public Objectget(finalString key) {
        Object result = null;
        ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
        result = operations.get(key);
        return result;
    }

    /**
     * 洗掉對應的value
     * @param key
     */
    public boolean remove(finalString key) {
        if (exists(key)) {
            Boolean delete = redisTemplate.delete(key);
            return delete;
        }
        returnfalse;

    }

}

自定義注解 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來獲取具體的報錯資訊回傳給前端，

publicinterface 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
publicclass TokenServiceImpl implements TokenService {

    @Autowired
    private RedisService redisService;

    /**
     * 創建token
     *
     * @return
     */
    @Override
    public 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();
        }
        returnnull;
    }

    /**
     * 檢驗token
     *
     * @param request
     * @return
     */
    @Override
    public boolean checkToken(HttpServletRequest request) throws Exception {

        String token = request.getHeader(Constant.TOKEN_NAME);
        if (StrUtil.isBlank(token)) {// header中不存在token
            token = request.getParameter(Constant.TOKEN_NAME);
            if (StrUtil.isBlank(token)) {// parameter中也不存在token
                thrownew ServiceException(Constant.ResponseCode.ILLEGAL_ARGUMENT, 100);
            }
        }

        if (!redisService.exists(token)) {
            thrownew ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
        }

        boolean remove = redisService.remove(token);
        if (!remove) {
            thrownew ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
        }
        returntrue;
    }
}

攔截器的配置

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

@Configuration
publicclass WebConfiguration extends WebMvcConfigurerAdapter {

    @Resource
   private AutoIdempotentInterceptor autoIdempotentInterceptor;

    /**
     * 添加攔截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(autoIdempotentInterceptor);
        super.addInterceptors(registry);
    }
}

攔截處理器：主要的功能是攔截掃描到AutoIdempotent到注解到方法,然后呼叫tokenService的checkToken()方法校驗token是否正確，如果捕捉到例外就將例外資訊渲染成json回傳給前端，

/**
 * 攔截器
 */
@Component
publicclass AutoIdempotentInterceptor implements HandlerInterceptor {

    @Autowired
    private TokenService tokenService;

    /**
     * 預處理
     *
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        if (!(handler instanceof HandlerMethod)) {
            returntrue;
        }
        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,否則會被攔截一切請求
        returntrue;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public 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
publicclass BusinessController {

    @Resource
    private TokenService tokenService;

    @Resource
    private 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：

利用獲取到到token,然后放到具體請求到header中,可以看到第一次請求成功，接著我們請求第二次：

第二次請求，回傳到是重復性操作，可見重復性驗證通過，再多次請求到時候我們只讓其第一次成功，第二次就是失敗：

總結

本篇博客介紹了使用springboot和攔截器、redis來優雅的實作介面冪等，對于冪等在實際的開發程序中是十分重要的，因為一個介面可能會被無數的客戶端呼叫，如何保證其不影響后臺的業務處理，如何保證其只影響資料一次是非常重要的，它可以防止產生臟資料或者亂資料，也可以減少并發量，實乃十分有益的一件事，而傳統的做法是每次判斷資料，這種做法不夠智能化和自動化，比較麻煩，而今天的這種自動化處理也可以提升程式的伸縮性，

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2021最新版)

2.別在再滿屏的 if/ else 了，試試策略模式，真香！！

3.臥槽！Java 中的 xx ≠ null 是什么新語法？

4.Spring Boot 2.6 正式發布，一大波新特性，，

5.《Java開發手冊（嵩山版）》最新發布，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/379064.html

標籤：其他

上一篇：想聽一首歌好難？程式員教你一鍵下載

下一篇：C/C++語言結構體指標的使用