点击上方“方志朋”,选择“设为星标”

回复”666“获取新整理的面试文章


前言

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

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

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

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

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

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

一:搭建redis的服务Api

1:首先是搭建redis服务器。

2:引入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创建和检验

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 {@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;}
}

四:拦截器的配置

1: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);}
}

2:拦截处理器:主要的功能是拦截扫描到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();}}}

五:测试用例

1:模拟业务请求类

首先我们需要通过/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;}
}

2:使用postman请求

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

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

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

六:总结

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

作者:慕容千语

链接:www.jianshu.com/p/c806003a8530

热门内容:SpringBoot+JWT+Shiro+MybatisPlus实现Restful快速开发后端脚手架原创 | Nginx 架构原理科普百度 71 个炸天的开源项目!你知道几个?
原来这才是 Kafka!(多图+深入)如何设计一个牛逼的本地缓存最近面试BAT,整理一份面试资料《Java面试BAT通关手册》,覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。
获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。
明天见(。・ω・

http://www.taodudu.cc/news/show-122665.html

相关文章:

  • 我的天,你工作5年了,连Java agent都不知道...
  • 你这代码写得真丑,满屏的try-catch,全局异常处理不会吗?
  • 总结:被MySQL UTF8编码坑的惨痛教训...
  • 一位群友作为后端开发在滴滴和头条分别干了 2 年的经验总结
  • 带你100% 地了解 Redis 6.0 的客户端缓存
  • 深入理解Spring的ImportSelector接口
  • Java 代码精简之道
  • 5分钟实现SpringBoot整合Dubbo构建分布式服务
  • 干掉 FastJson
  • Java集合框架综述,这篇让你吃透!
  • Mybatis基础知识点:trim标签的使用
  • 微服务架构下静态数据通用缓存机制
  • 总结:一些关于 CPU 的基本知识
  • Spring Boot 2.3.0 发布:支持Java14、打包Docker镜像、优雅关机配置...
  • Java如何优雅的实现时间控制
  • 干掉Navicat:这个IDEA的兄弟真香!
  • 配置中心Apollo的设计原理
  • Thread.sleep(0) 有什么用?
  • 干掉 ZooKeeper,阿里为什么不用 ZK 做服务发现?
  • 面试官:你知道 Docker 有哪些优缺点嘛?
  • JAVA 线上故障排查完整套路!牛掰!
  • Elasticsearch 在各大互联网公司大量真实的应用案例!
  • Redis + Tomcat + Nginx 集群实现 Session 共享
  • 没错,老板让我写个 BUG!
  • fork/join 全面剖析,你可以不用,但是不能不懂!
  • SpringBoot 2.3 新特性之优雅停机,这波操作太秀了!
  • 干掉cms,zgc才是未来
  • 看完这篇还不懂Redis的RDB持久化,你们来打我!
  • 盘点开发中那些常用的MySQL优化
  • Apollo 你了解下这些内容就完美了

Spring Boot+Redis+拦截器+自定义Annotation实现接口自动幂等相关推荐

  1. 如何防止token被拦截_Spring Boot+Redis+拦截器+自定义Annotation实现接口自动幂等

    今天主要给大家介绍使用springboot和拦截器.redis来优雅的实现接口幂等.正文开始: 在实际的开发项目中,一个对外暴露的接口往往会面临很多次请求,我们来解释一下幂等的概念:任意多次执行所产生 ...

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

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

  3. Spring Boot笔记-拦截器相关(用户权限方面)

    Spring Boot拦截器的使用 使用注解@Configuration 继承WebMvcConfigurerAdapter 重写addInterceptors添加需要拦截器地址: 运行截图如下: 后 ...

  4. spring boot mybatis拦截器

    mybaits拦截器 package com.chinamobile.scm.masterdata.interceptor;import com.alibaba.fastjson.JSON; impo ...

  5. Spring Boot 添加拦截器的配置方式

    在进行 Java Web 开发的时候我们经常会使用到过滤器,例如日志的记录.权限的验证等功能.以前使用 Spring MVC 的时候需要在 web.xml 中配置过滤器,现在使用 Spring Boo ...

  6. 接口responsecode返回500_springboot+redis+Interceptor+annotation实现接口自动幂(989)

    前言: 在实际的开发项目中,一个对外暴露的接口往往会面临很多次请求,我们来解释一下幂等的概念:任意多次执行所产生的影响均与一次执行的影响相同.按照这个含义,最终的含义就是 对数据库的影响只能是一次性的 ...

  7. spring boot + redis 实现网站限流和接口防刷功能

    源码url: https://github.com/zhzhair/accesslimit-spring-boot.git 注解@AccessLimit 实现接口防刷功能,在方法上的注解参数优先于类上 ...

  8. 【229期】Spring Boot 使用令牌桶算法+拦截器+自定义注解+自定义异常实现简单的限流...

    点击上方"Java精选",选择"设为星标" 别问别人为什么,多问自己凭什么! 下方有惊喜,留言必回,有问必答! 每天 08:15 更新文章,每天进步一点点... ...

  9. spring boot集成swagger,自定义注解,拦截器,xss过滤,异步调用,定时任务案例...

    本文介绍spring boot集成swagger,自定义注解,拦截器,xss过滤,异步调用,定时任务案例 集成swagger--对于做前后端分离的项目,后端只需要提供接口访问,swagger提供了接口 ...

最新文章

  1. 【数据库】适用于SQLite的SQL语句(一)
  2. Python解密2021年最新富豪榜,马云居然连前三都没进
  3. 2015年的ResNet潜力都挖掘出来了吗?新研究:不用蒸馏、无额外数据,性能还能涨一波...
  4. leetcode算法题--二进制求和
  5. web访问 FastDFS 方法思路
  6. 分享周鸿祎的《如何建立一个“铁打的营盘”》
  7. 腾讯TDSQL提出三个“数据库之问”,数据库技术未来重点在哪?
  8. 强推!十大顶级大数据可视化工具 | 程序员硬核评测
  9. 安装软件包的三种方法 ,rpm包介绍 , rpm工具用法, yum工具用法, yum搭建本地仓库...
  10. VB在菜单上增加图标
  11. 测试用例设计技术之一等价类法
  12. 软件架构分类(转载)
  13. 磁盘不见了只剩一个c盘_教你如何处理只剩一个C盘
  14. 构建区块链量化交易系统(一)
  15. 厉害了!阿里的这套“实人认证”系统通过率高达99%
  16. 铁道部新客票系统设计
  17. python 绘制频数与正太分布图
  18. 圆角半角数据库_数据库使用技巧――SQL 全角与半角切换_MySQL
  19. 西瓜微数独家工具! 超全微博粉丝分析!!!
  20. mpstat命令(linux cpu监控工具)

热门文章

  1. [No0000160]常用C# 正则表达式大全
  2. Java的Clone
  3. SQLMap安装步骤
  4. shell脚本俄罗斯方块游戏
  5. datasnap的客户端回传机制
  6. strong assign属性
  7. C++ 常用函数方法
  8. 【C#串口编程计划】C#串口协议解析 -- 文本数据
  9. 网易有道词典笔 —— 73 岁“人类高质量”奶奶梅耶马斯克的中文学习之选
  10. 10 个 Python 工程师,9 个不合格!