接口幂等性设计的最佳实现

素颜马尾好姑娘i 2023-10-15 13:03 23阅读 0赞

一、什么是幂等  
二、为什么需要幂等  
三、接口超时了，到底如何处理？  
四、如何设计幂等  
全局的唯一性ID  
幂等设计的基本流程  
五、实现幂等的8种方案  
select+insert+主键/唯一索引冲突  
直接insert + 主键/唯一索引冲突  
状态机幂等  
抽取防重表  
token令牌  
悲观锁(如select for update)  
乐观锁  
分布式锁  
六、总结

**一、什么是幂等**  
幂等是一个数学与计算机科学概念。

在数学中，幂等用函数表达式就是：f(x) = f(f(x))。比如求绝对值的函数，就是幂等的，abs(x) = abs(abs(x))。  
计算机科学中，幂等表示一次和多次请求某一个资源应该具有同样的副作用，或者说，多次请求所产生的影响与一次请求执行的影响效果相同。  
产生原因

总的来说，在软件系统中出现幂等问题的原因无非四个：

①用户重复提交：一般是指用户填写好表单信息后，由于响应较慢，从而多次点击提交按钮。  
②非法调用：指第三方通过逆向手段调试到了接口地址，然后通过爬虫或接口工具多次调用。  
③失败重试：指分布式项目中，被调用方出现超时或异常时，触发了调用方的重试补偿机制。  
④重复消息：通常指引入MQ的项目，对于同一个消息，生产者多次发送，或消费者重复消费。

二、为什么需要幂等  
举个例子：

我们开发一个转账功能，假设我们调用下游接口超时了。一般情况下，超时可能是网络传输丢包的问题，也可能是请求时没送到，还有可能是请求到了，返回结果却丢了。这时候我们是否可以重试呢？如果重试的话，是否会多转了一笔钱呢？  
![在这里插入图片描述][65292e33f4564e04845871a88b58980a.png]  
当前互联网的系统几乎都是解耦隔离后，会存在各个不同系统的相互远程调用。调用远程服务会有三个状态：成功，失败，或者超时。前两者都是明确的状态，而超时则是未知状态。我们转账超时的时候，如果下游转账系统做好幂等控制，我们发起重试，那即可以保证转账正常进行，又可以保证不会多转一笔。

其实除了转账这个例子，日常开发中，还有很多很多例子需要考虑幂等。比如：

MQ（消息中间件）消费者读取消息时，有可能会读取到重复消息。（重复消费）  
比如提交form表单时，如果快速点击提交按钮，可能产生了两条一样的数据（前端重复提交）  
分布式场景下，多个业务系统间实现强一致的协议是极其困难的。一个最简单和可实现的假设就是保证最终一致性，这要求服务端在处理一个重复的请求时需要给出相同的回应，同时不会对持久化数据产生副作用（即多次操作与单次操作的结果需要是业务角度一致的）。

一个API拥有幂等能力的话，调用发起方就可以很安全的进行重试。这符合我们普遍的假设。提供幂等能力是服务提供方必须需要做的事。

拥有幂等能力的话可以保证我们的接口不会被各种异常重试或恶意请求锁冲击。  
三、接口超时了，到底如何处理？  
如果我们调用下游接口超时了，我们应该怎么处理呢？

有两种方案处理：

方案一：就是下游系统提供一个对应的查询接口。如果接口超时了，先查下对应的记录，如果查到是成功，就走成功流程，如果是失败，就按失败处理。  
拿我们的转账例子来说，转账系统提供一个查询转账记录的接口，如果渠道系统调用转账系统超时时，渠道系统先去查询一下这笔记录，看下这笔转账记录成功还是失败，如果成功就走成功流程，失败再重试发起转账。  
![在这里插入图片描述][c01cf37d60004a2a8c4562a42ddd2892.png]  
方案二：下游接口支持幂等，上游系统如果调用超时，发起重试即可。  
![在这里插入图片描述][032d064d08234e439b00dd281c03e531.png]  
两种方案都是挺不错的，但是如果是MQ重复消费的场景，方案一处理并不是很妥，所以，我们还是要求下游系统对外接口支持幂等。

**四、如何设计幂等  
既然这么多场景需要考虑幂等，那我们如何设计幂等呢？**

一个具有幂等性的服务，要求无论重复请求在多么极端的情况下发生，都要表里如一，此时必须满足：

对外：返回完全相同的结果

对内：自身状态不再发生任何改变

对于服务提供方来说：严格来说需要请求中的字段完全一样，服务提供方才认为是重复请求。但是在实际环境中我们可能没有这么严格的要求，我们一般认为只要关键的业务参数相同，那么他就属于重复请求，应该被幂等处理。

对于服务调用方来说：需要做好幂等结果处理，多次请求返回相同结果需要正确被处理

幂等设计要尽量从简单、可靠、高效（过多的幂等逻辑会对可用性和性能造成影响）角度出发

简单：幂等流程和逻辑要尽量简单  
可靠：不仅仅在正常运行的情况下要保证幂等的可靠性，在某些异常场景下也要尽量保证幂等的可靠性，否则该幂等设计的意义将大打折扣  
高效：幂等逻辑执行不能高耗时，针对于一些高并发的接口需要做到尽量减少幂等逻辑执行耗时  
通用幂等组件设计易用性和可扩展性也同样重要

幂等意味着一条请求的唯一性。不管是你哪个方案去设计幂等，都需要一个全局唯一的ID，去标记这个请求是独一无二的。

如果你是利用唯一索引控制幂等，那唯一索引是唯一的  
如果你是利用数据库主键控制幂等，那主键是唯一的  
如果你是悲观锁的方式，底层标记还是全局唯一的ID  
————————————————

全局的唯一性ID  
全局唯一性ID，我们怎么去生成呢？你可以回想下，数据库主键Id怎么生成的呢？

是的，我们可以使用UUID，但是UUID的缺点比较明显，它字符串占用的空间比较大，生成的ID过于随机，可读性差，而且没有递增。

我们还可以使用雪花算法（Snowflake） 生成唯一性ID。

雪花算法是一种生成分布式全局唯一ID的算法，生成的ID称为Snowflake IDs。这种算法由Twitter创建，并用于推文的ID。

一个Snowflake ID有64位。

第1位：Java中long的最高位是符号位代表正负，正数是0，负数是1，一般生成ID都为正数，所以默认为0。  
接下来前41位是时间戳，表示了自选定的时期以来的毫秒数。  
接下来的10位代表计算机ID，防止冲突。  
其余12位代表每台机器上生成ID的序列号，这允许在同一毫秒内创建多个Snowflake ID。  
![在这里插入图片描述][3622e945224d465cbf1d28e706ea5f79.png]  
当然，全局唯一性的ID，还可以使用百度的Uidgenerator，或者美团的Leaf。

幂等设计的基本流程  
幂等处理的过程，说到底其实就是过滤一下已经收到的请求，当然，请求一定要有一个全局唯一的ID标记哈。然后，怎么判断请求是否之前收到过呢？把请求储存起来，收到请求时，先查下存储记录，记录存在就返回上次的结果，不存在就处理请求。

一般的幂等处理就是这样啦，如下：  
![在这里插入图片描述][f9f95ba9ae80410a8503f0c37f7abaaa.png_pic_center]  
五、实现幂等的8种方案  
幂等设计的基本流程都是类似的，我们简简单单来过一下幂等实现的8中方案哈~

select+insert+主键/唯一索引冲突  
日常开发中，为了实现交易接口幂等，我是这样实现的：

交易请求过来，我会先根据请求的唯一流水号 bizSeq字段，先select一下数据库的流水表

如果数据已经存在，就拦截是重复请求，直接返回成功；  
如果数据不存在，就执行insert插入，如果insert成功，则直接返回成功，如果insert产生主键冲突异常，则捕获异常，接着直接返回成功。  
流程图如下  
![在这里插入图片描述][82c5448a79834528a9995cfe62e3c27f.png]

/**
     * 幂等处理
     */
    Rsp idempotent（Request req）{
        
      Object requestRecord =selectByBizSeq（bizSeq）;
      
      if(requestRecord !=null){
        
        //拦截是重复请求
         log.info("重复请求，直接返回成功，流水号：{}",bizSeq);
         return rsp;
      }
      
      try{
        
        insert(req);
      }catch(DuplicateKeyException e){
        
        //拦截是重复请求，直接返回成功
        log.info("主键冲突，是重复请求，直接返回成功，流水号：{}",bizSeq);
        return rsp;
      }
      
      //正常处理请求
      dealRequest(req);
      
      return rsp;
    }

为什么前面已经select查询了，还需要try…catch…捕获重复异常呢？

是因为高并发场景下，两个请求去select的时候，可能都没查到，然后都走到insert的地方啦。

当然，用唯一索引代替数据库主键也是可以的哈，都是全局唯一的ID即可。

直接insert + 主键/唯一索引冲突  
在5.1方案中，都会先查一下流水表的交易请求，判断是否存在，然后不存在再插入请求记录。如果重复请求的概率比较低的话，我们可以直接插入请求，利用主键/唯一索引冲突，去判断是重复请求。  
![在这里插入图片描述][72103682e3304a4e8abe617b38c1e58f.png]

/**
     * 幂等处理
     */
    Rsp idempotent（Request req）{
        
      
      try{
        
        insert(req);
      }catch(DuplicateKeyException e){
        
         //拦截是重复请求，直接返回成功
        log.info("主键冲突，是重复请求，直接返回成功，流水号：{}",bizSeq);
        return rsp;
      }
      
      //正常处理请求
      dealRequest(req);
      return rsp;
    }

大家别搞混哈，防重和幂等设计其实是有区别的。防重主要为了避免产生重复数据，把重复请求拦截下来即可。而幂等设计除了拦截已经处理的请求，还要求每次相同的请求都返回一样的结果。不过呢，很多时候，它们的处理可以是类似，只是返回响应不一样。

状态机幂等  
很多业务表，都是有状态的，比如转账流水表，就会有0-待处理，1-处理中、2-成功、3-失败状态。转账流水更新的时候，都会涉及流水状态更新，即涉及状态机 (即状态变更图)。我们可以利用状态机实现幂等，一起来看下它是怎么实现的。

比如转账成功后，把处理中的转账流水更新为成功状态，SQL这么写：

update transfr_flow set status=2 where biz_seq=‘666’ and status=1;

![在这里插入图片描述][bb4fe3cfb9a6494cb7930c03be729876.png]

Rsp idempotentTransfer（Request req）{
        
       String bizSeq = req.getBizSeq();
       int rows= "update transfr_flow set status=2 where biz_seq=#{bizSeq} and status=2;"
       if(rows==1){
        
          log.info(“更新成功,可以处理该请求”);
          //其他业务逻辑处理
          return rsp;
       }else if(rows==0){
        
          log.info(“更新不成功，不处理该请求”);
          //不处理，直接返回
          return rsp;
       }
       
       log.warn("数据异常")
       return rsp：
    }

状态机是怎么实现幂等的呢？
    
    第1次请求来时，bizSeq流水号是 666 ，该流水的状态是处理中，值是 1 ，要更新为2-成功的状态 ，所以该update语句可以正常更新数据，sql执行结果的影响行数是1，流水状态最后变成了2。
    第2请求也过来了，如果它的流水号还是 666 ，因为该流水状态已经2-成功的状态 了，所以更新结果是0，不会再处理业务逻辑，接口直接返回成功。

抽取防重表  
1和2的方案，都是建立在业务流水表上bizSeq的唯一性上。很多时候，我们业务表唯一流水号希望后端系统生成，又或者我们希望防重功能与业务表分隔开来，这时候我们可以单独搞个防重表。当然防重表也是利用主键/索引的唯一性，如果插入防重表冲突即直接返回成功，如果插入成功，即去处理请求。

token令牌  
token 令牌方案一般包括两个请求阶段：

客户端请求申请获取token，服务端生成token返回  
客户端带着token请求，服务端校验token  
![在这里插入图片描述][1fbba08209ca41c6adfd5696746d3fec.png]  
客户端发起请求，申请获取token。  
服务端生成全局唯一的token，保存到redis中（一般会设置一个过期时间），然后返回给客户端。  
客户端带着token，发起请求。  
服务端去redis确认token是否存在，一般用 redis.del(token) 的方式，如果存在会删除成功，即处理业务逻辑，如果删除失败不处理业务逻辑，直接返回结果。

悲观锁(如select for update)  
什么是悲观锁？

通俗点讲就是很悲观，每次去操作数据时，都觉得别人中途会修改，所以每次在拿数据的时候都会上锁。官方点讲就是，共享资源每次只给一个线程使用，其它线程阻塞，用完后再把资源转让给其它线程。

悲观锁如何控制幂等的呢？就是加锁呀，一般配合事务来实现。

举个更新订单的业务场景：

假设先查出订单，如果查到的是处理中状态，就处理完业务，再然后更新订单状态为完成。如果查到订单，并且是不是处理中的状态，则直接返回

整体的伪代码如下：

begin;  # 1.开始事务
    select * from order where order_id='666' # 查询订单，判断状态
    if（status !=处理中）{
        
       //非处理中状态，直接返回；
       return ;
    }
    ## 处理业务逻辑
    update order set status='完成' where order_id='666' # 更新完成
    commit; # 5.提交事务

这种场景是非原子操作的，在高并发环境下，可能会造成一个业务被执行两次的问题：

当一个请求A在执行中时，而另一个请求B也开始状态判断的操作。因为请求A还未来得及更改状态，所以请求B也能执行成功，这就导致一个业务被执行了两次。

可以使用数据库悲观锁（select …for update）解决这个问题.

begin;  # 1.开始事务
    select * from order where order_id='666' for update # 查询订单，判断状态,锁住这条记录
    if（status !=处理中）{
        
       //非处理中状态，直接返回；
       return ;
    }
    ## 处理业务逻辑
    update order set status='完成' where order_id='666' # 更新完成
    commit; # 5.提交事务

这里面order\_id需要是索引或主键哈，要锁住这条记录就好，如果不是索引或者主键，会锁表的！  
悲观锁在同一事务操作过程中，锁住了一行数据。别的请求过来只能等待，如果当前事务耗时比较长，就很影响接口性能。所以一般不建议用悲观锁做这个事情。

乐观锁  
悲观锁有性能问题，可以试下乐观锁。

什么是乐观锁？

乐观锁在操作数据时,则非常乐观，认为别人不会同时在修改数据，因此乐观锁不会上锁。只是在执行更新的时候判断一下，在此期间别人是否修改了数据。

怎样实现乐观锁呢？

就是给表的加多一列version版本号，每次更新记录version都升级一下（version=version+1）。具体流程就是先查出当前的版本号version，然后去更新修改数据时，确认下是不是刚刚查出的版本号，如果是才执行更新

比如，我们更新前，先查下数据，查出的版本号是version =1

select order_id，version from order where order_id='666'；

然后使用version =1 和订单Id一起作为条件，再去更新

update order set version = version +1，status='P' where  order_id='666' and version =1

最后更新成功，才可以处理业务逻辑，如果更新失败，默认为重复请求，直接返回。  
![在这里插入图片描述][785220a2c11b4202b14d8eb88cbe47d0.png]  
为什么版本号建议自增的呢？

因为乐观锁存在ABA的问题，如果version版本一直是自增的就不会出现ABA的情况啦。

分布式锁  
分布式锁实现幂等性的逻辑就是，请求过来时，先去尝试获得分布式锁，如果获得成功，就执行业务逻辑，反之获取失败的话，就舍弃请求直接返回成功。执行流程如下图所示：  
![在这里插入图片描述][a841731126764f558082059b18c9842a.png]  
分布式锁可以使用Redis，也可以使用ZooKeeper，不过还是Redis相对好点，因为较轻量级。  
Redis分布式锁，可以使用命令SET EX PX NX + 唯一流水号实现，分布式锁的key必须为业务的唯一标识哈  
Redis执行设置key的动作时，要设置过期时间哈，这个过期时间不能太短，太短拦截不了重复请求，也不能设置太长，会占存储空间。

六、总结  
幂等性应该是合格程序员的一个基因，在设计系统时，是首要考虑的问题，尤其是在像第三方支付平台，银行，互联网金融公司等涉及的网上资金系统，既要高效，数据也要准确，所以不能出现多扣款，多打款等问题，这样会很难处理，并会大大降低用户体验。

[65292e33f4564e04845871a88b58980a.png]: https://img-blog.csdnimg.cn/65292e33f4564e04845871a88b58980a.png
[c01cf37d60004a2a8c4562a42ddd2892.png]: https://img-blog.csdnimg.cn/c01cf37d60004a2a8c4562a42ddd2892.png
[032d064d08234e439b00dd281c03e531.png]: https://img-blog.csdnimg.cn/032d064d08234e439b00dd281c03e531.png
[3622e945224d465cbf1d28e706ea5f79.png]: https://img-blog.csdnimg.cn/3622e945224d465cbf1d28e706ea5f79.png
[f9f95ba9ae80410a8503f0c37f7abaaa.png_pic_center]: https://img-blog.csdnimg.cn/f9f95ba9ae80410a8503f0c37f7abaaa.png#pic_center
[82c5448a79834528a9995cfe62e3c27f.png]: https://img-blog.csdnimg.cn/82c5448a79834528a9995cfe62e3c27f.png
[72103682e3304a4e8abe617b38c1e58f.png]: https://img-blog.csdnimg.cn/72103682e3304a4e8abe617b38c1e58f.png
[bb4fe3cfb9a6494cb7930c03be729876.png]: https://img-blog.csdnimg.cn/bb4fe3cfb9a6494cb7930c03be729876.png
[1fbba08209ca41c6adfd5696746d3fec.png]: https://img-blog.csdnimg.cn/1fbba08209ca41c6adfd5696746d3fec.png
[785220a2c11b4202b14d8eb88cbe47d0.png]: https://img-blog.csdnimg.cn/785220a2c11b4202b14d8eb88cbe47d0.png
[a841731126764f558082059b18c9842a.png]: https://img-blog.csdnimg.cn/a841731126764f558082059b18c9842a.png