SpringBoot+Redis实现接口幂等性

1.简介

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

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

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

image-20200416153200850.png

2.实现过程

• 引入meavn依赖

          
              org.springframework.boot
              spring-boot-starter-data-redis
          
  

• spring配置文件写入

  server.port=8080
  core.datasource.druid.enabled=true
  core.datasource.druid.url=jdbc:mysql://192.168.1.225:3306/?useUnicode=true&characterEncoding=UTF-8
  core.datasource.druid.username=root
  core.datasource.druid.password=
  core.redis.enabled=true
  spring.redis.host=192.168.1.225 #本机的redis地址
  spring.redis.port=16379
  spring.redis.database=3
  spring.redis.jedis.pool.max-active=10
  spring.redis.jedis.pool.max-idle=10
  spring.redis.jedis.pool.max-wait=5s
  spring.redis.jedis.pool.min-idle=10
  

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

  package cn.smallmartial.demo.utils;
  
  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.data.redis.core.RedisTemplate;
  import org.springframework.data.redis.core.ValueOperations;
  import org.springframework.stereotype.Component;
  
  import java.io.Serializable;
  import java.util.Objects;
  import java.util.concurrent.TimeUnit;
  
  /**
   * @Author smallmartial
   * @Date 2020/4/16
   * @Email [email protected]
   */
  @Component
  public class RedisUtil {
  
      @Autowired
      private RedisTemplate redisTemplate;
  
      /**
       * 写入缓存
       *
       * @param key
       * @param value
       * @return
       */
      public boolean set(final String key, Object value) {
          boolean result = false;
          try {
              ValueOperations operations = redisTemplate.opsForValue();
              operations.set(key, value);
              result = true;
          } catch (Exception e) {
              e.printStackTrace();
          }
          return result;
      }
  
      /**
       * 写入缓存设置时间
       *
       * @param key
       * @param value
       * @param expireTime
       * @return
       */
      public boolean setEx(final String key, Object value, long expireTime) {
          boolean result = false;
          try {
              ValueOperations operations = redisTemplate.opsForValue();
              operations.set(key, value);
              redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);
              result = true;
          } catch (Exception e) {
              e.printStackTrace();
          }
          return result;
      }
  
      /**
       * 读取缓存
       *
       * @param key
       * @return
       */
      public Object get(final String key) {
          Object result = null;
          ValueOperations 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;
  
      }
  
      /**
       * 判断key是否存在
       *
       * @param key
       * @return
       */
      public boolean exists(final String key) {
          boolean result = false;
          ValueOperations operations = redisTemplate.opsForValue();
          if (Objects.nonNull(operations.get(key))) {
              result = true;
          }
          return result;
      }
  
  
  }
  
  

• 自定义注解AutoIdempotent

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

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

• toKen的创建和实现

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

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

  package cn.smallmartial.demo.service.impl;
  
  import cn.smallmartial.demo.bean.RedisKeyPrefix;
  import cn.smallmartial.demo.bean.ResponseCode;
  import cn.smallmartial.demo.exception.ApiResult;
  import cn.smallmartial.demo.exception.BusinessException;
  import cn.smallmartial.demo.service.TokenService;
  import cn.smallmartial.demo.utils.RedisUtil;
  import io.netty.util.internal.StringUtil;
  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.stereotype.Service;
  import org.springframework.util.StringUtils;
  
  import javax.servlet.http.HttpServletRequest;
  import java.util.Random;
  import java.util.UUID;
  
  /**
   * @Author smallmartial
   * @Date 2020/4/16
   * @Email [email protected]
   */
  @Service
  public class TokenServiceImpl implements TokenService {
      @Autowired
      private RedisUtil redisService;
  
      /**
       * 创建token
       *
       * @return
       */
      @Override
      public String createToken() {
          String str = UUID.randomUUID().toString().replace("-", "");
          StringBuilder token = new StringBuilder();
          try {
              token.append(RedisKeyPrefix.TOKEN_PREFIX).append(str);
              redisService.setEx(token.toString(), token.toString(), 10000L);
              boolean empty = StringUtils.isEmpty(token.toString());
              if (!empty) {
                  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(RedisKeyPrefix.TOKEN_NAME);
          if (StringUtils.isEmpty(token)) {// header中不存在token
              token = request.getParameter(RedisKeyPrefix.TOKEN_NAME);
              if (StringUtils.isEmpty(token)) {// parameter中也不存在token
                  throw new BusinessException(ApiResult.BADARGUMENT);
              }
          }
  
          if (!redisService.exists(token)) {
              throw new BusinessException(ApiResult.REPETITIVE_OPERATION);
          }
  
          boolean remove = redisService.remove(token);
          if (!remove) {
              throw new BusinessException(ApiResult.REPETITIVE_OPERATION);
          }
          return true;
      }
  }
  
  

• 拦截器的配置

  @Configuration
  public class WebMvcConfiguration extends WebMvcConfigurationSupport {
  
      @Bean
      public AuthInterceptor authInterceptor() {
          return new AuthInterceptor();
      }
  
      /**
       * 拦截器配置
       *
       * @param registry
       */
      @Override
      public void addInterceptors(InterceptorRegistry registry) {
          registry.addInterceptor(authInterceptor());
  //                .addPathPatterns("/ksb/**")
  //                .excludePathPatterns("/ksb/auth/**", "/api/common/**", "/error", "/api/*");
          super.addInterceptors(registry);
      }
  
      @Override
      public void addResourceHandlers(ResourceHandlerRegistry registry) {
          registry.addResourceHandler("/**").addResourceLocations(
                  "classpath:/static/");
          registry.addResourceHandler("swagger-ui.html").addResourceLocations(
                  "classpath:/META-INF/resources/");
          registry.addResourceHandler("/webjars/**").addResourceLocations(
                  "classpath:/META-INF/resources/webjars/");
          super.addResourceHandlers(registry);
      }
  
  
  }
  
  

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

  @Slf4j
  public class AuthInterceptor extends HandlerInterceptorAdapter {
  
      @Autowired
      private TokenService tokenService;
  
      @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) {
                  throw new BusinessException(ApiResult.REPETITIVE_OPERATION);
              }
          }
          return true;
      }
  
  }
  

• 测试用例

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

/**
 * @Author smallmartial
 * @Date 2020/4/16
 * @Email [email protected]
 */
@RestController
public class BusinessController {


    @Autowired
    private TokenService tokenService;

    @GetMapping("/get/token")
    public Object  getToken(){
        String token = tokenService.createToken();
        return ResponseUtil.ok(token) ;
    }


    @AutoIdempotent
    @GetMapping("/test/Idempotence")
    public Object testIdempotence() {
        String token = "接口幂等性测试";
        return ResponseUtil.ok(token) ;
    }
}

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

image-20200416154317162.png

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

image-20200416154404970.png

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

image-20200416154442469.png

3.总结

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

源码地址：https://github.com/smallmartial/springbootdemo/tree/master/springbootredis