天天看點
傳回

接口幂等性如何實作？

導讀

  • 現在這個時代大家可能最關心的就是錢了，那麼有沒有想過你銀行轉賬給你沒有一次是轉多的，要麼失敗，要麼成功，為什麼不能失誤一下多轉一筆呢？醒醒吧年輕人，别做夢了，做銀行的能那麼傻x嗎？
  • 今天我們就來談一談為什麼銀行轉賬不能多給我轉一筆？關乎到錢的問題，小夥伴們打起精神！！！
  • 要想要了解上述的疑惑，不得不提的一個概念就是幂等性，至于什麼是幂等性，如何通過代碼實作幂等性，下面将會詳細講述。

什麼是幂等性

  • 所謂幂等性通俗的将就是一次請求和多次請求同一個資源産生相同的副作用。用數學語言表達就是

    f(x)=f(f(x))

     。
  • 維基百科的幂等性定義如下： 
幂等（idempotent、idempotence）是一個數學與計算機學概念，常見于抽象代數中。
在程式設計中一個幂等操作的特點是其任意多次執行所産生的影響均與一次執行的影響相同。幂等函數，或幂等方法，是指可以使用相同參數重複執行，并能獲得相同結果的函數。這些函數不會影響系統狀态，也不用擔心重複執行會對系統造成改變。例如，“setTrue()”函數就是一個幂等函數,無論多次執行，其結果都是一樣的，更複雜的操作幂等保證是利用唯一交易号(流水号)實作.

為什麼需要幂等性

  • 在系統高并發的環境下，很有可能因為網絡，阻塞等等問題導緻用戶端或者調用方并不能及時的收到服務端的回報甚至是調用逾時的問題。總之，就是請求方調用了你的服務，但是沒有收到任何的資訊，完全懵逼的狀态。比如訂單的問題，可能會遇到如下的幾個問題：
  1. 建立訂單時，第一次調用服務逾時，再次調用是否産生兩筆訂單？
  2. 訂單建立成功去減庫存時，第一次減庫存逾時，是否會多扣一次？
  3. 訂單支付時，服務端扣錢成功，但是接口回報逾時，此時再次調用支付，是否會多扣一筆呢？
  • 作為消費者，前兩種能接受，第三種情況就MMP了，哈哈哈！！！這種情況一般有如下兩種解決方式
  1. 服務方提供一個查詢操作是否成功的api，第一次逾時之後，調用方調用查詢接口，如果查到了就走成功的流程，失敗了就走失敗的流程。
  2. 另一種就是服務方需要使用幂等的方式保證一次和多次的請求結果一緻。

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","下單成功");
    }
}

示範

  • 發送getToken的請求擷取Token
接口幂等性如何實作？
  • 攜帶Token下單第一次：
接口幂等性如何實作？
  • 第二次下單：
接口幂等性如何實作？

如果覺得作者寫的好，有所收獲的話，點個關注，推薦一波，文章首發于公衆号！！！

ssm springboot spring java 程式員 架構
上一篇: 天天在用Redis，持久化方案你又知道哪些？
下一篇: 大牛都在用的IDEA調試技巧

繼續閱讀