Spring Boot + Redis 实现接口幂等性，写得太好了！

淡淡的烟草味﹌ 2022-09-04 01:48 83阅读 0赞

![0D5F937FE12312312D81F17F.jpg][]

程序员的成长之路

互联网/程序员/技术/资料共享

[关注][Link 1]

阅读本文大概需要 7 分钟。

来自：ljianshu.com/p/6189275403ed

#  #

[一、概念][Link 2]

幂等性, 通俗的说就是一个接口, 多次发起同一个请求, 必须保证操作只能执行一次 比如:

*  订单接口, 不能多次创建订单
 *  支付接口, 重复支付同一笔订单只能扣一次钱
 *  支付宝回调接口, 可能会多次回调, 必须处理重复回调
 *  普通表单提交接口, 因为网络超时等原因多次点击提交, 只能成功一次 等等

# [二、常见解决方案][Link 2] #

1.  唯一索引 -- 防止新增脏数据
2.  token机制 -- 防止页面重复提交
3.  悲观锁 -- 获取数据的时候加锁(锁表或锁行)
4.  乐观锁 -- 基于版本号version实现, 在更新数据那一刻校验数据
5.  分布式锁 -- redis(jedis、redisson)或zookeeper实现
6.  状态机 -- 状态变更, 更新数据时判断状态

# [三、本文实现][Link 2] #

本文采用第2种方式实现, 即通过redis + token机制实现接口幂等性校验

# [四、实现思路][Link 2] #

为需要保证幂等性的每一次请求创建一个唯一标识`token`, 先获取`token`, 并将此`token`存入redis, 请求接口时, 将此`token`放到header或者作为请求参数请求接口, 后端接口判断redis中是否存在此`token`:

*  如果存在, 正常处理业务逻辑, 并从redis中删除此`token`, 那么, 如果是重复请求, 由于`token`已被删除, 则不能通过校验, 返回`请勿重复操作`提示
 *  如果不存在, 说明参数不合法或者是重复请求, 返回提示即可

# [五、项目简介][Link 2] #

*  springboot
 *  redis
 *  `@ApiIdempotent`注解 + 拦截器对请求进行拦截
 *  @ControllerAdvice全局异常处理
 *  压测工具: jmeter

说明:

*  本文重点介绍幂等性核心实现, 关于springboot如何集成redis 、ServerResponse 、ResponseCode 等细枝末节不在本文讨论范围之内, 有兴趣的小伙伴可以查看我的Github项目: https://github.com/wangzaiplus/springboot/tree/wxw

# [六、代码实现][Link 2] #

1、pom

<dependency>
                <groupId>redis.clients</groupId>
                <artifactId>jedis</artifactId>
                <version>2.9.0</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.16.10</version>
            </dependency>

2、`JedisUtil`

package com.wangzaiplus.test.util;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    import redis.clients.jedis.Jedis;
    import redis.clients.jedis.JedisPool;
    
    @Component
    @Slf4j
    public class JedisUtil {
    
        @Autowired
        private JedisPool jedisPool;
    
        private Jedis getJedis() {
            return jedisPool.getResource();
        }
    
        /**
         * 设值
         *
         * @param key
         * @param value
         * @return
         */
        public String set(String key, String value) {
            Jedis jedis = null;
            try {
                jedis = getJedis();
                return jedis.set(key, value);
            } catch (Exception e) {
                log.error("set key:{} value:{} error", key, value, e);
                return null;
            } finally {
                close(jedis);
            }
        }
    
        /**
         * 设值
         *
         * @param key
         * @param value
         * @param expireTime 过期时间, 单位: s
         * @return
         */
        public String set(String key, String value, int expireTime) {
            Jedis jedis = null;
            try {
                jedis = getJedis();
                return jedis.setex(key, expireTime, value);
            } catch (Exception e) {
                log.error("set key:{} value:{} expireTime:{} error", key, value, expireTime, e);
                return null;
            } finally {
                close(jedis);
            }
        }
    
        /**
         * 取值
         *
         * @param key
         * @return
         */
        public String get(String key) {
            Jedis jedis = null;
            try {
                jedis = getJedis();
                return jedis.get(key);
            } catch (Exception e) {
                log.error("get key:{} error", key, e);
                return null;
            } finally {
                close(jedis);
            }
        }
    
        /**
         * 删除key
         *
         * @param key
         * @return
         */
        public Long del(String key) {
            Jedis jedis = null;
            try {
                jedis = getJedis();
                return jedis.del(key.getBytes());
            } catch (Exception e) {
                log.error("del key:{} error", key, e);
                return null;
            } finally {
                close(jedis);
            }
        }
    
        /**
         * 判断key是否存在
         *
         * @param key
         * @return
         */
        public Boolean exists(String key) {
            Jedis jedis = null;
            try {
                jedis = getJedis();
                return jedis.exists(key.getBytes());
            } catch (Exception e) {
                log.error("exists key:{} error", key, e);
                return null;
            } finally {
                close(jedis);
            }
        }
    
        /**
         * 设值key过期时间
         *
         * @param key
         * @param expireTime 过期时间, 单位: s
         * @return
         */
        public Long expire(String key, int expireTime) {
            Jedis jedis = null;
            try {
                jedis = getJedis();
                return jedis.expire(key.getBytes(), expireTime);
            } catch (Exception e) {
                log.error("expire key:{} error", key, e);
                return null;
            } finally {
                close(jedis);
            }
        }
    
        /**
         * 获取剩余时间
         *
         * @param key
         * @return
         */
        public Long ttl(String key) {
            Jedis jedis = null;
            try {
                jedis = getJedis();
                return jedis.ttl(key);
            } catch (Exception e) {
                log.error("ttl key:{} error", key, e);
                return null;
            } finally {
                close(jedis);
            }
        }
    
        private void close(Jedis jedis) {
            if (null != jedis) {
                jedis.close();
            }
        }
    
    }

3、自定义注解`@ApiIdempotent`

package com.wangzaiplus.test.annotation;
    
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /**
     * 在需要保证 接口幂等性 的Controller的方法上使用此注解
     */
    @Target({ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface ApiIdempotent {
    }

4、`ApiIdempotentInterceptor` 拦截器

package com.wangzaiplus.test.interceptor;
    
    import com.wangzaiplus.test.annotation.ApiIdempotent;
    import com.wangzaiplus.test.service.TokenService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.method.HandlerMethod;
    import org.springframework.web.servlet.HandlerInterceptor;
    import org.springframework.web.servlet.ModelAndView;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.lang.reflect.Method;
    
    /**
     * 接口幂等性拦截器
     */
    public class ApiIdempotentInterceptor implements HandlerInterceptor {
    
        @Autowired
        private TokenService tokenService;
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
            if (!(handler instanceof HandlerMethod)) {
                return true;
            }
    
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
    
            ApiIdempotent methodAnnotation = method.getAnnotation(ApiIdempotent.class);
            if (methodAnnotation != null) {
                check(request);// 幂等性校验, 校验通过则放行, 校验失败则抛出异常, 并通过统一异常处理返回友好提示
            }
    
            return true;
        }
    
        private void check(HttpServletRequest request) {
            tokenService.checkToken(request);
        }
    
        @Override
        public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        }
    
        @Override
        public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        }
    }

5、`TokenServiceImpl`

package com.wangzaiplus.test.service.impl;
    
    import com.wangzaiplus.test.common.Constant;
    import com.wangzaiplus.test.common.ResponseCode;
    import com.wangzaiplus.test.common.ServerResponse;
    import com.wangzaiplus.test.exception.ServiceException;
    import com.wangzaiplus.test.service.TokenService;
    import com.wangzaiplus.test.util.JedisUtil;
    import com.wangzaiplus.test.util.RandomUtil;
    import lombok.extern.slf4j.Slf4j;
    import org.apache.commons.lang3.StringUtils;
    import org.apache.commons.lang3.text.StrBuilder;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import javax.servlet.http.HttpServletRequest;
    
    @Service
    public class TokenServiceImpl implements TokenService {
    
        private static final String TOKEN_NAME = "token";
    
        @Autowired
        private JedisUtil jedisUtil;
    
        @Override
        public ServerResponse createToken() {
            String str = RandomUtil.UUID32();
            StrBuilder token = new StrBuilder();
            token.append(Constant.Redis.TOKEN_PREFIX).append(str);
    
            jedisUtil.set(token.toString(), token.toString(), Constant.Redis.EXPIRE_TIME_MINUTE);
    
            return ServerResponse.success(token.toString());
        }
    
        @Override
        public void checkToken(HttpServletRequest request) {
            String token = request.getHeader(TOKEN_NAME);
            if (StringUtils.isBlank(token)) {// header中不存在token
                token = request.getParameter(TOKEN_NAME);
                if (StringUtils.isBlank(token)) {// parameter中也不存在token
                    throw new ServiceException(ResponseCode.ILLEGAL_ARGUMENT.getMsg());
                }
            }
    
            if (!jedisUtil.exists(token)) {
                throw new ServiceException(ResponseCode.REPETITIVE_OPERATION.getMsg());
            }
    
            Long del = jedisUtil.del(token);
            if (del <= 0) {
                throw new ServiceException(ResponseCode.REPETITIVE_OPERATION.getMsg());
            }
        }
    
    }

6、`TestApplication`

package com.wangzaiplus.test;
    
    import com.wangzaiplus.test.interceptor.ApiIdempotentInterceptor;
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.cors.CorsConfiguration;
    import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
    import org.springframework.web.filter.CorsFilter;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
    
    @SpringBootApplication
    @MapperScan("com.wangzaiplus.test.mapper")
    public class TestApplication  extends WebMvcConfigurerAdapter {
    
        public static void main(String[] args) {
            SpringApplication.run(TestApplication.class, args);
        }
    
        /**
         * 跨域
         * @return
         */
        @Bean
        public CorsFilter corsFilter() {
            final UrlBasedCorsConfigurationSource urlBasedCorsConfigurationSource = new UrlBasedCorsConfigurationSource();
            final CorsConfiguration corsConfiguration = new CorsConfiguration();
            corsConfiguration.setAllowCredentials(true);
            corsConfiguration.addAllowedOrigin("*");
            corsConfiguration.addAllowedHeader("*");
            corsConfiguration.addAllowedMethod("*");
            urlBasedCorsConfigurationSource.registerCorsConfiguration("/**", corsConfiguration);
            return new CorsFilter(urlBasedCorsConfigurationSource);
        }
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            // 接口幂等性拦截器
            registry.addInterceptor(apiIdempotentInterceptor());
            super.addInterceptors(registry);
        }
    
        @Bean
        public ApiIdempotentInterceptor apiIdempotentInterceptor() {
            return new ApiIdempotentInterceptor();
        }
    
    }

OK, 目前为止, 校验代码准备就绪, 接下来测试验证

# [七、测试验证][Link 2] #

1、获取`token`的控制器`TokenController`

package com.wangzaiplus.test.controller;
    
    import com.wangzaiplus.test.common.ServerResponse;
    import com.wangzaiplus.test.service.TokenService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/token")
    public class TokenController {
    
        @Autowired
        private TokenService tokenService;
    
        @GetMapping
        public ServerResponse token() {
            return tokenService.createToken();
        }
    
    }

2、`TestController`, 注意`@ApiIdempotent`注解, 在需要幂等性校验的方法上声明此注解即可, 不需要校验的无影响

package com.wangzaiplus.test.controller;
    
    import com.wangzaiplus.test.annotation.ApiIdempotent;
    import com.wangzaiplus.test.common.ServerResponse;
    import com.wangzaiplus.test.service.TestService;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/test")
    @Slf4j
    public class TestController {
    
        @Autowired
        private TestService testService;
    
        @ApiIdempotent
        @PostMapping("testIdempotence")
        public ServerResponse testIdempotence() {
            return testService.testIdempotence();
        }
    
    }

3、获取 `token`

![12efcbba7cf89cb184ce549c8727b797.png][]

查看redis

![798f824696fd7bd25ad0b90ec1582fe2.png][]

4、测试接口安全性: 利用jmeter测试工具模拟50个并发请求, 将上一步获取到的token作为参数

![1ccda839d0e3797092e2805308ca95bf.png][]![0050d54dc1ab6423f43323d35e4b5955.png][]

5、header或参数均不传token, 或者token值为空, 或者token值乱填, 均无法通过校验, 如token值为"abcd"

![a3ce03a73b54858644bab3795b15bc04.png][]

# [八、注意点(非常重要)][Link 2] #

![c8d7f5f81a8cef4f00c037a4520581ce.png][]

上图中, 不能单纯的直接删除token而不校验是否删除成功, 会出现并发安全性问题, 因为, 有可能多个线程同时走到第46行, 此时token还未被删除, 所以继续往下执行, 如果不校验`jedisUtil.del(token)`的删除结果而直接放行, 那么还是会出现重复提交问题, 即使实际上只有一次真正的删除操作, 下面重现一下

稍微修改一下代码:

![451d30d52dcdbb244e4bc9b5654da458.png][]

再次请求

![95edb7ecfb8272501d0a4a051be34add.png][]

再看看控制台

![82677735ee2a0b2c9c549bbd4512ea08.png][]

虽然只有一个真正删除掉token, 但由于没有对删除结果进行校验, 所以还是有并发问题, 因此, 必须校验

# [九、总结][Link 2] #

其实思路很简单, 就是每次请求保证唯一性, 从而保证幂等性, 通过拦截器+注解, 就不用每次请求都写重复代码, 其实也可以利用spring aop实现, 无所谓。

<END>

**推荐阅读：**

[阿里官宣：干掉Mybatis和MybatisPlus，推出新一代ORM框架FluentMybatis，太牛逼了！][Mybatis_MybatisPlus_ORM_FluentMybatis]

[知乎高赞：从源码层，拆解OracleJDK和OpenJDK有什么区别？网友：不愧是大神的回答~][OracleJDK_OpenJDK]

最近面试BAT，整理一份面试资料《Java面试BATJ通关手册》，覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。

**获取方式：点个「****在看****」，点击上方小卡片，进入公众号后回复「****面试题****」领取，更多内容陆续奉上。**

朕已阅 ![462d380f63ce3c4c67bc57a432198631.gif][]

[0D5F937FE12312312D81F17F.jpg]: /images/20220829/7686be553b034fa78c9cd23d7caddd54.png
[Link 1]: https://mp.weixin.qq.com/s?__biz=MzUyNDkzNzczNQ%3D%3D&chksm=fa24f0bacd5379ac93d74ffebac826d2401fd494f82e900e5102a8bf968f108e4ec72a4ad548&idx=3&lang=zh_CN&mid=2247487442&scene=21&sn=61e758d4bf9f15a3419fd028146469a3&token=1854383306#wechat_redirect
[Link 2]: https://mp.weixin.qq.com/s?__biz=MzUzMTA2NTU2Ng%3D%3D&idx=1&mid=2247487551&scene=21&sn=18f64ba49f3f0f9d8be9d1fdef8857d9#wechat_redirect
[12efcbba7cf89cb184ce549c8727b797.png]: /images/20220829/6d33986cd7b54445b127704ea6ab4ad4.png
[798f824696fd7bd25ad0b90ec1582fe2.png]: /images/20220829/e3c06f13c96745a5a7f525bbe0f23c64.png
[1ccda839d0e3797092e2805308ca95bf.png]: https://img-blog.csdnimg.cn/img_convert/1ccda839d0e3797092e2805308ca95bf.png
[0050d54dc1ab6423f43323d35e4b5955.png]: /images/20220829/62a31023672e4629b0426c1adad64074.png
[a3ce03a73b54858644bab3795b15bc04.png]: /images/20220829/e5420b554b7e4e0daa00d5f81fde2185.png
[c8d7f5f81a8cef4f00c037a4520581ce.png]: /images/20220829/c7a5f1e88346416592480ddc230b9b0d.png
[451d30d52dcdbb244e4bc9b5654da458.png]: /images/20220829/e1fafde7ece34a61b57db1550063b1db.png
[95edb7ecfb8272501d0a4a051be34add.png]: /images/20220829/33648ffdb55242239722094ca78c62a1.png
[82677735ee2a0b2c9c549bbd4512ea08.png]: /images/20220829/fe99ada855474ea59ba6dc845482c5f9.png
[Mybatis_MybatisPlus_ORM_FluentMybatis]: http://mp.weixin.qq.com/s?__biz=MzUyNDkzNzczNQ%3D%3D&chksm=fa2757adcd50debb6983487dce8895715ccc43390e35e6a7448e18dbd77f5f081d84fecff330&idx=1&mid=2247510213&scene=21&sn=4cea27e537bf77c18b95c082cce45826#wechat_redirect
[OracleJDK_OpenJDK]: http://mp.weixin.qq.com/s?__biz=MzUyNDkzNzczNQ%3D%3D&chksm=fa2757adcd50debbd592c8ca18ea5445c6dd46fd1aa70f939803ad426ba2f26c66e7b138090d&idx=2&mid=2247510213&scene=21&sn=67ef7e1fc90423285c3e406d3210643d#wechat_redirect
[462d380f63ce3c4c67bc57a432198631.gif]: /images/20220829/0d6356546b4a4e429b492eeb438b958c.png