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

  1. 数据库建立唯一性索引,可以保证最终插入数据库的只有一条数据
  2. token机制,每次接口请求前先获取一个token,然后再下次请求的时候在请求的header体中加上这个token,后台进行验证,如果验证通过删除token,下次请求再次判断token
  3. 悲观锁或者乐观锁,悲观锁可以保证每次for update的时候其他sql无法update数据(在数据库引擎是innodb的时候,select的条件必须是唯一索引,防止锁全表)
  4. 先查询后判断,首先通过查询数据库是否存在数据,如果存在证明已经请求过了,直接拒绝该请求,如果没有存在,就证明是第一次进来,直接放行。

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(finalString 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(finalString 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(finalString key) {return redisTemplate.hasKey(key);}/*** 读取缓存* @param key* @return*/public Objectget(finalString key) {Object result = null;ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();result = operations.get(key);return result;}/*** 删除对应的value* @param key*/public boolean remove(finalString key) {if (exists(key)) {Boolean delete = redisTemplate.delete(key);return delete;}returnfalse;}}

自定义注解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来获取具体的报错信息返回给前端
publicinterface 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
publicclass 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();}returnnull;}/*** 检验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中也不存在tokenthrownew ServiceException(Constant.ResponseCode.ILLEGAL_ARGUMENT, 100);}}if (!redisService.exists(token)) {thrownew ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);}boolean remove = redisService.remove(token);if (!remove) {thrownew ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);}returntrue;}
}

拦截器的配置

  • web配置类,实现WebMvcConfigurerAdapter,主要作用就是添加autoIdempotentInterceptor到配置类中,这样我们到拦截器才能生效,注意使用@Configuration注解,这样在容器启动是时候就可以添加进入context中
@Configuration
publicclass 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
publicclass 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)) {returntrue;}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,否则会被拦截一切请求returntrue;}@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
publicclass 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:
  • 利用获取到到token,然后放到具体请求到header中,可以看到第一次请求成功,接着我们请求第二次:
  • 第二次请求,返回到是重复性操作,可见重复性验证通过,再多次请求到时候我们只让其第一次成功,第二次就是失败:

总结

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

springboot项目拦截器中获取接口返回数据_Spring Boot自定义Annotation实现接口自动幂...相关推荐

  1. java 拦截器响应中取所有参数,spring boot拦截器中获取request post请求中的参数

    最近有一个需要从拦截器中获取post请求的参数的需求,这里记录一下处理过程中出现的问题. 首先想到的就是request.getParameter(String )方法,但是这个方法只能在get请求中取 ...

  2. 拦截器获取请求参数post_spring boot拦截器中获取request post请求中的参数

    最近有一个需要从拦截器中获取post请求的参数的需求,这里记录一下处理过程中出现的问题. 首先想到的就是request.getParameter(String )方法,但是这个方法只能在get请求中取 ...

  3. strus2拦截器中获取客户端ip

    strus2获取客户端ip,ip需根据request对象获取 因需要在拦截器中不知道如何获取ip,故做以下记录: ActionContext ctx = ActionContext.getContex ...

  4. springboot配置拦截器,在拦截器中获取@RequestBody注解参数和post请求参数以及get请求参数

    1.配置拦截器 package com.jy.gxw.config.interceptor;import org.springframework.beans.factory.annotation.Au ...

  5. spring拦截器使用及拦截器中获取Controller实例

    1,首先是配置,在spring-mvc的配置文件中加上 <!-- 拦截器 --> <mvc:interceptors><bean class="cn.hydom ...

  6. session 拦截器中获取不到session值_拦截器实现登陆验证

    案例效果: 介绍↑:进入主页,分别看到"登录页面"和"首页". 介绍↑:点击进入"登录页面"后输入"用户名和密码"点击提 ...

  7. idea swagger生成接口文档_Spring Boot(九)Swagger2自动生成接口文档和Mock模拟数据...

    一.简介 在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...

  8. 在拦截器中获取请求参数,[Ljava.lang.String; cannot be cast to java.lang.String报错

    Map<String,Object> parametersmap=invocation.getInvocationContext().getParameters();//获取请求参数    ...

  9. spring boot拦截器中获取request post请求中的参数(转)

    文章转自 https://www.jianshu.com/p/69c6fba08c92 转载于:https://www.cnblogs.com/shuaiandjun/p/10306242.html

最新文章

  1. HttpURLConnection与HttpClient浅析---转
  2. 【Android 应用开发】Google 官方 EasyPermissions 权限申请库 ( 最简单用法 | 一行代码搞定权限申请 | 推荐用法 )
  3. 【Android 高性能音频】高性能音频简介 ( 高性能音频问题引入 | 使用场景 | 相关开发库及技术 )
  4. 判断线段相交 + vector. erase迭代指针 的使用 poj 2653 Pick-up sticks
  5. Linux+Nginx+Apache+Atlas+Mysql+Php+Redis 分部式部署详细版
  6. 2个字符串相等 swift_Swift快速入门(一)之 Swift基础语法
  7. Laravel 代码开发最佳实践(持续更新)
  8. Visibiltity:none与Display:none区别
  9. 软件版本的GA、RC的具体含义
  10. c语言windows停止工作,win7系统一打开便签就提示停止工作的解决方法
  11. rainmeter 新人使用记录
  12. 让数据分析更easy的选择—贪心科技AI商业数据分析课程深度测评
  13. Java游戏神秘岛,【寻找高玩】服务端整合问题
  14. 如何群发邮件?群发邮件让发收件人互相不知道?邮箱群发邮件技巧
  15. 时尚pr标题模板,简约故障风格pr文字模板
  16. rv1126 数据流
  17. Linux——DNS篇
  18. shiro认证时出现报错Submitted credentials for token [org.apache.shiro.authc.UsernamePasswordToken -
  19. 使用javac编译单个Java文件
  20. 英伟达收购Arm计划落空,跨国半导体并购难再现?|硅基世界

热门文章

  1. java 自定义日期_java 8 自定义日期获取
  2. css实现圆角三角形
  3. 繁体字非主流伤感日志_親愛的,為什麼
  4. 微信小程序开源代码汇总分享【转载】
  5. android+tv+开发+icon,Android TV+HTML5的架构设计和应用开发经验.pdf
  6. 平板电脑更新鸿蒙系统,平板电脑已预装鸿蒙系统
  7. php通用过滤,通用的PHP防注入漏洞攻击的过滤函数代码
  8. 什么是ZooKeeper?可以做什么?ZooKeeper分布式事务详解篇
  9. 2021上岸北邮计算机学院专硕初复试经验
  10. C# 系统应用之EM安全卫士总结及源码分享