万变不离其宗：浅析 Spring Boot 接口幂等性实现策略

后端

2023-04-27 13:24:57

接口幂等性：微服务安全的基石

在当今以并发请求为主导的数字环境中，确保接口幂等性至关重要，它可以防止数据不一致，确保微服务应用的稳定性。

什么是接口幂等性？

接口幂等性指的是一个接口在面对重复请求时，其执行结果始终保持一致，无论请求次数多少。这避免了并发请求对数据的意外修改，从而保证了应用的可靠性。

Spring Boot 的幂等性实现方案

Spring Boot 提供了多种实现接口幂等性的方案，每种方案都有其独特的优势：

1. 基于 Token 的幂等性实现

基于 Token 的方案通过一个全局唯一的令牌来识别请求，如果已存在此令牌，则直接返回结果，避免了重复执行。

@PostMapping("/api/create-order")
public ResponseEntity<Order> createOrder(@RequestBody Order order, @RequestHeader(value = "token") String token) {
    // 检查令牌是否存在
    if (tokenRepository.existsById(token)) {
        return ResponseEntity.status(HttpStatus.OK).body(order);
    }

    // 保存令牌并执行业务逻辑
    tokenRepository.save(new Token(token));
    return ResponseEntity.status(HttpStatus.CREATED).body(orderService.createOrder(order));
}

2. 基于 ETag 的幂等性实现

基于 ETag 的方案使用实体标签来标识资源的版本，如果请求携带的 ETag 与服务器上的 ETag 不匹配，则说明资源已更新，需要重新获取。

@GetMapping("/api/get-product/{id}")
public ResponseEntity<Product> getProduct(@PathVariable Long id, @RequestHeader(value = "If-None-Match") String etag) {
    // 检查 ETag
    if (etag.equals(productRepository.findById(id).get().getEtag())) {
        return ResponseEntity.status(HttpStatus.NOT_MODIFIED).build();
    }

    // 返回更新后的产品
    Product product = productService.getProduct(id);
    return ResponseEntity.status(HttpStatus.OK).body(product);
}

3. 基于乐观锁的幂等性实现

基于乐观锁的方案利用数据库中的版本号来控制并发修改，如果并发请求导致版本号不匹配，则拒绝后来的请求，确保数据的一致性。

@PutMapping("/api/update-user")
public ResponseEntity<User> updateUser(@RequestBody User user) {
    // 获取版本号并更新
    User existingUser = userRepository.findById(user.getId()).get();
    if (existingUser.getVersion() != user.getVersion()) {
        return ResponseEntity.status(HttpStatus.CONFLICT).build();
    }
    existingUser.setVersion(existingUser.getVersion() + 1);

    // 保存更新
    userRepository.save(existingUser);
    return ResponseEntity.status(HttpStatus.OK).body(existingUser);
}