【SpringBoot】基于自定义注解实现接口幂等性方法

近期需要对接口进行幂等性的改造,特此记录下。

一、背景

在微服务架构中,幂等是一致性方面的一个重要概念。

一个幂等操作的特点是指其多次执行所产生的影响均与一次执行的影响相同。在业务中也就是指的,多次调用方法或者接口不会改变业务状态,可以保证重复调用的结果和单次调用的结果一致。

二、常见场景

1.用户重复操作

在产品订购下单过程中,由于网络延迟或者用户误操作等原因,导致多次提交。这时就会在后台执行多条重复请求,导致脏数据或执行错误等。

2.分布式消息重复消费

消息队列中由于某种原因消息二次发送或者被二次消费的时候,导致程序多次执行,从而导致数据重复,资源冲突等。

3.接口超时重试

由于网络波动,引起的重复请求,导致数据的重复等。

三、常见解决方案

1.token机制实现

由客户端发送请求获取Token,服务端生成全局唯一的ID作为token,并保存在redis中,同时返回ID给客户端。

客户端调用业务端的请求的时候需要携带token,由服务端进行校验,校验成功,则允许执行业务,不成功则表示重复操作,直接返回给客户端。

2.mysql去重

建立一个去重表,当客户端请求的时候,将请求信息存入去重表进行判断。由于去重表带有唯一索引,如果插入成功则表示可以执行。如果失败则表示已经执行过当前请求,直接返回。

3.基于redis锁机制

在redis中,SETNX表示 SET IF NOT EXIST的缩写,表示只有不存在的时候才可以进行设置,可以利用它实现锁的效果。

客户端请求服务端时,通过计算拿到代表这次业务请求的唯一字段,将该值存入redis,如果设置成功表示可以执行。失败则表示已经执行过当前请求,直接返回。

四、实现方法

基于种种考虑,本文将基于方法3实现幂等性方法。其中有两个需要注意的地方:

1.如何实现唯一请求编号进行去重?

本文将采用用户ID:接口名:请求参数进行请求参数的MD5摘要,同时考虑到请求时间参数的干扰性(同一个请求,除了请求参数都相同可以认为为同一次请求),排除请求时间参数进行摘要,可以在短时间内保证唯一的请求编号。

2.如何保证最小的代码侵入性?

本文将采用自定义注解,同时采用切面AOP的方式,最大化的减少代码的侵入,同时保证了方法的易用性。

<
  • 0
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
Java自定义注解可以用于实现接口的幂等操作。所谓接口的幂等,就是同一个请求多次执行也不会产生重复的副作用。 要实现接口的幂等,可以通过以下步骤: 1. 定义一个自定义注解,例如@Idempotent,用于标识接口方法幂等性。 ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface Idempotent { } ``` 2. 在接口方法上使用@Idempotent注解,表示该接口方法是幂等的。 ```java public interface MyService { @Idempotent void myMethod(); } ``` 3. 在实现类中,通过AOP的方式实现接口方法的幂等逻辑。可以使用AspectJ或Spring AOP等框架来实现。 ```java @Component @Aspect public class IdempotentAspect { @Autowired private IdempotentService idempotentService; @Around("@annotation(com.example.Idempotent)") public void checkIdempotent(ProceedingJoinPoint joinPoint) throws Throwable { // 获取方法参数,生成幂等key String idempotentKey = generateIdempotentKey(joinPoint.getArgs()); // 判断该key是否已经执行过,如果执行过则直接返回 if (idempotentService.isExecuted(idempotentKey)) { return; } // 执行方法体 joinPoint.proceed(); // 标记该key已经执行过 idempotentService.markExecuted(idempotentKey); } // 生成幂等key的逻辑 private String generateIdempotentKey(Object[] args) { // 根据接口方法的参数生成唯一标识,例如将参数拼接成字符串 return StringUtils.join(args); } } ``` 通过以上步骤,我们就可以实现接口方法幂等性。在执行接口方法之前,会先判断该方法是否已经执行过,如果已执行过,则直接返回,避免重复执行产生副作用。同时,通过自定义注解@Idempotent的标识,可以简化幂等逻辑的实现和管理。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值