接口冪等性如何實現？

時間 2020-03-28

原文原文鏈接

導讀

轉載自冪等性如何實現？深刻了解一波！！！
如今這個時代你們可能最關心的就是錢了，那麼有沒有想過你銀行轉帳給你沒有一次是轉多的，要麼失敗，要麼成功，爲何不能失誤一下多轉一筆呢？醒醒吧年輕人，別作夢了，作銀行的能那麼傻x嗎？
今天咱們就來談一談爲何銀行轉帳不能多給我轉一筆？關乎到錢的問題，小夥伴們打起精神！！！
要想要理解上述的疑惑，不得不提的一個概念就是冪等性，至於什麼是冪等性，如何經過代碼實現冪等性，下面將會詳細講述。

什麼是冪等性

所謂冪等性通俗的將就是一次請求和屢次請求同一個資源產生相同的反作用。用數學語言表達就是f(x)=f(f(x))。
維基百科的冪等性定義以下：

冪等（idempotent、idempotence）是一個數學與計算機學概念，常見於抽象代數中。
在編程中一個冪等操做的特色是其任意屢次執行所產生的影響均與一次執行的影響相同。冪等函數，或冪等方法，是指可使用相同參數重複執行，並能得到相同結果的函數。這些函數不會影響系統狀態，也不用擔憂重複執行會對系統形成改變。例如，「setTrue()」函數就是一個冪等函數,不管屢次執行，其結果都是同樣的，更復雜的操做冪等保證是利用惟一交易號(流水號)實現.

爲何須要冪等性

在系統高併發的環境下，頗有可能由於網絡，阻塞等等問題致使客戶端或者調用方並不能及時的收到服務端的反饋甚至是調用超時的問題。總之，就是請求方調用了你的服務，可是沒有收到任何的信息，徹底懵逼的狀態。好比訂單的問題，可能會遇到以下的幾個問題：

建立訂單時，第一次調用服務超時，再次調用是否產生兩筆訂單？
訂單建立成功去減庫存時，第一次減庫存超時，是否會多扣一次？
訂單支付時，服務端扣錢成功，可是接口反饋超時，此時再次調用支付，是否會多扣一筆呢？

做爲消費者，前兩種能接受，第三種狀況就MMP了，哈哈哈！！！這種狀況通常有以下兩種解決方式

服務方提供一個查詢操做是否成功的api，第一次超時以後，調用方調用查詢接口，若是查到了就走成功的流程，失敗了就走失敗的流程。
另外一種就是服務方須要使用冪等的方式保證一次和屢次的請求結果一致。

HTTP的冪等性

GET：只是獲取資源，對資源自己沒有任何反作用，自然的冪等性。
HEAD：本質上和GET同樣，獲取頭信息，主要是探活的做用，具備冪等性。
OPTIONS：獲取當前URL所支持的方法，所以也是具備冪等性的。
DELETE：用於刪除資源，有反作用，可是它應該知足冪等性，好比根據id刪除某一個資源，調用方能夠調用N次而不用擔憂引發的錯誤（根據業務需求而變）。
PUT：用於更新資源，有反作用，可是它應該知足冪等性，好比根據id更新數據，調用屢次和N次的做用是相同的（根據業務需求而變）。
POST：用於添加資源，屢次提交極可能產生反作用，好比訂單提交，屢次提交極可能產生多筆訂單。

冪等性的實現方式

對於客戶端交互的接口，能夠在前端攔截一部分，例如防止表單重複提交，按鈕置灰，隱藏，不可點擊等方式。可是前端進行攔截器顯然是針對普通用戶，懂點技術的均可以模擬請求調用接口，因此後端冪等性很重要。
後端的冪等性如何實現？將會從如下幾個方面介紹。

數據庫去重表

在往數據庫中插入數據的時候，利用數據庫惟一索引特性，保證數據惟一。好比訂單的流水號，也能夠是多個字段的組合。
實現比較簡單，讀者能夠本身實現看看，這裏再也不提供demo了。

狀態機

不少業務中多有多個狀態，好比訂單的狀態有提交、待支付、已支付、取消、退款等等狀態。後端能夠根據不一樣的狀態去保證冪等性，好比在退款的時候，必定要保證這筆訂單是已支付的狀態。
業務中經常出現，讀者能夠本身實現看看，再也不提供demo。

TOKEN機制

針對客戶端連續點擊或者調用方的超時重試等狀況，例如提交訂單，此種操做就能夠用Token的機制實現防止重複提交。
TOKEN機制如何實現？簡單的說就是調用方在調用接口的時候先向後端請求一個全局ID（TOKEN），請求的時候攜帶這個全局ID一塊兒請求，後端須要對這個全局ID校驗來保證冪等操做，流程以下圖：

主要的流程步驟以下：
- 客戶端先發送獲取token的請求，服務端會生成一個全局惟一的ID保存在redis中，同時把這個ID返回給客戶端。
- 客戶端調用業務請求的時候必須攜帶這個token，通常放在請求頭上。
- 服務端會校驗這個Token，若是校驗成功，則執行業務。
- 若是校驗失敗，則表示重複操做，直接返回指定的結果給客戶端。
經過以上的流程分析，惟一的重點就是這個全局惟一ID如何生成，在分佈式服務中每每都會有一個生成全局ID的服務來保證ID的惟一性，可是工程量和實現難度比較大，UUID的數據量相對有些大，此處陳某選擇的是雪花算法生成全局惟一ID，不瞭解雪花算法的讀者下一篇文章會着重介紹。

代碼實現

陳某選擇的環境是SpringBoot+Redis單機環境+註解+攔截器的方式實現，只是演示一下思想，具體的代碼能夠參照實現。
redis如何實現，獲取Token接口將全局惟一Id存入Redis（必定要設置失效時間，根據業務需求），業務請求的時候直接從redis中刪除，根據delete的返回值判斷，返回true表示第一次請求，返回false表示重複請求。代碼以下：

@Service
public class TokenServiceImpl implements TokenService {
    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    @Override
    public String getToken() {
        //獲取全局惟一id
        long nextId = SnowflakeUtil.nextId();
        //存入redis，設置10分鐘失效
        stringRedisTemplate.opsForValue().set(String.valueOf(nextId), UUID.randomUUID().toString(),10, TimeUnit.MINUTES);
        return String.valueOf(nextId);
    }

    /**
    * 刪除記錄，true表示第一次提交，false重複提交
    */
    @Override
    public Boolean checkToken(String token) {
        return stringRedisTemplate.delete(token);
    }
}

註解的實現以下，標註在controller類上表示當前類上所有接口都作冪等，標註單個方法上，表示單個接口作冪等操做。

/**
 * @Description 冪等操做的註解
 * @Author CJB
 * @Date 2020/3/25 10:19
 */
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RepeatLimiter {
}

請求頭的攔截器，用於提取請求頭和校驗請求頭，以下：

/**
 * @Description 獲取請求頭的信息，具體校驗邏輯讀者本身實現
 * @Author CJB
 * @Date 2020/3/25 11:09
 */
@Component
public class HeaderIntercept implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //獲取token
        String token = request.getHeader(HeaderConstant.TOKEN);
        //校驗邏輯
        if (!validToken(token))
            throw new TokenInvalidException("TOKEN失效");
        //獲取其餘的參數.....
        RequestHeader header = RequestHeader.builder()
                .token(token)
                .build();
        //放入request中
        request.setAttribute(HeaderConstant.HEADER_INFO,header);
        return true;
    }

    /**
     * 校驗token，邏輯本身實現
     * @param token
     * @return
     */
    private boolean validToken(String token){
        return Boolean.TRUE;
    }
}

保證冪等性的攔截器，直接從redis中刪除token，成功則第一次提交，不成功則重複提交。

@Component
public class RepeatIntercept implements HandlerInterceptor {

    @Autowired
    private TokenService tokenService;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler instanceof HandlerMethod){
            //獲取方法上的參數
            RepeatLimiter repeatLimiter = AnnotationUtils.findAnnotation(((HandlerMethod) handler).getMethod(), RepeatLimiter.class);

            if (Objects.isNull(repeatLimiter)){
                //獲取controller類上註解
                repeatLimiter=AnnotationUtils.findAnnotation(((HandlerMethod) handler).getBean().getClass(),RepeatLimiter.class);
            }

            //使用註解，須要攔截驗證
            if (Objects.nonNull(repeatLimiter)){
                //獲取全局token，表單提交的惟一id
                RequestHeader info = RequestContextUtils.getHeaderInfo();

                //沒有攜帶token，拋異常，這裏的異常須要全局捕獲
                if (StringUtils.isEmpty(info.getToken()))
                    throw new RepeatException();

                //校驗token
                Boolean flag = tokenService.checkToken(info.getToken());

                //刪除失敗，表示
                if (Boolean.FALSE.equals(flag))
                    //拋出重複提交的異常
                    throw new RepeatException();
            }
        }
        return true;
    }
}

接口冪等實現，代碼以下：

@RestController
@RequestMapping("/order")
public class OrderController {

    @Autowired
    private OrderService orderService;

    /**
     * 下單
     * @param order
     * @return
     */
    @PostMapping
    @RepeatLimiter  //冪等性保證
    public CommenResult add(@RequestBody Order order){
        orderService.save(order);
        return new CommenResult("200","下單成功");
    }
}