一种非侵入式幂等性的Java实现

阳光穿透心脏的1/2处 2023-09-23 20:01 131阅读 0赞

今天我们来谈谈什么是`幂等性`？

引用`百度百科`的解析如下：

> 幂等（idempotent、idempotence）是一个数学与计算机学概念，常见于抽象代数中。
> 
> 在编程中一个幂等操作的特点是其任意多次执行所产生的影响均与一次执行的影响相同。幂等函数，或幂等方法，是指可以使用相同参数`重复执行`，并能获得`相同结果`的函数。这些函数不会影响系统状态，也不用担心重复执行会对系统造成改变。例如，“setTrue()”函数就是一个幂等函数,无论多次执行，其结果都是一样的.更复杂的操作幂等保证是利用唯一交易号(流水号)实现。

这解析，确实有点`长`了，大家话看看就行了！！！(●'◡'●)

那对于我们`程序员`来说，我们关心的更多是下面这些问题：

> 什么地方，什么场景下需要用到幂等？
> 
> 幂等，我们需要怎么做，如何实现幂等呢？

![7d4053f461f83d6c8295835194ebdcd7.jpeg][]

image.png

什么场景下需要用到幂等

*  前端表单重复提交问题
 *  用户订单支付问题
 *  银行业务办理取号问题
 *  用户恶意进行调接口问题
 *  接口超时重复提交问题
 *  MQ消息进行重复消费
 *  ...

当然了，还有很多场景会用到`幂等`，这里咱们就不一一列举出来了。

那我们要如何设计一个幂等功能呢，而且还是`代码非侵入式`？

`代码非侵入式`的意思，就是，我们的业务逻辑代码，不需要处理`幂等`校验的逻辑。

业务功能不处理？那交给谁处理呢？别着急，听哥们一一道来。^\_^

![9e8ddbcb4b8d6c86596d9eeb3310c28d.jpeg][]

image.png

这里，要实现`代码非侵入式`的幂等校验，我们就要使用到`切面`编程了（`@Aspect`）

幂等的实现原理

在系统中一些`接口`需要增加`幂等`处理，`幂等`的概念是一个业务请求只能执行一次。类似银行业务办理，首先需要取一个号，然后用户使用这个号去柜台办理业务。这个号只能使用一次，如果过期或者已办理这个号就无效了。

我们的`幂等`也是使用这种原理。

>  *  1.首先客户端调用通过我们的系统获取一个号，我们称之为`幂等号`，这个号已经存在我们的系统中。
>  *  2.客户端使用这个号，调用我们的接口。
>  *  3.我们系统判断这个号在我们的系统中已经存在，如果存在则允许业务办理，如果不存在，则表示这是一个非法的号，我们直接抛出异常。
>  *  4.当业务处理完成，我们会将这个号从我们的系统中删除掉。

好了，这`实现步骤`，也是十分清晰了呀！！！^\_^

那么我们下面就来看代码如何实现了

幂等的代码实现

*  定义一个幂等处理接口

public interface Idempotence {
        /**
         * 检查是否存在幂等号
         * @param idempotenceId 幂等号
         * @return 是否存在
         */
        boolean check(String idempotenceId);
    
        /**
         * 记录幂等号
         * @param idempotenceId 幂等号
         */
        void record(String idempotenceId);
    
        /**
         * 记录幂等号
         * @param idempotenceId 幂等号
         * @param time 过期时间
         */
        void record(String idempotenceId, Integer time);
    
        /**
         * 删除幂等号
         * @param idempotenceId 幂等号
         */
        void delete(String idempotenceId);
    
    }
    复制代码

*  定义一个幂等处理接口实现类

@Component
    public class RedisIdempotence implements Idempotence {
        @Autowired
        private RedisRepository redisRepository;
    
        @Override
        public boolean check(String idempotenceId) {
            return redisRepository.exists(idempotenceId);
        }
    
        @Override
        public void record(String idempotenceId) {
            redisRepository.set(idempotenceId,"1");
        }
    
        @Override
        public void record(String idempotenceId,Integer time) {
            redisRepository.setExpire(idempotenceId,"1",time);
        }
    
        @Override
        public void delete(String idempotenceId) {
            redisRepository.del(idempotenceId);
        }
    }
    复制代码

> 这个实现类，咱们就用`redis`存储这个`幂等号` 实现4个方法：
> 
> 检查是否存在幂等号
> 
> 记录幂等号
> 
> 记录幂等号（带过期时间）
> 
> 删除幂等号

*  幂等工具类

@Component
    public class IdempotenceUtil {
        @Autowired
        private RedisRepository redisRepository;
        /**
         * 生成幂等号
         * @return
         */
        public String generateId() {
            String uuid = UUID.randomUUID().toString();
            String uId=Base64Util.encode(uuid).toLowerCase();
            redisRepository.setExpire(uId,"1",1800);
            return uId;
        }
    
        /**
         * 从Header里面获取幂等号
         * @return
         */
        public String getHeaderIdempotenceId(){
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            String idempotenceId=request.getHeader("idempotenceId");
            return idempotenceId;
        }
    }
    复制代码

> 这个工具类，提供两个方法。
> 
> 1.生成一个幂等号，咱们就用uuid
> 
> 2.从Header里面获取幂等号

*  定义一个注解

/**
     * 接口增加幂等性
     */
    @Target({ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface IdempotenceRequired {
    
    }
    复制代码

*  切面

@Aspect
    @Slf4j
    @Component
    public class IdempotenceSupportAdvice {
        @Autowired
        private Idempotence idempotence;
        @Autowired
        IdempotenceUtil idempotenceUtil;
    
        /**
         * 拦截有@IdempotenceRequired 注解 的方法。
         */
        @Pointcut("@annotation(xxx.xxx.IdempotenceRequired)")
        public void idempotenceMethod(){}
    
        @AfterThrowing(value = "idempotenceMethod()()",throwing = "e")
        public void afterThrowing(Throwable e){
            if(!(e instanceof IdempotencyException)) {
                // 从HTTP header中获取幂等号idempotenceId
                String idempotenceId = idempotenceUtil.getHeaderIdempotenceId();
                idempotence.record(idempotenceId, 1800);
            }
        }
    
        @Around(value = "idempotenceMethod()")
        public Object around(ProceedingJoinPoint  joinPoint) throws Throwable {
            // 从HTTP header中获取幂等号idempotenceId
            String idempotenceId = idempotenceUtil.getHeaderIdempotenceId();
            if(StringUtils.isEmpty(idempotenceId)){
                //不存在幂等号则不进行额外操作
                return joinPoint.proceed();
            }
            // 前置操作 幂等号是否存在
            boolean existed = idempotence.check(idempotenceId);
            if (!existed) {
                throw new IdempotencyException("{success:false,message:"操作重复，请重新输入幂等号重试！",data:-2}");
            }
            //删除幂等号
            idempotence.delete(idempotenceId);
            Object result = joinPoint.proceed();
    
            return result;
        }
    }
    复制代码

*  定义个controller

@RequestMapping("/idempotence")
    public class IdempotenceController {
        /**
         * 生成幂等号
         * @return
         */
        @GetMapping("/generateId")
        public JsonResult generateId(){
            IdempotenceUtil idempotenceUtil=SpringUtil.getBean(IdempotenceUtil.class);
            String uId=idempotenceUtil.generateId();
            return JsonResult.success("成功生成！").setData(uId);
        }
    }
    复制代码

好了，实现的代码，就是这些了，`理解`起来也是比较`简单`，没有过多复杂的逻辑。

接下来，就是如何`使用的问题`了，

![45ad7980860102b38bd6ef73b90fb36b.jpeg][]

image.png

这个使用，也是十分的简单啦！！！

幂等的使用

**服务端：**

不是所有的方法都需要切面拦截 ，只有 `IdempotenceRequired` 注解的方法才会被拦截。

例如下面接口：

@IdempotenceRequired
        @PostMapping("/getUsers")
        public JsonResult getUsers(){
      
            //执行正常业务逻辑
            ...
        }
    复制代码

在开发`幂等`接口时，只需要在方法上简单增加一个 `IdempotenceRequired` 注解即可。

这基本上就是`代码非侵入式`了呀！！！

![5bd31a4d28b7e84ce5667ec1175a6af4.jpeg][]

image.png

**客户端：**

服务端处理好后，在客户端访问接口的时候需要执行以下步骤：

>  *  需要先获取`幂等号`
>  *  然后将`幂等号`添加到请求头中

*  1.获取`幂等号` http://服务地址/idempotence/generateId

![75d1ca75d8dab56042d262e22f2e9121.jpeg][]

null

*  2.请求调用

> 往header中添加幂等号

![3ff599e94f9055723296eda781b98479.jpeg][]

image.png

好了，到这里幂等的实现，就已经完成了！！！^\_^

那我们就可以愉快的编写代码了！！！^\_^

![dd5ae7e9adf9214d936f10ae06e09dd9.jpeg][]

[7d4053f461f83d6c8295835194ebdcd7.jpeg]: https://img-blog.csdnimg.cn/img_convert/7d4053f461f83d6c8295835194ebdcd7.jpeg
[9e8ddbcb4b8d6c86596d9eeb3310c28d.jpeg]: https://img-blog.csdnimg.cn/img_convert/9e8ddbcb4b8d6c86596d9eeb3310c28d.jpeg
[45ad7980860102b38bd6ef73b90fb36b.jpeg]: https://img-blog.csdnimg.cn/img_convert/45ad7980860102b38bd6ef73b90fb36b.jpeg
[5bd31a4d28b7e84ce5667ec1175a6af4.jpeg]: https://img-blog.csdnimg.cn/img_convert/5bd31a4d28b7e84ce5667ec1175a6af4.jpeg
[75d1ca75d8dab56042d262e22f2e9121.jpeg]: https://img-blog.csdnimg.cn/img_convert/75d1ca75d8dab56042d262e22f2e9121.jpeg
[3ff599e94f9055723296eda781b98479.jpeg]: https://img-blog.csdnimg.cn/img_convert/3ff599e94f9055723296eda781b98479.jpeg
[dd5ae7e9adf9214d936f10ae06e09dd9.jpeg]: https://img-blog.csdnimg.cn/img_convert/dd5ae7e9adf9214d936f10ae06e09dd9.jpeg