接口幂等性是什么？为什么需要做接口幂等性？如何实现接口幂等性校验？

时间: 2023-04-09 11:01:36 浏览: 166

Spring Boot + Redis + 注解 + 拦截器来实现接口幂等性校验.docx

Spring Boot + Redis + 注解 + 拦截器来实现接口幂等性校验一、概念幂等性在软件开发中，幂等性是指一次请求和多次请求带来的结果是一致的，换言之，就是一个接口，多次发起同一个请求，必须保证操作只能执行一次。例如订单接口，不能多次创建订单；支付接口，重复支付同一笔订单只能扣一次钱；支付宝回调接口，可能会多次回调，必须处理重复回调等。二、常见解决方案常见的解决方案有： 1. 唯一索引 -- 防止新增脏数据 2. token机制 -- 防止页面重复提交 3. 悲观锁 -- 获取数据的时候加锁（锁表或锁行） 4. 乐观锁 -- 基于版本号version实现，在更新数据那一刻校验数据 5. 分布式锁 -- redis（jedis、redisson）或zookeeper实现三、本文实现本文采用第二种方式，即通过redis + token机制实现接口幂等性校验。四、实现思路需要保证幂等性的每一次请求创建一个唯一标识token，先获取token，并将此token存入redis；请求接口时，将此token放到header或者作为请求参数；请求接口，后端接口判断redis中是否存在此token：如果存在，正常处理业务逻辑，并从redis中删除此token，那么，如果是重复请求，由于token已被删除，则不能通过校验，返回请勿重复操作提示；如果不存在，说明参数不合法或者是重复请求，返回提示即可。五、项目简介本项目使用springboot和redis实现幂等性校验，使用lombok简化日志logging，使用@ApiIdempotent注解和拦截器对请求进行拦截，使用@ControllerAdvice实现全局异常处理，使用jmeter进行压测。六、代码实现 pom.xml中添加jedis依赖： ```xml <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId> <version>2.9.0</version> </dependency> ``` JedisUtil.java： ```java @Component @Slf4j public class JedisUtil { @Autowired private JedisPool jedisPool; private Jedis getJedis() { return jedisPool.getResource(); } / * 设值 * @param key * @param value * @return */ public String set(String key, String value) { Jedis jedis = null; try { jedis = getJedis(); return jedis.set(key, value); } catch (Exception e) { log.error("set key:{} value:{} error", key, value, e); return null; } finally { close(jedis); } } / * 设值 * @param key * @param value * @param expireTime 过期时间, 单位: s * @return */ public String set(String key, String value, int expireTime) { Jedis jedis = null; try { jedis = getJedis(); return jedis.setex(key, expireTime, value); } catch (Exception e) { log.error("set key:{} value:{} expireTime:{} error", key, value, expireTime, e); return null; } finally { close(jedis); } } / * 取值 * @param key * @return */ public String get(String key) { Jedis jedis = null; try { jedis = getJedis(); return jedis.get(key); } catch (Exception e) { log.error("get key:{} error", key, e); return null; } finally { close(jedis); } } } ``` @ApiIdempotent注解： ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface ApiIdempotent { String value(); } ``` 拦截器实现： ```java @Component public class IdempotentInterceptor implements HandlerInterceptor { @Autowired private JedisUtil jedisUtil; @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String token = request.getHeader("X-Token"); if (token != null) { if (jedisUtil.get(token) != null) { // token already exists, return error response.setStatus(HttpServletResponse.SC_CONFLICT); return false; } else { jedisUtil.set(token, "1", 300); // 300s expire } } return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { // do nothing } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // do nothing } } ``` 注意：本文仅介绍幂等性核心实现，关于springboot如何集成redis、ServerResponse、ResponseCode等细枝末节不在本文讨论范围之内，有兴趣的小伙伴可以查看我的Github项目。

接口幂等性是指无论调用多少次，结果都是一样的。在接口调用中，由于网络等原因，可能会导致接口被重复调用，如果接口不具备幂等性，就会导致数据的重复插入、更新等问题。因此，需要做接口幂等性来保证接口的正确性和数据的一致性。实现接口幂等性校验可以通过在接口中添加唯一标识符，如UUID或者请求时间戳等，来判断是否重复调用。同时，还可以通过在接口中添加状态码等方式来判断接口是否已经被调用过。

阅读全文

接口幂等性 是什么？为什么需要做接口幂等性 ？如何实现接口幂等性校验？

相关推荐

02、接口幂等性1

Spring Boot + Redis + 注解与拦截器实现接口幂等性校验

接口幂等性的解决方案.docx

高并发下的接口幂等性解决方案.docx

Aop注解+Redis解决SpringBoot接口幂等性(源码自取)

Spring Boot与Redis实现接口幂等性：注解+拦截器

掌握接口幂等性保障策略：从主键到防重Token

AspectJ实现接口幂等性保障：AOP在幂等性问题的解决方案

接口幂等性设计全攻略：实现业务接口一次操作的5种方法

Java中间件接口幂等性设计指南：保障分布式系统数据一致性的关键

TCC分布式事务中的幂等性设计与实现

java 接口实现幂等性

基于AOP如何实现接口幂等性

java中怎么实现接口的幂等性

redis+token实现接口的幂等性代码

分布式系统的接口幂等性设计包括

接口的幂等性如何解决

如何采用”一锁二判三更新”方式设计接口幂等，解决支付订单重复支付的问题

java源码资源手机游戏J2ME毕业设计

最新推荐

软件工程试卷软件工程试卷

java源码资源手机游戏J2ME毕业设计

第5章 存储器管理（笔记整理）

gradle611all.zip.png

onnxruntime-1.16.0-cp39-cp39-win_amd64.whl

基于Python和Opencv的车牌识别系统实现

管理建模和仿真的文件

网络隔离与防火墙策略：防御网络威胁的终极指南

在密码学中，对称加密和非对称加密有哪些关键区别，它们各自适用于哪些场景？

我的代码小部件库：统计、MySQL操作与树结构功能

接口幂等性是什么？为什么需要做接口幂等性？如何实现接口幂等性校验？

第5章存储器管理（笔记整理）