SpringBoot自定义Annotation实现通用的接口自动幂等性

青旅半醒 2022-10-12 05:27 178阅读 0赞

![942394d57b32eeaa304f83a69bd96a35.png][]

前言: 在实际的开发项目中,一个对外暴露的接口往往会面临很多次请求，我们来解释一下幂等的概念：任意多次执行所产生的影响均与一次执行的影响相同。按照这个含义，最终的含义就是 对数据库的影响只能是一次性的，不能重复处理。如何保证其幂等性，通常有以下手段：

1，数据库建立唯一性索引，可以保证最终插入数据库的只有一条数据

2，token机制，每次接口请求前先获取一个token，然后再下次请求的时候在请求的header体中加上这个token，后台进行验证，如果验证通过删除token，下次请求再次判断token

3，悲观锁或者乐观锁，悲观锁可以保证每次for update的时候其他sql无法update数据(在数据库引擎是innodb的时候,select的条件必须是唯一索引,防止锁全表)

4，先查询后判断，首先通过查询数据库是否存在数据，如果存在证明已经请求过了，直接拒绝该请求，如果没有存在，就证明是第一次进来，直接放行。

redis实现自动幂等的原理图：

![222cec0055ffeb111acf580e447ba49a.png][]

## 一、搭建redis的服务Api ##

1，首先是搭建redis服务器，就不赘述了。详情可参考：

> 搭建springboot的maven项目  
> 
> 
> 引入redis的starter依赖：
> 
>     
> 
>         org.springframework.bootgroupId>
> 
>         spring-boot-starter-data-redisartifactId>  
> 
> 
>       
> 
> 
> 引入web依赖：
> 
>  
> 
>         org.springframework.bootgroupId>
> 
>         spring-boot-starter-webartifactId>  
> 
> 
>     
> 
> 配置redis：
> 
>     url

2，引入springboot中到的redis的stater，或者Spring封装的jedis也可以，后面主要用到的api就是它的set方法和exists方法,这里我们使用springboot的封装好的redisTemplate

`/**  * redis工具类  */ @Component public class RedisService {     @Autowired     private RedisTemplate redisTemplate;     /**      * 写入缓存      * @param key      * @param value      * @return      */     public boolean set(final String key, Object value) {         boolean result = false;         try {             ValueOperations operations = redisTemplate.opsForValue();             operations.set(key, value);             result = true;         } catch (Exception e) {             e.printStackTrace();         }         return result;     }     /**      * 写入缓存设置时效时间      * @param key      * @param value      * @return      */     public boolean setEx(final String key, Object value, Long expireTime) {         boolean result = false;         try {             ValueOperations operations = redisTemplate.opsForValue();             operations.set(key, value);             redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);             result = true;         } catch (Exception e) {             e.printStackTrace();         }         return result;     }     /**      * 判断缓存中是否有对应的value      * @param key      * @return      */     public boolean exists(final String key) {         return redisTemplate.hasKey(key);     }     /**      * 读取缓存      * @param key      * @return      */     public Object get(final String key) {         Object result = null;         ValueOperations operations = redisTemplate.opsForValue();         result = operations.get(key);         return result;     }     /**      * 删除对应的value      * @param key      */     public boolean remove(final String key) {         if (exists(key)) {             Boolean delete = redisTemplate.delete(key);             return delete;         }         return false;     } }`

## 二、自定义注解AutoIdempotent ##

自定义一个注解，定义此注解的主要目的是把它添加在需要实现幂等的方法上，凡是某个方法注解了它，都会实现自动幂等。

后台利用反射如果扫描到这个注解，就会处理这个方法实现自动幂等，使用元注解ElementType.METHOD表示它只能放在方法上，etentionPolicy.RUNTIME表示它在运行时

`@Target({ ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) public @interface AutoIdempotent { }`

## 三、token创建和检验 ##

### 1，token服务接口 ###

我们新建一个接口，创建token服务，里面主要是两个方法，一个用来创建token，一个用来验证token。创建token主要产生的是一个字符串，检验token的话主要是传达request对象，为什么要传request对象呢？

主要作用就是获取header里面的token,然后检验，通过抛出的Exception来获取具体的报错信息返回给前端

`public interface TokenService {     /**      * 创建token      * @return      */     public  String createToken();     /**      * 检验token      * @param request      * @return      */     public boolean checkToken(HttpServletRequest request) throws Exception; }`

### 2，token的服务实现类 ###

token引用了redis服务，创建token采用随机算法工具类生成随机uuid字符串,然后放入到redis中(为了防止数据的冗余保留,这里设置过期时间为10000秒,具体可视业务而定)，如果放入成功，最后返回这个token值。

checkToken方法就是从header中获取token到值(如果header中拿不到，就从paramter中获取)，如若不存在,直接抛出异常。这个异常信息可以被拦截器捕捉到，然后返回给前端。

`@Service public class TokenServiceImpl implements TokenService {     @Autowired     private RedisService redisService;     /**      * 创建token      *      * @return      */     @Override     public String createToken() {         String str = RandomUtil.randomUUID();         StrBuilder token = new StrBuilder();         try {             token.append(Constant.Redis.TOKEN_PREFIX).append(str);             redisService.setEx(token.toString(), token.toString(),10000L);             boolean notEmpty = StrUtil.isNotEmpty(token.toString());             if (notEmpty) {                 return token.toString();             }         }catch (Exception ex){             ex.printStackTrace();         }         return null;     }     /**      * 检验token      *      * @param request      * @return      */     @Override     public boolean checkToken(HttpServletRequest request) throws Exception {         String token = request.getHeader(Constant.TOKEN_NAME);         if (StrUtil.isBlank(token)) { // header中不存在token             token = request.getParameter(Constant.TOKEN_NAME);             if (StrUtil.isBlank(token)) { // parameter中也不存在token                 throw new ServiceException(Constant.ResponseCode.ILLEGAL_ARGUMENT, 100);             }         }         if (!redisService.exists(token)) {             throw new ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);         }         boolean remove = redisService.remove(token);         if (!remove) {             throw new ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);         }         return true;     } }`

## 四、拦截器的配置 ##

1，web配置类，实现WebMvcConfigurerAdapter，主要作用就是添加autoIdempotentInterceptor到配置类中，这样我们到拦截器才能生效，注意使用@Configuration注解，这样在容器启动是时候就可以添加进入context中

`@Configuration public class WebConfiguration extends WebMvcConfigurerAdapter {     @Resource    private AutoIdempotentInterceptor autoIdempotentInterceptor;     /**      * 添加拦截器      * @param registry      */     @Override     public void addInterceptors(InterceptorRegistry registry) {         registry.addInterceptor(autoIdempotentInterceptor);         super.addInterceptors(registry);     } }`

2，拦截处理器：主要的功能是拦截扫描到AutoIdempotent到注解到方法,然后调用tokenService的checkToken()方法校验token是否正确，如果捕捉到异常就将异常信息渲染成json返回给前端

`/**  * 拦截器  */ @Component public class AutoIdempotentInterceptor implements HandlerInterceptor {     @Autowired     private TokenService tokenService;     /**      * 预处理      *      * @param request      * @param response      * @param handler      * @return      * @throws Exception      */     @Override     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {         if (!(handler instanceof HandlerMethod)) {             return true;         }         HandlerMethod handlerMethod = (HandlerMethod) handler;         Method method = handlerMethod.getMethod();         //被ApiIdempotment标记的扫描         AutoIdempotent methodAnnotation = method.getAnnotation(AutoIdempotent.class);         if (methodAnnotation != null) {             try {                 return tokenService.checkToken(request);// 幂等性校验, 校验通过则放行, 校验失败则抛出异常, 并通过统一异常处理返回友好提示             }catch (Exception ex){                 ResultVo failedResult = ResultVo.getFailedResult(101, ex.getMessage());                 writeReturnJson(response, JSONUtil.toJsonStr(failedResult));                 throw ex;             }         }         //必须返回true,否则会被拦截一切请求         return true;     }     @Override     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {     }     @Override     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {     }     /**      * 返回的json值      * @param response      * @param json      * @throws Exception      */     private void writeReturnJson(HttpServletResponse response, String json) throws Exception{         PrintWriter writer = null;         response.setCharacterEncoding("UTF-8");         response.setContentType("text/html; charset=utf-8");         try {             writer = response.getWriter();             writer.print(json);         } catch (IOException e) {         } finally {             if (writer != null)                 writer.close();         }     } }`

## 五、测试用例 ##

### 1，模拟业务请求类 ###

首先我们需要通过/get/token路径通过getToken()方法去获取具体的token，然后我们调用testIdempotence方法，这个方法上面注解了@AutoIdempotent，拦截器会拦截所有的请求，当判断到处理的方法上面有该注解的时候，就会调用TokenService中的checkToken()方法，如果捕获到异常会将异常抛出调用者，下面我们来模拟请求一下：

`@RestController public class BusinessController {     @Resource     private TokenService tokenService;     @Resource     private TestService testService;     @PostMapping("/get/token")     public String  getToken(){         String token = tokenService.createToken();         if (StrUtil.isNotEmpty(token)) {             ResultVo resultVo = new ResultVo();             resultVo.setCode(Constant.code_success);             resultVo.setMessage(Constant.SUCCESS);             resultVo.setData(token);             return JSONUtil.toJsonStr(resultVo);         }         return StrUtil.EMPTY;     }     @AutoIdempotent     @PostMapping("/test/Idempotence")     public String testIdempotence() {         String businessResult = testService.testIdempotence();         if (StrUtil.isNotEmpty(businessResult)) {             ResultVo successResult = ResultVo.getSuccessResult(businessResult);             return JSONUtil.toJsonStr(successResult);         }         return StrUtil.EMPTY;     } }`

### 2，使用postman请求 ###

首先访问get/token路径获取到具体到token：

![4bcf80e39266ba2cb3722250ca4e1a10.png][]

利用获取到到token,然后放到具体请求到header中,可以看到第一次请求成功，接着我们请求第二次：

![577d3932e875433aaac44afc8b7344ed.png][]

第二次请求，返回到是重复性操作，可见重复性验证通过，再多次请求到时候我们只让其第一次成功，第二次就是失败：

![a781ca2f4366a26834eec6d570ca7972.png][]

## 六、总结 ##

本篇博客介绍了使用springboot和拦截器、redis来优雅的实现接口幂等，对于幂等在实际的开发过程中是十分重要的，因为一个接口可能会被无数的客户端调用，如何保证其不影响后台的业务处理，如何保证其只影响数据一次是非常重要的，它可以防止产生脏数据或者乱数据，也可以减少并发量，实乃十分有益的一件事。而传统的做法是每次判断数据，这种做法不够智能化和自动化，比较麻烦。而今天的这种自动化处理也可以提升程序的伸缩性。

往期推荐

[SpringBoot通过自定义注解实现Token校验][SpringBoot_Token]

[（附源码）Spring Boot 框架整合 OAuth2 实现单点登录 SSO 详细完整源码教程！][Spring Boot _ OAuth2 _ SSO]

[SpringBoot+webSocket实现扫码登录功能][SpringBoot_webSocket]

[如何利用JVM在线调试工具排查线上问题][JVM]

[\[合集\]JVM内存溢出问题的定位方法][JVM 1]

[4种方式让你定义的Method在Spring Boot 启动时自动执行][4_Method_Spring Boot]

[脚本达人总结的Linux Shell脚本编写经验，看完不踩坑][Linux Shell]

[这份Redis6.0集群搭建教程，项目肯定用得上][Redis6.0]

[设计微服务架构，相关设计模式如何运用？][Link 1]

[4种SpringBoot 接口幂等性的实现方案！最后一个80%以上的开发会踩坑][4_SpringBoot _80]

[掌握Git命令的本质，开发时才会得心应手][Git]

[Shell 脚本进阶，经典用法及其案例][Shell]

[942394d57b32eeaa304f83a69bd96a35.png]: /images/20221005/01e2d5090ab34094a5306f1990b4ec46.png
[222cec0055ffeb111acf580e447ba49a.png]: /images/20221005/0bf7842ea6ff444ba760bc97318d9113.png
[4bcf80e39266ba2cb3722250ca4e1a10.png]: /images/20221005/3ba766183a884779a4f0f734fd58ebbf.png
[577d3932e875433aaac44afc8b7344ed.png]: /images/20221005/40c52675c836497b835c003da92883a0.png
[a781ca2f4366a26834eec6d570ca7972.png]: /images/20221005/49c2c232ee6547e2aaaa3114b19fbbbd.png
[SpringBoot_Token]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ed94cb3364826184eacf339aff49de356aa1282e9269045eb6e57d204b656a2740c511cd&idx=1&mid=2247489709&scene=21&sn=b143768f1d7672fe8ce2f5d791c4eb55#wechat_redirect
[Spring Boot _ OAuth2 _ SSO]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ed9bcb33648d5db6e6b67b033b925ae1fa984862d5597165b6f2d1aec42cd43407643fbd&idx=1&mid=2247489698&scene=21&sn=6327e66c203469a62b72206eb2702eb5#wechat_redirect
[SpringBoot_webSocket]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44eda8cb3364bebc3e9d969e5b5c74b1cb9ef43c362b82c6470dabacfa92d6e9a694f73268&idx=1&mid=2247489681&scene=21&sn=2a7c8d1f97eb11ec25f569d24163b10f#wechat_redirect
[JVM]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44edbccb3364aae93355b0445703ead739611134f0f5449edf03c22d21a3a67e6762733e76&idx=1&mid=2247489669&scene=21&sn=4e213d3e10a8edad02f07a7b618b1005#wechat_redirect
[JVM 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ed52cb33644452780f971a408393907f84c04567f36ea1512cc6d43436632d81e6eeebf4&idx=1&mid=2247489643&scene=21&sn=5cdd93ec3e700b6ed042afb3c63a3dbe#wechat_redirect
[4_Method_Spring Boot]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ed6fcb33647997f382be1a734b1214ed9721c16ea40f6756fb18f849aa1796a55bd48b46&idx=1&mid=2247489622&scene=21&sn=a9b326de2c458993a3359359c4480424#wechat_redirect
[Linux Shell]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ed72cb3364644fdcfd443d0c341ca83a54a142e5b04f3b1fd9a3da7e340ebca975ab84cd&idx=1&mid=2247489611&scene=21&sn=3467f030f469011b8da3233d51f952a8#wechat_redirect
[Redis6.0]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44e286cb336b9019559254e2e2c6742603f94acbace76e3709b693258c64d4286d8e47beb5&idx=1&mid=2247489471&scene=21&sn=6107931e6e39331b2a1fd7b2951b865b#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44e288cb336b9eca3ccbaa6ce20ef0a2baae306b3d83953d7d292bda2a1a46052a556fe1ba&idx=1&mid=2247489457&scene=21&sn=28d2cca81052ce5c4618e73469343f42#wechat_redirect
[4_SpringBoot _80]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44e2adcb336bbb0e3ae396e56ad2b85c3eca812ea6ca96b0e615b029e7b61e960dccfb4f18&idx=1&mid=2247489428&scene=21&sn=2dcd64b6ef51b4082509805940f899ac#wechat_redirect
[Git]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44e2bccb336baa68dbfc520df82f75b8edab064a25413360e92e17ab17bb90642004d2a469&idx=1&mid=2247489413&scene=21&sn=bf22fdb5fbdbfbeeaea2c8a8ba0bcb14#wechat_redirect
[Shell]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44e262cb336b7473252b2fcd998e60bd457e98bd348e325493acd82a69e3de8133d1685d0f&idx=1&mid=2247489371&scene=21&sn=f5d677e7370d286c1c0f89d95689d334#wechat_redirect