Springboot 2.x 如何解決重復提交（本地鎖的實踐）

本文轉載自查看原文 2020-02-05 22:41 1526 Springboot

有沒有遇到過這種情況：網頁響應很慢，提交一次表單后發現沒反應，然后你就瘋狂點擊提交按鈕（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;
    }
}