幂等性和实现方法

tq1086

已于 2023-08-21 23:53:14 修改

阅读量310

点赞数

文章标签：接口设计

于 2020-12-09 11:38:16 首次发布

本文链接：https://blog.csdn.net/tq1086/article/details/110919471

版权

如果一个操作重复执行多次，其效果（不考虑操作时间）和只执行一次是一样的，那么这个操作就叫做是幂等（idempotent）的。乍看起来，幂等操作似乎没什么用处，毕竟只有第一次执行有效。但如果在系统设计中考虑到“失败”场景的话，幂等操作是非常重要的。因为失败发生和感知失败发生是两件不同的事情。想象两个服务器进行通过网络进行通信。服务器A发送请求到服务器B，服务器B执行操作并将结果返回A。在理想的情况下，一切执行顺利。我们从服务器A的角度来看看发生了什么。首先服务器A发出一个请求，等待了一会后，服务A收到一个应答，里面的消息说明操作成功。现在我们引入失败场景。可能的失败有这么几种：

服务器A发送请求失败。
服务器B接收请求失败。
服务器B处理请求失败。
服务器B发送应答失败。
服务器A接收应答失败。

从服务器A的角度来看，除了第1种失败可以立刻感知外，其他的失败都存在无法被感知的可能。在一个更加实际的场景中，服务器A发送了请求，等待了一会，没有收到应答。服务器A无法判断操作是成功了还是失败了。它应该继续等待吗？还是要重新发送请求呢？选择继续等待，如果服务器B发生故障，服务器A将陷入永久停滞。选择重新发送请求，如果服务器B已经成功执行了操作（失败情形4、5），再次请求会引发重复操作。假设请求的操作是“支付100元”，重复操作的效果将是“支付200元”，这不是服务器A的真实意图。可如果这是一个幂等操作，无论重复几次效果都和执行一次相同，那么服务器A就可以放心的重发请求。这就是幂等操作的好处。幂等操作可以大大简化客户代码的失败处理逻辑，提高系统整体的稳定性。

要避免重复操作，必须能唯一识别操作，因此需要为操作分配唯一编号。服务器记录下唯一编号和操作执行结果。当收到具有相同编号的请求时，不再执行操作，将第一次操作的结果返回。

Listing 1: 非幂等操作：客户代码

Operation operation = new Operation("do some thing");
OperationResult result = server.remoteExecute(operation);

Listing 2: 非幂等操作：服务代码

public OperationResult onRequest(Operation operation) {
  OperationResult result = doOperate(operation);
  return result;
}

Listing 3: 幂等操作：客户代码

String operationNumber = server.allocateOperationNumber();
Operation operation = new Operation(operationNumber, "do some thing");
OperationResult result = server.remoteExecute(operation);

Listing 4: 幂等操作：服务代码

public OperationResult onRequest(Operation operation) {
  Optional<OperationResult> resultOpt = findOperationResult(operation.getOperationNumber());
  if (resultOpt.isPresent()) {
    return resultOpt.get();
  }

  OperationResult result = doOperate(operation);
  storeOperationResult(operation.getOperationNumber(), result);
  return result;
}

可以看到幂等操作分两步：分配编号、执行操作。需要说明一下，这里提到的幂等性是从业务状态变更的角度讲的。业务状态是类似用户名、账户余额这类具有业务意义的数据。操作编号本身没有业务意义。无论分配了多少个编号，业务状态都没有改变，因此分配编号行为被认为是幂等的。在执行操作这一步，有了唯一编号就可以确认操作的执行状态，保证只有首次请求时操作才会得到执行。后续请求只是在读取首次执行的结果，也没有改变业务状态，因此也是幂等的。

幂等操作多了一次请求，这会带来性能开销。一个改进方法是批量分配编号。每次客户端申请时，服务器返回多个编号，后续操作只需要一次网络请求。