SpringBoot+Redis防止恶意重复提交

在实际的开发项目中,一个对外暴露的接口往往会面临,瞬间大量的重复的请求提交,如果想过滤掉重复请求造成对业务的伤害,那就需要实现幂等

我们来解释一下幂等的概念:

任意多次执行所产生的影响均与一次执行的影响相同。按照这个含义,最终的含义就是 对数据库的影响只能是一次性的,不能重复处理。

如何保证其幂等性,通常有以下手段:

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

  1. /**
  2. * redis工具类
  3. */
  4. @Component
  5. publicclassRedisService{
  6.    @Autowired
  7.    privateRedisTemplate redisTemplate;
  8.    /**
  9.     * 写入缓存
  10.     * @param key
  11.     * @param value
  12.     * @return
  13.     */
  14.    publicbooleanset(finalString key, Object value) {
  15.        boolean result = false;
  16.        try{
  17.            ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
  18.            operations.set(key, value);
  19.            result = true;
  20.        } catch(Exception e) {
  21.            e.printStackTrace();
  22.        }
  23.        return result;
  24.    }
  25.    /**
  26.     * 写入缓存设置时效时间
  27.     * @param key
  28.     * @param value
  29.     * @return
  30.     */
  31.    publicboolean setEx(finalString key, Object value, Long expireTime) {
  32.        boolean result = false;
  33.        try{
  34.            ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
  35.            operations.set(key, value);
  36.            redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);
  37.            result = true;
  38.        } catch(Exception e) {
  39.            e.printStackTrace();
  40.        }
  41.        return result;
  42.    }
  43.    /**
  44.     * 判断缓存中是否有对应的value
  45.     * @param key
  46.     * @return
  47.     */
  48.    publicboolean exists(finalString key) {
  49.        return redisTemplate.hasKey(key);
  50.    }
  51.    /**
  52.     * 读取缓存
  53.     * @param key
  54.     * @return
  55.     */
  56.    publicObjectget(finalString key) {
  57.        Object result = null;
  58.        ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
  59.        result = operations.get(key);
  60.        return result;
  61.    }
  62.    /**
  63.     * 删除对应的value
  64.     * @param key
  65.     */
  66.    publicboolean remove(finalString key) {
  67.        if(exists(key)) {
  68.            Booleandelete= redisTemplate.delete(key);
  69.            returndelete;
  70.        }
  71.        returnfalse;
  72.    }
  73. }

二、自定义注解AutoIdempotent

自定义一个注解,定义此注解的主要目的是把它添加在需要实现幂等的方法上,凡是某个方法注解了它,都会实现自动幂等。后台利用反射如果扫描到这个注解,就会处理这个方法实现自动幂等,使用元注解ElementType.METHOD表示它只能放在方法上,etentionPolicy.RUNTIME表示它在运行时

  1. @Target({ElementType.METHOD})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public@interfaceAutoIdempotent{
  4. }

三、token创建和检验

1、token服务接口

我们新建一个接口,创建token服务,里面主要是两个方法,一个用来创建token,一个用来验证token。创建token主要产生的是一个字符串,检验token的话主要是传达request对象,为什么要传request对象呢?主要作用就是获取header里面的token,然后检验,通过抛出的Exception来获取具体的报错信息返回给前端。

  1. publicinterfaceTokenService{
  2.    /**
  3.     * 创建token
  4.     * @return
  5.     */
  6.    public  String createToken();
  7.    /**
  8.     * 检验token
  9.     * @param request
  10.     * @return
  11.     */
  12.    publicboolean checkToken(HttpServletRequest request) throwsException;
  13. }

四、拦截器的配置

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

  1. @Configuration
  2. publicclassWebConfigurationextendsWebMvcConfigurerAdapter{
  3.    @Resource
  4.   privateAutoIdempotentInterceptor autoIdempotentInterceptor;
  5.    /**
  6.     * 添加拦截器
  7.     * @param registry
  8.     */
  9.    @Override
  10.    publicvoid addInterceptors(InterceptorRegistry registry) {
  11.        registry.addInterceptor(autoIdempotentInterceptor);
  12.        super.addInterceptors(registry);
  13.    }
  14. }

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

  1. /**
  2. * 拦截器
  3. */
  4. @Component
  5. publicclassAutoIdempotentInterceptorimplementsHandlerInterceptor{
  6.    @Autowired
  7.    privateTokenService tokenService;
  8.    /**
  9.     * 预处理
  10.     *
  11.     * @param request
  12.     * @param response
  13.     * @param handler
  14.     * @return
  15.     * @throws Exception
  16.     */
  17.    @Override
  18.    publicboolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throwsException{
  19.        if(!(handler instanceofHandlerMethod)) {
  20.            returntrue;
  21.        }
  22.        HandlerMethod handlerMethod = (HandlerMethod) handler;
  23.        Method method = handlerMethod.getMethod();
  24.        //被ApiIdempotment标记的扫描
  25.        AutoIdempotent methodAnnotation = method.getAnnotation(AutoIdempotent.class);
  26.        if(methodAnnotation != null) {
  27.            try{
  28.                return tokenService.checkToken(request);// 幂等性校验, 校验通过则放行, 校验失败则抛出异常, 并通过统一异常处理返回友好提示
  29.            }catch(Exception ex){
  30.                ResultVo failedResult = ResultVo.getFailedResult(101, ex.getMessage());
  31.                writeReturnJson(response, JSONUtil.toJsonStr(failedResult));
  32.                throw ex;
  33.            }
  34.        }
  35.        //必须返回true,否则会被拦截一切请求
  36.        returntrue;
  37.    }
  38.    @Override
  39.    publicvoid postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throwsException{
  40.    }
  41.    @Override
  42.    publicvoid afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throwsException{
  43.    }
  44.    /**
  45.     * 返回的json值
  46.     * @param response
  47.     * @param json
  48.     * @throws Exception
  49.     */
  50.    privatevoid writeReturnJson(HttpServletResponse response, String json) throwsException{
  51.        PrintWriter writer = null;
  52.        response.setCharacterEncoding("UTF-8");
  53.        response.setContentType("text/html; charset=utf-8");
  54.        try{
  55.            writer = response.getWriter();
  56.            writer.print(json);
  57.        } catch(IOException e) {
  58.        } finally{
  59.            if(writer != null)
  60.                writer.close();
  61.        }
  62.    }
  63. }

五、测试用例

1、模拟业务请求类

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

  1. @RestController
  2. publicclassBusinessController{
  3.    @Resource
  4.    privateTokenService tokenService;
  5.    @Resource
  6.    privateTestService testService;
  7.    @PostMapping("/get/token")
  8.    publicString  getToken(){
  9.        String token = tokenService.createToken();
  10.        if(StrUtil.isNotEmpty(token)) {
  11.            ResultVo resultVo = newResultVo();
  12.            resultVo.setCode(Constant.code_success);
  13.            resultVo.setMessage(Constant.SUCCESS);
  14.            resultVo.setData(token);
  15.            returnJSONUtil.toJsonStr(resultVo);
  16.        }
  17.        returnStrUtil.EMPTY;
  18.    }
  19.    @AutoIdempotent
  20.    @PostMapping("/test/Idempotence")
  21.    publicString testIdempotence() {
  22.        String businessResult = testService.testIdempotence();
  23.        if(StrUtil.isNotEmpty(businessResult)) {
  24.            ResultVo successResult = ResultVo.getSuccessResult(businessResult);
  25.            returnJSONUtil.toJsonStr(successResult);
  26.        }
  27.        returnStrUtil.EMPTY;
  28.    }
  29. }

2、使用postman请求

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

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

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

六、总结

本篇博客介绍了使用springboot和拦截器、redis来优雅的实现接口幂等,对于幂等在实际的开发过程中是十分重要的,因为一个接口可能会被无数的客户端调用,如何保证其不影响后台的业务处理,如何保证其只影响数据一次是非常重要的,它可以防止产生脏数据或者乱数据,也可以减少并发量,

发表评论

电子邮件地址不会被公开。 必填项已用*标注