Springboot 2.x 如何解决重复提交（本地锁的实践）

Posted 2021-03-12 程序员内点事

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Springboot 2.x 如何解决重复提交（本地锁的实践）相关的知识，希望对你有一定的参考价值。

有没有遇到过这种情况：网页响应很慢，提交一次表单后发现没反应，然后你就疯狂点击提交按钮（12306就经常被这样怒怼），如果做过防重复提交还好，否则那是什么级别的灾难就不好说了。。。

本文主要是应用 自定义注解、 spring AOP、· Guava Cache 生成一种本地锁，来达到的防重复提交效果，由于是基于内存的缓存，所以这种实现方式并不适用于分布式服务

Guava是什么？

guava包是google嫌弃JAVA自带的类库不好用，自行研发的一套工具包，对JDK工具做了很好的拓展。例如：并发[Concurrency]、缓存[Caches]、函数式风格[Functional idioms]、字符串处理[Strings]等等。

一、引入Guava包依赖

<dependency>
        <groupId>com.google.guava</groupId>
        <artifactId>guava</artifactId>
        <version>21.0</version>
</dependency>

二、自定义LocalLock注解

自定义一个LocalLock注解用于需要防止重复提交的方法上

/**
 * 锁的注解
 *
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface LocalLock {

    /**
     * @author fly
     */
    String key() default "";
}

注解定义好以后就需要做AOP拦截器切面的具体实现，在 interceptor() 方法上采用的是 Around（环绕增强），所有带 LocalLock 注解的都将被切面处理；

既然是缓存，那紧跟的属性一定要有过期时间，通过expireAfterWrite 设置缓存的过期时间，maximumSize设置缓存的个数。

通过在内存中查询key是否存在来判断是否让再次提交，和Redis的setNX方法是一个原理。

那么这个注解该怎么用呢？

@Aspect
@Configuration
public class LockMethodInterceptor {

    private static final Cache<String, Object> CACHES = CacheBuilder.newBuilder()
            // 最大缓存 100 个
            .maximumSize(1000)
            // 设置写缓存后 5 秒钟过期
            .expireAfterWrite(5, TimeUnit.SECONDS)
            .build();

    @Around("execution(public * *(..)) && @annotation(com.battcn.annotation.LocalLock)")
    public Object interceptor(ProceedingJoinPoint pjp) {
        MethodSignature signature = (MethodSignature) pjp.getSignature();
        Method method = signature.getMethod();
        LocalLock localLock = method.getAnnotation(LocalLock.class);
        String key = getKey(localLock.key(), pjp.getArgs());
        if (!StringUtils.isEmpty(key)) {
            if (CACHES.getIfPresent(key) != null) {
                throw new RuntimeException("请勿重复请求");
            }
            // 如果是第一次请求,就将 key 当前对象压入缓存中
            CACHES.put(key, key);
        }
        try {
            return pjp.proceed();
        } catch (Throwable throwable) {
            throw new RuntimeException("服务器异常");
        } finally {
            // TODO 为了演示效果,这里就不调用 CACHES.invalidate(key); 代码了
        }
    }

    /**
     * key 的生成策略,如果想灵活可以写成接口与实现类的方式（TODO 后续讲解）
     *
     * @param keyExpress 表达式
     * @param args       参数
     * @return 生成的key
     */
    private String getKey(String keyExpress, Object[] args) {
        for (int i = 0; i < args.length; i++) {
            keyExpress = keyExpress.replace("arg[" + i + "]", args[i].toString());
        }
        return keyExpress;
    }
}

控制层的实现

我们将注解加在控制层方法上，key = "city:arg[0] key自己定义，arg[0]这个匹配规则表示替换成第一个参数。那么就实现city:token在一定时间内不可以重复提交了

@RestController
@RequestMapping("/city")
public class BookController {

    @LocalLock(key = "city:arg[0]")
    @GetMapping
    public String query(@RequestParam String token) {
        return "ok- " + token;
    }
}