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

1: 資料庫建立唯一性索引，可以保證最終插入資料庫的隻有一條資料

2: token 機制，每次接口請求前先擷取一個 token，然後再下次請求的時候在請求的 header 體中加上這個 token，背景進行驗證，如果驗證通過删除 token，下次請求再次判斷 token

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

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

redis 實作自動幂等的原理圖：

一：搭建 redis 的服務 Api

1: 首先是搭建 redis 伺服器。詳情可參考：https://www.cnblogs.com/wyq178/p/10340234.html

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

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

    @Autowired
    private 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 建立和檢驗

1: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;

}

2:token 的服務實作類

token 引用了 redis 服務，建立 token 采用随機算法工具類生成随機 uuid 字元串, 然後放入到 redis 中 (為了防止資料的備援保留, 這裡設定過期時間為 10000 秒, 具體可視業務而定)，如果放入成功，最後傳回這個 token 值。checkToken 方法就是從 header 中擷取 token 到值 (如果 header 中拿不到，就從 paramter 中擷取)，如若不存在, 直接抛出異常。這個異常資訊可以被攔截器捕捉到，然後傳回給前端。

@Service
public class TokenServiceImpl implements TokenService {

    @Autowired
    private RedisService redisService;


    /**
     * 建立token
     *
     * @return
     */
    @Override
    public String createToken() {
        String token = RandomUtil.randomUUID();
        try {
            redisService.setEx(token, token,10000L);
            return token;
        }catch (Exception ex){
            ex.printStackTrace();
        }
        return null;
    }


 /**
     * 檢驗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
                throw new ServiceException(ResponseCode.ILLEGAL_ARGUMENT.getCode(), ResponseCode.ILLEGAL_ARGUMENT.getMsg());
            }
        }

        if (!redisService.exists(token)) {
            throw new ServiceException(ResponseCode.REPETITIVE_OPERATION.getCode(), ResponseCode.REPETITIVE_OPERATION.getMsg());
        }

        boolean remove = redisService.remove(token);
        if (!remove) {
            throw new ServiceException(ResponseCode.REPETITIVE_OPERATION.getCode(), ResponseCode.REPETITIVE_OPERATION.getMsg());
        }
        return true;
    }

四：攔截器的配置

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

@Configuration
public class WebConfiguration extends WebMvcConfigurerAdapter {

    @Resource
   private AutoIdempotentInterceptor autoIdempotentInterceptor;

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

2: 攔截處理器：主要的功能是攔截掃描到 AutoIdempotent 到注解到方法, 然後調用 tokenService 的 checkToken() 方法校驗 token 是否正确，如果捕捉到異常就将異常資訊渲染成 json 傳回給前端

/**
 * 攔截器
 */
@Component
public class AutoIdempotentInterceptor implements HandlerInterceptor {
    private Logger Logger = LoggerFactory.getLogger(AutoIdempotentInterceptor.class);

    @Autowired
    private TokenService tokenService;

    /**
     * 預處理
     *在請求處理之前進行調用(Controller方法調用之前)
     * @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)) {
            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 (ServiceException ex){
                ReturnResult<Object> objectReturnResult = ReturnResult.withNormal(ex.getCode(), ex.getMsg());
                writeReturnJson(response, JSONUtil.toJsonStr(objectReturnResult));
                throw ex;
            }
        }
        //必須傳回true,否則會被攔截一切請求
        return true;
    }


    /**
     * 請求處理之後進行調用，但是在視圖被渲染之前（Controller方法調用之後）
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    /**
     *  整個請求結束之後被調用，也就是在DispatchServlet渲染了對應的視圖之後執行（主要用于進行資源清理工作）
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }

    /**
     * 傳回的json值
     * @param response
     * @param content
     * @throws Exception
     */
    private void writeReturnJson(HttpServletResponse response, String content){
        PrintWriter writer = null;
        response.setCharacterEncoding("UTF-8");
        response.setContentType("application/text; charset=utf-8");
        // response.setContentType("application/json; charset=utf-8");
        try {
            writer = response.getWriter();
            // writer.write(content);
            writer.print(content);
        } catch (IOException e) {
        } finally {
            if (writer != null)
                writer.close();
        }
    }

}

五：測試用例

1: 模拟業務請求類

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

@RestController
@RequestMapping("/test")
public class TestController {

    @Resource
    private TokenService tokenService;

    @PostMapping("/getToken")
    public String  getToken(){
        String token = tokenService.createToken();
        return JSONUtil.toJsonStr(ReturnResult.withSuccess(token));
    }

    @AutoIdempotent
    @PostMapping("/testIdempotence")
    public String testIdempotence() {
        return JSONUtil.toJsonStr(ReturnResult.withSuccess());
    }
}

2: 使用 postman 請求

首先通路 test/getToken路徑擷取到具體到 token：

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

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

六：總結

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

如果您有其他的實作方式，也可以分享出來。

作者：Yrion

來源：https://www.cnblogs.com/wyq178/p/11130034.html

這裡還有一篇也是通過redis來實作的，

https://blog.csdn.net/jiahao1186/article/details/91793691

代碼位置，

https://gitee.com/bluede/auto-idempotent.git

點選關注，帶你了解更多

redis+Interceptor+自定義annotation實作接口自動幂等

一：搭建 redis 的服務 Api

二：自定義注解 AutoIdempotent

三：token 建立和檢驗

1:token 服務接口

2:token 的服務實作類

四：攔截器的配置

五：測試用例

1: 模拟業務請求類

2: 使用 postman 請求

繼續閱讀

秒懂JVM的三大參數類型，就靠這十個小實驗了初級—中級—進階三個級别的大廠面試真題阿裡雲——Java 實習生/初級美團——Java 中級螞蟻金服——Java 進階基礎篇JVM 篇MySQL 篇Redis 篇

CentOs7 安裝redis4.0 遇到的坑一、CentOs7連接配接網絡二、make檔案的時候出錯三、安裝ruby的redis插件時候報錯最後

docker 搭建Redis 問題解決

如何解決Redis緩存擊穿、雪崩、穿透問題

java 版本的redis-stat不能運作在背景和daemon

redis管理常用指令

django短信驗證碼的後端實作

Redis訂閱了一段時間後訂閱失效了（ redisTemplate.convertAndSend）

2022秋招面試總結（cpp+java+測開）百度測開一面位元組後端一面蝦皮後端一面蝦皮後端二面

資料遷移方法資料遷移原則資料遷移之雙寫方案資料遷移之級聯同步方案

微服務-性能壓測\緩存redis和分布式鎖redisson和SpringCache

Nacos 2.0 更新前後性能對比壓測

Spring資料和Redis

redis叢集資料一緻性_RedisRaft為Redis叢集帶來強大的資料一緻性

supervisor 管理redis 和httpd 環境centos7

Redis簡介一(單機版)發展曆程Redis