springboot+redis+Interceptor+自定义annotation实现接口自动幂等-

沙海

3180
文章

2
评论

2021年3月21日10:48:14杂谈 Java评论119字数 7794阅读25分58秒阅读模式

摘要

速读摘要

速读摘要文章源自JAVA秀-https://www.javaxiu.com/5889.html

按照这个含义，最终的含义就是对数据库的影响只能是一次性的，不能重复处理。自定义一个注解，定义此注解的主要目的是把它添加在需要实现幂等的方法上，凡是某个方法注解了它，都会实现自动幂等。这个异常信息可以被拦截器捕捉到，然后返回给前端。来优雅的实现接口幂等，对于幂等在实际的开发过程中是十分重要的，因为一个接口可能会被无数的客户端调用，如何保证其不影响后台的业务处理，如何保证其只影响数据一次是非常重要的，它可以防止产生脏数据或者乱数据，也可以减少并发量，实乃十分有益的一件事。文章源自JAVA秀-https://www.javaxiu.com/5889.html

原文约 3200 字 | 图片 7 张 | 建议阅读 7 分钟 | 评价反馈文章源自JAVA秀-https://www.javaxiu.com/5889.html

springboot+redis+Interceptor+自定义annotation实现接口自动幂等

程序员闪充宝文章源自JAVA秀-https://www.javaxiu.com/5889.html

springboot+redis+Interceptor+自定义annotation实现接口自动幂等文章源自JAVA秀-https://www.javaxiu.com/5889.html

作者：Yrion文章源自JAVA秀-https://www.javaxiu.com/5889.html
www.cnblogs.com/wyq178/p/11130034.html文章源自JAVA秀-https://www.javaxiu.com/5889.html

通过本文，你应该学会：文章源自JAVA秀-https://www.javaxiu.com/5889.html

自定义注解，拦截注解文章源自JAVA秀-https://www.javaxiu.com/5889.html
幂等设计的原理，以及流程文章源自JAVA秀-https://www.javaxiu.com/5889.html
如何实现自动验证token文章源自JAVA秀-https://www.javaxiu.com/5889.html

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

1: 数据库建立唯一性索引，可以保证最终插入数据库的只有一条数据文章源自JAVA秀-https://www.javaxiu.com/5889.html

2: token 机制，每次接口请求前先获取一个 token，然后再下次请求的时候在请求的 header 体中加上这个 token，后台进行验证，如果验证通过删除 token，下次请求再次判断 token文章源自JAVA秀-https://www.javaxiu.com/5889.html

3: 悲观锁或者乐观锁，悲观锁可以保证每次 for update 的时候其他 sql 无法 update 数据 (在数据库引擎是 innodb 的时候, select 的条件必须是唯一索引, 防止锁全表)文章源自JAVA秀-https://www.javaxiu.com/5889.html

4: 先查询后判断，首先通过查询数据库是否存在数据，如果存在证明已经请求过了，直接拒绝该请求，如果没有存在，就证明是第一次进来，直接放行。文章源自JAVA秀-https://www.javaxiu.com/5889.html

redis 实现自动幂等的原理图：文章源自JAVA秀-https://www.javaxiu.com/5889.html

springboot+redis+Interceptor+自定义annotation实现接口自动幂等文章源自JAVA秀-https://www.javaxiu.com/5889.html

一：搭建 redis 的服务 Api

1: 首先是搭建 redis 服务器。详情可参考：https://www.cnblogs.com/wyq178/p/10340234.html文章源自JAVA秀-https://www.javaxiu.com/5889.html

2: 引入 springboot 中到的 redis 的 stater，或者 Spring 封装的 jedis 也可以，后面主要用到的 api 就是它的 set 方法和 exists 方法, 这里我们使用 springboot 的封装好的 redisTemplate文章源自JAVA秀-https://www.javaxiu.com/5889.html

/** * redis工具类 */@ComponentpublicclassRedisService {@Autowiredprivate RedisTemplate redisTemplate;/** * 写入缓存 * @param key * @param value * @return */publicbooleanset(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 */publicbooleansetEx(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 */publicbooleanexists(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 */publicbooleanremove(final String key) {if (exists(key)) { Boolean delete = redisTemplate.delete(key);return delete; }returnfalse; }}

二：自定义注解 AutoIdempotent

自定义一个注解，定义此注解的主要目的是把它添加在需要实现幂等的方法上，凡是某个方法注解了它，都会实现自动幂等。后台利用反射如果扫描到这个注解，就会处理这个方法实现自动幂等，使用元注解 ElementType.METHOD 表示它只能放在方法上，etentionPolicy.RUNTIME 表示它在运行时文章源自JAVA秀-https://www.javaxiu.com/5889.html

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

三：token 创建和检验

1:token 服务接口

我们新建一个接口，创建 token 服务，里面主要是两个方法，一个用来创建 token，一个用来验证 token。创建 token 主要产生的是一个字符串，检验 token 的话主要是传达 request 对象，为什么要传 request 对象呢？主要作用就是获取 header 里面的 token, 然后检验，通过抛出的 Exception 来获取具体的报错信息返回给前端文章源自JAVA秀-https://www.javaxiu.com/5889.html

publicinterfaceTokenService {/** * 创建token * @return */public String createToken();/** * 检验token * @param request * @return */publicbooleancheckToken(HttpServletRequest request)throws Exception;}

2:token 的服务实现类

token 引用了 redis 服务，创建 token 采用随机算法工具类生成随机 uuid 字符串, 然后放入到 redis 中 (为了防止数据的冗余保留, 这里设置过期时间为 10000 秒, 具体可视业务而定)，如果放入成功，最后返回这个 token 值。checkToken 方法就是从 header 中获取 token 到值 (如果 header 中拿不到，就从 paramter 中获取)，如若不存在, 直接抛出异常。这个异常信息可以被拦截器捕捉到，然后返回给前端。文章源自JAVA秀-https://www.javaxiu.com/5889.html

搜索公众号：MarkerHub，关注回复[vue]获取前后端入门教程！文章源自JAVA秀-https://www.javaxiu.com/5889.html

@ServicepublicclassTokenServiceImplimplementsTokenService {@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 */@OverridepublicbooleancheckToken(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中也不存在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; }}

四：拦截器的配置

1:web 配置类，实现 WebMvcConfigurerAdapter，主要作用就是添加 autoIdempotentInterceptor 到配置类中，这样我们到拦截器才能生效，注意使用 @Configuration 注解，这样在容器启动是时候就可以添加进入 context 中文章源自JAVA秀-https://www.javaxiu.com/5889.html

@ConfigurationpublicclassWebConfigurationextendsWebMvcConfigurerAdapter {@Resourceprivate AutoIdempotentInterceptor autoIdempotentInterceptor;/** * 添加拦截器 * @param registry */@OverridepublicvoidaddInterceptors(InterceptorRegistry registry) { registry.addInterceptor(autoIdempotentInterceptor);super.addInterceptors(registry); }}

2: 拦截处理器：主要的功能是拦截扫描到 AutoIdempotent 到注解到方法, 然后调用 tokenService 的 checkToken() 方法校验 token 是否正确，如果捕捉到异常就将异常信息渲染成 json 返回给前端文章源自JAVA秀-https://www.javaxiu.com/5889.html

/** * 拦截器 */@ComponentpublicclassAutoIdempotentInterceptorimplementsHandlerInterceptor {@Autowiredprivate TokenService tokenService;/** * 预处理 * * @param request * @param response * @param handler * @return * @throws Exception */@OverridepublicbooleanpreHandle(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; }@OverridepublicvoidpostHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)throws Exception { }@OverridepublicvoidafterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)throws Exception { }/** * 返回的json值 * @param response * @param json * @throws Exception */privatevoidwriteReturnJson(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() 方法，如果捕获到异常会将异常抛出调用者，下面我们来模拟请求一下：文章源自JAVA秀-https://www.javaxiu.com/5889.html

@RestControllerpublicclassBusinessController {@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：文章源自JAVA秀-https://www.javaxiu.com/5889.html

springboot+redis+Interceptor+自定义annotation实现接口自动幂等文章源自JAVA秀-https://www.javaxiu.com/5889.html

利用获取到到 token, 然后放到具体请求到 header 中, 可以看到第一次请求成功，接着我们请求第二次：文章源自JAVA秀-https://www.javaxiu.com/5889.html

springboot+redis+Interceptor+自定义annotation实现接口自动幂等文章源自JAVA秀-https://www.javaxiu.com/5889.html

第二次请求，返回到是重复性操作，可见重复性验证通过，再多次请求到时候我们只让其第一次成功，第二次就是失败：文章源自JAVA秀-https://www.javaxiu.com/5889.html

springboot+redis+Interceptor+自定义annotation实现接口自动幂等文章源自JAVA秀-https://www.javaxiu.com/5889.html

六：总结

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

springboot+redis+Interceptor+自定义annotation实现接口自动幂等文章源自JAVA秀-https://www.javaxiu.com/5889.html