用 SpringBoot+Redis 扛住了瞬间几千次的重复提交！

以你之姓@ 2022-09-14 00:24 107阅读 0赞

## **前言** ##

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

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

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

![00296605c5be96e423ba352fad2c0f0a.png][]

## **一、搭建redis的服务Api** ##

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

2:引入springboot中到的redis的stater，或者Spring封装的jedis也可以，后面主要用到的api就是它的set方法和exists方法,这里我们使用springboot的封装好的redisTemplate

/**
     * redis工具类
     */
    @Component
    public class RedisService {
    
    
        @Autowired
        private 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创建和检验**][Link 2] ##

**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 {
    
    
        @Autowired
        private RedisService redisService;
    
    
    
    
        /**
         * 创建token
         *
         * @return
         */
        @Override
        public 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
         */
        @Override
        public boolean checkToken(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中也不存在token
                    throw 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 {
    
    
        @Resource
       private AutoIdempotentInterceptor autoIdempotentInterceptor;
    
    
        /**
         * 添加拦截器
         * @param registry
         */
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(autoIdempotentInterceptor);
            super.addInterceptors(registry);
        }
    }

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

/**
     * 拦截器
     */
    @Component
    public class AutoIdempotentInterceptor implements HandlerInterceptor {
    
    
        @Autowired
        private TokenService tokenService;
    
    
        /**
         * 预处理
         *
         * @param request
         * @param response
         * @param handler
         * @return
         * @throws Exception
         */
        @Override
        public 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;
        }
    
    
    
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    
    
        }
    
    
        @Override
        public 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 {
    
    
    
    
        @Resource
        private TokenService tokenService;
    
    
        @Resource
        private 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：][get_token_token]

![9b53ef3a5a6e6cd562d3746372ee8c6b.png][]

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

![bdfb62d9426d5abcb0d96bd714e38b5c.png][]

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

![4db468b93df4ce8f5ca4e4064676f871.png][]

## **六、总结** ##

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

来源：jianshu.com/p/c806003a8530

[![2d58f744d16f5a4e74f55e861904e27f.png][]][2d58f744d16f5a4e74f55e861904e27f.png 1]

[图解：一致性协议算法][2d58f744d16f5a4e74f55e861904e27f.png 1]

[![9f7a9459cd2708dadc6d52f0e265ffe0.png][]][9f7a9459cd2708dadc6d52f0e265ffe0.png 1]

[大数据分析平台搭建指南][9f7a9459cd2708dadc6d52f0e265ffe0.png 1]

[![01d2a0e6c14611fdf5bfd2b2433c2cb1.png][]][01d2a0e6c14611fdf5bfd2b2433c2cb1.png 1]

[架构设计分享：项目用得到的多级缓存架构设计方案][01d2a0e6c14611fdf5bfd2b2433c2cb1.png 1]

[![1fa1b7a1823525b3d5b5a0b1b2b89e83.png][]][1fa1b7a1823525b3d5b5a0b1b2b89e83.png 1]

[案例分享，git项目持续集成实践][1fa1b7a1823525b3d5b5a0b1b2b89e83.png 1]

[![43fedf5eb60af76f5041d2a8329e9dff.png][]][43fedf5eb60af76f5041d2a8329e9dff.png 1]

[应用卡死的bug竟然是因为Redis使用不当？][43fedf5eb60af76f5041d2a8329e9dff.png 1]

[![1518960ad7ad6640bd1f334815eab2cd.png][]][1518960ad7ad6640bd1f334815eab2cd.png 1]

[Spring Boot 实现通用 Auth 认证的 4 种方式！][1518960ad7ad6640bd1f334815eab2cd.png 1]

[Link 1]: http://mp.weixin.qq.com/s?__biz=MzI2NTAzNzgxNw==&mid=2247521032&idx=2&sn=0bf9feeaf1869d56e54acc9de1bdd722&chksm=eaa1a19eddd6288884ec6158c1eba2e89c3c54331f5943cf083fd005c3279831f5b2007b064c&scene=21#wechat_redirect
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzI2NTAzNzgxNw==&mid=2247520993&idx=2&sn=4f62bdb0294affe2987621bf9c2e14c8&chksm=eaa1a077ddd6296106303659ac3076f558a6f55baef98b3b4bdcc9480066194b3af090f85219&scene=21#wechat_redirect
[00296605c5be96e423ba352fad2c0f0a.png]: /images/20220828/d3e6130e791a4757ab663d48c6147526.png
[get_token_token]: http://mp.weixin.qq.com/s?__biz=MzI2NTAzNzgxNw==&mid=2247520929&idx=1&sn=1d6b4e01cd9bc907fa4b9572b30876be&chksm=eaa1a037ddd62921450189f40278fa7cb5fd75e341427711b5266d294b4670c1d555c000c902&scene=21#wechat_redirect
[9b53ef3a5a6e6cd562d3746372ee8c6b.png]: /images/20220828/a8a2b641b1e348e791c0978c5f523414.png
[bdfb62d9426d5abcb0d96bd714e38b5c.png]: /images/20220828/5e2f8cb5f4bc4f7aa7e7c109d77d5e08.png
[4db468b93df4ce8f5ca4e4064676f871.png]: /images/20220828/b8f257e1daff457dbbdf2e8ca80c63ef.png
[2d58f744d16f5a4e74f55e861904e27f.png]: /images/20220828/056daaa0d524470fb97c7fd71f7b72e1.png
[2d58f744d16f5a4e74f55e861904e27f.png 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng==&mid=2247490590&idx=1&sn=6d4299793691dac6806f4b7b47103c21&chksm=fc44e927cb33603169afd6acbe3de6114f28f093e5e17d8929eccaefa63918d43bf609440dc8&scene=21#wechat_redirect
[9f7a9459cd2708dadc6d52f0e265ffe0.png]: /images/20220828/98b51f42d24140fcb6355c59d68f9cae.png
[9f7a9459cd2708dadc6d52f0e265ffe0.png 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng==&mid=2247490577&idx=2&sn=e1601fe3fdd87211a636a8a4e8768ef6&chksm=fc44e928cb33603e14493ebc0062be422549bcd6d1248bec51a6f1903181020a055e7ab1e0bf&scene=21#wechat_redirect
[01d2a0e6c14611fdf5bfd2b2433c2cb1.png]: /images/20220828/56ace8c0a9314926997f3c0c2e29dad8.png
[01d2a0e6c14611fdf5bfd2b2433c2cb1.png 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng==&mid=2247490572&idx=1&sn=ead656df4436a5c8097515d9a9616104&chksm=fc44e935cb3360234f507025b2ce29255d8af9d8ab77b91cefaa926e278de6a6f76316402f9c&scene=21#wechat_redirect
[1fa1b7a1823525b3d5b5a0b1b2b89e83.png]: /images/20220828/5e3f617d80fc48b48dd0c311d43ded71.png
[1fa1b7a1823525b3d5b5a0b1b2b89e83.png 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng==&mid=2247490572&idx=2&sn=1c349f24d18cadbbcd96ba444bcc05ac&chksm=fc44e935cb3360234170469cd900dc36b746b3e261d1ad47de1fb30cd4c55baf9b3b2eee86ff&scene=21#wechat_redirect
[43fedf5eb60af76f5041d2a8329e9dff.png]: /images/20220828/f06891f5e6654638961ae23688991939.png
[43fedf5eb60af76f5041d2a8329e9dff.png 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng==&mid=2247490571&idx=1&sn=4a4046abdf077d215c3a33dac80919d8&chksm=fc44e932cb3360248c261ab11082a1bf8f279785d8360d86801443fdf332dc214c513ce445fc&scene=21#wechat_redirect
[1518960ad7ad6640bd1f334815eab2cd.png]: /images/20220828/17da359a6af24b37805b46add42846d4.png
[1518960ad7ad6640bd1f334815eab2cd.png 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng==&mid=2247490570&idx=1&sn=796f7f09abd03579efdceaebb391b99c&chksm=fc44e933cb3360259723ed2d150684ce333fc10a8174774423b234c188f8ba1613c298771f0a&scene=21#wechat_redirect