幂等注解实现

业务需求：

有些前端，或者第三方的接口请求要实现幂等操作，考虑到节省开发时间，做了一个可配置的幂等注解

先说明基本的实现原理和优缺点，后面直接贴代码：

 

原理：

1.通过自定义注解配置幂等参数：唯一主键，过期时间；

2.通过HandleInterceptor拦截请求方法和注解参数，进行校验

3.根据唯一主键，主键的值，过期时间，请求url来生成唯一token存redis。后续重复请求判断redis是否已经存在key。如果redis存在则说明已经执行过了（不管执行失败还是成功都算）

优点：

只要在方法上添加注解配置

@AutoIdempotent(pkId = "orderDetailsId",expire=300)

则接口就实现过期时间内的幂等，减少业务开发时间

缺点：

需借助redis，只是过期时间内的幂等，过期时间外的就不支持了

核心代码：

注解：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface AutoIdempotent {
    //幂等控制主键
    String pkId();

    //键过期时间单位：s
    long expire() default 120;
}

幂等拦截器：

package com.ddmc.interceptor.autoidempotent;

import com.ddmc.exception.enums.CommonAssertEnum;
import com.ddmc.interceptor.autoidempotent.annotation.AutoIdempotent;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
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;

/**
 * 幂等拦截器
 *
 * @author yuJie
 * @since 2020/5/16
 */
@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();
        AutoIdempotent methodAnnotation = method.getAnnotation(AutoIdempotent.class);
        if (methodAnnotation != null) {
            try {
                /**
                 * 幂等性校验, 校验通过则放行, 校验失败则抛出异常, 并通过统一异常处理返回
                 */
                String pkId = methodAnnotation.pkId();
                long expire = methodAnnotation.expire();
                return tokenService.checkToken(request, pkId,expire);
            } catch (Exception ex) {
                CommonAssertEnum.DO_NOT_SUBMIT_AGAIN.assertFail();
            }
        }
        //必须返回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 {

    }

}

Token操作类：

 

package com.ddmc.interceptor.autoidempotent;

import com.ddmc.exception.enums.CommonAssertEnum;
import com.ddmc.utils.http.RequestHandleUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;

import javax.servlet.http.HttpServletRequest;
import java.util.concurrent.TimeUnit;

/**
 * token操作实现类
 *
 * @author yuJie
 * @since 2020/5/16
 */
@Service
public class TokenServiceImpl implements TokenService {
    /**
     * 幂等检测key过期时间默认120s
     */
    private final static long expire = 120;
    private final static String AUTO_IDEMPOTENT_KEY = "md";
    @Autowired
    private RedisTemplate<String, Object> solarRedisTemplate;

    /**
     * 创建token
     *
     * @return
     */
    @Override
    public Boolean saveToken(String key, String token) {
        solarRedisTemplate.opsForValue().setIfAbsent(key, token, expire, TimeUnit.SECONDS);
        return Boolean.TRUE;
    }


    /**
     * 检验token
     *
     * @param request
     * @return
     */
    @Override
    public boolean checkToken(HttpServletRequest request, String pkId,long expire) throws Exception {
        String version = request.getHeader("version");
        String pkIdValue = RequestHandleUtil.getReqParam(request, pkId);
        String requestURI = request.getRequestURI();
        //控制redis key的长度
        requestURI = requestURI.substring(requestURI.length() - 20);
        StringBuffer key = new StringBuffer();
        key.append(AUTO_IDEMPOTENT_KEY)
                .append(requestURI).append(":")
                .append(pkId == null ? "id" : pkId).append(":")
                .append(pkIdValue == null ? "value" : pkIdValue).append(":")
                .append(version == null ? "0" : version);
        if (solarRedisTemplate.hasKey(key.toString())) {
            CommonAssertEnum.DO_NOT_SUBMIT_AGAIN.assertFail();
        } else {
            solarRedisTemplate.opsForValue().setIfAbsent(key.toString(), "exist", expire, TimeUnit.SECONDS);
        }
        return true;
    }
}

幂等拦截器配置：

package com.ddmc.interceptor.autoidempotent;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

import javax.annotation.Resource;

/**
 * 幂等拦截器配置
 *
 * @author yuJie
 * @since 2020/5/16
 */
@Configuration
public class WebAutoIdempotentConfiguration extends WebMvcConfigurationSupport {

    @Resource
    private AutoIdempotentInterceptor autoIdempotentInterceptor;

    /**
     * 添加拦截器
     *
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(autoIdempotentInterceptor);
        super.addInterceptors(registry);
    }
}

因为需要从post的body获取传递的参数，而body的流数据只能拿到一次，所以需要额外的filter包装器：

package com.ddmc.filter;

import com.ddmc.utils.http.BodyReaderHttpServletRequestWrapper;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**
 * 类作用描述
 *
 * @author yuJie
 * @since 2020/5/18
 */
@Order(0)
@WebFilter(filterName = "httpServletRequestWrapperFilter", urlPatterns = {"/*"})
@Component
public class HttpServletRequestWrapperFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {

        ServletRequest requestWrapper = null;

        if (request instanceof HttpServletRequest) {
            HttpServletRequest httpRequest = (HttpServletRequest) request;
            //遇到post方法才对request进行包装
            String methodType = httpRequest.getMethod();
            if ("POST".equals(methodType)) {
                requestWrapper = new BodyReaderHttpServletRequestWrapper(
                        (HttpServletRequest) request);
            }
        }
        if (null == requestWrapper) {
            chain.doFilter(request, response);
        } else {
            chain.doFilter(requestWrapper, response);
        }
    }

    @Override
    public void destroy() {

    }
}

增加下压测和redis内存占用情况：

50000次请求，redis内存占用