Spring Boot中使用自定义Annotation来实现接口自动幂等
点击上方蓝色“程序猿DD”,选择“设为星标”
回复“资源”获取独家整理的学习资料!
来源 | jianshu.com/p/c806003a8530
前言
在实际的开发项目中,一个对外暴露的接口往往会面临很多次请求,我们来解释一下幂等的概念:任意多次执行所产生的影响均与一次执行的影响相同。按照这个含义,最终的含义就是 对数据库的影响只能是一次性的,不能重复处理。如何保证其幂等性,通常有以下手段:
数据库建立唯一性索引,可以保证最终插入数据库的只有一条数据
token机制,每次接口请求前先获取一个token,然后再下次请求的时候在请求的header体中加上这个token,后台进行验证,如果验证通过删除token,下次请求再次判断token
悲观锁或者乐观锁,悲观锁可以保证每次for update的时候其他sql无法update数据(在数据库引擎是innodb的时候,select的条件必须是唯一索引,防止锁全表)
先查询后判断,首先通过查询数据库是否存在数据,如果存在证明已经请求过了,直接拒绝该请求,如果没有存在,就证明是第一次进来,直接放行。
redis实现自动幂等的原理图:
搭建redis的服务Api
首先是搭建redis服务器。
引入springboot中到的redis的stater,或者Spring封装的jedis也可以,后面主要用到的api就是它的set方法和exists方法,这里我们使用springboot的封装好的redisTemplate
/*** redis工具类*/
@Component
public class RedisService {@Autowiredprivate RedisTemplate redisTemplate;/*** 写入缓存* @param key* @param value* @return*/public boolean set(final String key, Object value) {boolean result = false;try {ValueOperations<Serializable, Object> 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<Serializable, Object> 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<Serializable, Object> 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创建和检验
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;}
token的服务实现类:token引用了redis服务,创建token采用随机算法工具类生成随机uuid字符串,然后放入到redis中(为了防止数据的冗余保留,这里设置过期时间为10000秒,具体可视业务而定),如果放入成功,最后返回这个token值。checkToken方法就是从header中获取token到值(如果header中拿不到,就从paramter中获取),如若不存在,直接抛出异常。这个异常信息可以被拦截器捕捉到,然后返回给前端。
@Service
public class TokenServiceImpl implements TokenService {@Autowiredprivate RedisService redisService;/*** 创建token** @return*/@Overridepublic 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*/@Overridepublic boolean checkToken(HttpServletRequest request) throws Exception {String token = request.getHeader(Constant.TOKEN_NAME);if (StrUtil.isBlank(token)) {// header中不存在tokentoken = request.getParameter(Constant.TOKEN_NAME);if (StrUtil.isBlank(token)) {// parameter中也不存在tokenthrow 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;}
}
拦截器的配置
web配置类,实现WebMvcConfigurerAdapter,主要作用就是添加autoIdempotentInterceptor到配置类中,这样我们到拦截器才能生效,注意使用@Configuration注解,这样在容器启动是时候就可以添加进入context中
@Configuration
public class WebConfiguration extends WebMvcConfigurerAdapter {@Resourceprivate AutoIdempotentInterceptor autoIdempotentInterceptor;/*** 添加拦截器* @param registry*/@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(autoIdempotentInterceptor);super.addInterceptors(registry);}
}
拦截处理器:主要的功能是拦截扫描到AutoIdempotent到注解到方法,然后调用tokenService的checkToken()方法校验token是否正确,如果捕捉到异常就将异常信息渲染成json返回给前端
/*** 拦截器*/
@Component
public class AutoIdempotentInterceptor implements HandlerInterceptor {@Autowiredprivate TokenService tokenService;/*** 预处理** @param request* @param response* @param handler* @return* @throws Exception*/@Overridepublic 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;}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {}@Overridepublic 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();}}}
测试用例
模拟业务请求类,首先我们需要通过/get/token路径通过getToken()方法去获取具体的token,然后我们调用testIdempotence方法,这个方法上面注解了@AutoIdempotent,拦截器会拦截所有的请求,当判断到处理的方法上面有该注解的时候,就会调用TokenService中的checkToken()方法,如果捕获到异常会将异常抛出调用者,下面我们来模拟请求一下:
@RestController
public class BusinessController {@Resourceprivate TokenService tokenService;@Resourceprivate 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;}
}
使用postman请求,首先访问get/token路径获取到具体到token:
![](/assets/blank.gif)
利用获取到到token,然后放到具体请求到header中,可以看到第一次请求成功,接着我们请求第二次:
![](/assets/blank.gif)
第二次请求,返回到是重复性操作,可见重复性验证通过,再多次请求到时候我们只让其第一次成功,第二次就是失败:
![](/assets/blank.gif)
总结
本篇博客介绍了使用springboot和拦截器、redis来优雅的实现接口幂等,对于幂等在实际的开发过程中是十分重要的,因为一个接口可能会被无数的客户端调用,如何保证其不影响后台的业务处理,如何保证其只影响数据一次是非常重要的,它可以防止产生脏数据或者乱数据,也可以减少并发量,实乃十分有益的一件事。而传统的做法是每次判断数据,这种做法不够智能化和自动化,比较麻烦。而今天的这种自动化处理也可以提升程序的伸缩性。
往期推荐
Star 10.9K!这份Google面试攻略,牛逼了!
如何设计一个安全的对外接口?
Java 14 :NullPointerException的处理新方式
深度学习手势识别带你玩转神庙逃亡
推荐 5 款好用的开源 Docker 工具
最后再给大家安利一场直播分享
本周三晚19:00,博文视点直播间聚集云风、陈皓、唐巧、孙玄、程军5位国内神级程序员大咖,现场论道,妙解趣谈。
进行关于传奇程序员修炼之道主题的分享。
l 领军人物亲述从小工到专家
l 程序员务实最高境界之我见
l 宗师相对论与现场答疑解惑
强烈推荐一波!建议大家一定不要错过!
扫一扫,关注我
一起学习,一起进步
Spring Boot中使用自定义Annotation来实现接口自动幂等相关推荐
- boot spring 接口接收数据_在 Spring Boot 中使用 Dataway 配置数据查询接口
Dataway介绍 Dataway 是基于 DataQL 服务聚合能力,为应用提供的一个接口配置工具.使得使用者无需开发任何代码就配置一个满足需求的接口. 整个接口配置.测试.冒烟.发布.一站式都通过 ...
- springboot怎么返回404_Spring Boot2 系列教程(十三)Spring Boot 中的全局异常处理
在 Spring Boot 项目中 ,异常统一处理,可以使用 Spring 中 @ControllerAdvice 来统一处理,也可以自己来定义异常处理方案.Spring Boot 中,对异常的处理有 ...
- Spring Boot中的application.properties配置简介(二)
Spring Boot中的application.properties配置简介(二) 根据上文的介绍,我们已经对Spring Boot中的application.properties配置有了一定的 ...
- Spring Boot中使用MongoDB,使用 Repository以及使用MongoTemplate
文章目录 Spring Boot中使用MongoDB MongoDB Repository使用实例 导入依赖 配置MongoDB 定义Model 定义Repository 进行使用 MongoTemp ...
- Spring Boot中使用Swagger3.0.0版本构建RESTful APIs
文章目录 一.项目描述 二.简介 三.Swagger2.X和Swagger3.0.0 的对比 1)SpringFox 2.x 发布 2)SpringFox 3.0.0 发布 3)swagger3.0 ...
- Spring boot中使用Spring Security的记住我 remember-me功能
Spring boot中使用Spring Security的记住我 remember-me功能 问题描述:Spring security新手,在登录时加上记住我功能,需要使用框架自带的记住我. 记住的 ...
- Spring Boot中使用Spring-Retry重试框架
文章目录 Spring Boot中使用Spring-Retry重试框架 Maven依赖 注解使用 开启Retry功能 注解`@Retryable` 注解`@Recover` 注解`@CircuitBr ...
- 再谈Spring Boot中的乱码和编码问题
编码算不上一个大问题,即使你什么都不管,也有很大的可能你不会遇到任何问题,因为大部分框架都有默认的编码配置,有很多是UTF-8,那么遇到中文乱码的机会很低,所以很多人也忽视了. Spring系列产品大 ...
- 徒手解密 Spring Boot 中的 Starter自动化配置黑魔法
我们使用 Spring Boot,基本上都是沉醉在它 Stater 的方便之中.Starter 为我们带来了众多的自动化配置,有了这些自动化配置,我们可以不费吹灰之力就能搭建一个生产级开发环境,有的小 ...
最新文章
- 搭建PHP环境遇到的问题!!
- 一个伪黑客的成功的秘密1:tomcat入侵
- linux 产生三位数的随机数
- python 面试题 2020_2020年最全python面试题
- elasticsearch rest api操作
- Spring Data JPA教程:简介
- NOIP模拟测试5「星际旅行·砍树·超级树」
- Linux Kernel TCP/IP Stack|Linux网络硬核系列 | 图
- vue怎么注释html代码,vue如何注释
- python类加载_如何重新加载一个类在python shell?
- 《OpenGL编程指南》一3.2 OpenGL缓存数据
- linux grep egrep fgrep bash条件判断 bash测试 if 条件判断
- 关键词推荐工具中的用户引导机制之三
- Atitit 《摩奴法典》overivew 读后感 不是由国王 颁布的,而是 僧侣编制
- 经典小程序源码及其下载地址
- 《普林斯顿微积分》读书笔记
- 32位win10服务器系统,32位win10原版
- 绿盟科技网络安全攻防实验室安全研究员廖新喜:Java JSON 反序列化之殇
- java公路车组装教程_自行车DIY入门教程,图文展示自行车组装全过程。(原创图文,转载请注明出处)...
- 一文带你复习计网中的重点知识(一万五千字长文)