一招搞定重复提交漏洞，Spring Boot里的@idempotent注解

2023-08-11 22:35:32

幂等性：确保 API 操作的可靠性和一致性

在现代分布式系统中，幂等性已成为一种必不可少的概念，它保证了操作无论执行多少次，都能产生相同的结果。本文将深入探讨 @idempotent 注解在 Spring Boot 中实现幂等性的作用，包括其用法、原理和示例。

什么是幂等性？

幂等性是指一个操作，无论重复执行多少次，其结果始终保持不变。这种属性对于 API 接口和分布式事务至关重要，可以防止重复请求导致意外的数据修改或不一致性。

@idempotent 注解的用法

Spring Boot 提供了 @idempotent 注解，可应用于控制器方法或方法参数，以实现幂等性。当应用于控制器方法时，它表明该方法无论被调用多少次，其结果都相同。当应用于方法参数时，它表示该参数的值可以更改，而不会影响方法的最终结果。

@idempotent 注解的原理

@idempotent 注解基于 ETag（实体标记）机制。ETag 是服务器生成的唯一标识符，用于标识资源的当前状态。当客户端向服务器发送请求时，服务器会返回 ETag 值。客户端将 ETag 值包含在 subsequent 请求中。服务器收到请求后，将比较 ETag 值与资源的当前状态。如果 ETag 值匹配，则表示请求是重复的，服务器会返回 304 Not Modified 状态码。如果不匹配，则服务器会处理该请求。

代码示例

以下代码示例展示了如何使用 @idempotent 注解：

@RestController
public class UserController {

    @PostMapping("/users")
    @Idempotent
    public User createUser(@RequestBody User user) {
        // 创建用户逻辑
        return userService.createUser(user);
    }

    @PutMapping("/users/{id}")
    @Idempotent
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        // 更新用户逻辑
        return userService.updateUser(id, user);
    }

    @DeleteMapping("/users/{id}")
    @Idempotent
    public void deleteUser(@PathVariable Long id) {
        // 删除用户逻辑
        userService.deleteUser(id);
    }
}