文章

解决重复提交问题(本地锁)

解决重复提交问题(本地锁)

重复提交

字面意思就是提交了很多次,这种情况一般都是前端给你挖的坑….

前段时间在开发中遇到一个这样的问题;前端小哥哥调用接口的时候存在 循环调用 的问题,正常情况下发送一个请求添加一条数据,结果变成了同一时刻并发的发送了 N 个请求,服务端瞬间懵逼的插入了 N 条一模一样的数据,前端小哥哥也不知道问题在哪里(恩…坑就这样挖好了,反正不填坑,气死你) 这时候咋办呢;后端干呗,反正脏活累活,背锅的事情也没少干了,多一件也不多….

本章目标

利用 自定义注解、Spring Aop、Guava Cache 实现表单防重复提交(不适用于分布式哦,后面会讲分布式方式…)

导入依赖

在 pom.xml 中添加上 spring-boot-starter-web 的依赖即可

org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-aop com.google.guava guava 21.0

Lock 注解

创建一个 LocalLock 注解,简单点就一个 key 可以了,由于暂时未用到 redis 所以 expire 是摆设….

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
package com.battcn.annotation;

import java.lang.annotation.*;

/**
* 锁的注解
*
* @author Levin
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface LocalLock {
    /**
    * @author fly
    */
    String key() default "";

    /**
    * 过期时间 TODO 由于用的 guava 暂时就忽略这属性吧 集成 redis 需要用到
    *
    * @author fly
    */
    int expire() default 5;
}

Lock 拦截器(AOP)

首先通过 CacheBuilder.newBuilder() 构建出缓存对象,设置好过期时间;其目的就是为了防止因程序崩溃锁得不到释放(当然如果单机这种方式程序都炸了,锁早没了;但这不妨碍我们写好点)

在具体的 interceptor() 方法上采用的是 Around(环绕增强) ,所有带 LocalLock 注解的都将被切面处理;

如果想更为灵活,key 的生成规则可以定义成接口形式(可以参考:org.springframework.cache.interceptor.KeyGenerator),这里就偷个懒了;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
package com.battcn.interceptor;

import com.battcn.annotation.LocalLock;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.StringUtils;

import java.lang.reflect.Method;
import java.util.concurrent.TimeUnit;

/**
* 本章先基于 本地缓存来做,后续讲解 redis 方案
*
* @author Levin
* @since 2018/6/12 0012
*/
@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;
    }
}

控制层

在接口上添加 @LocalLock(key = “book:arg[0]”);意味着会将 arg[0] 替换成第一个参数的值,生成后的新 key 将被缓存起来;

package com.battcn.controller; import com.battcn.annotation.LocalLock; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; /** * BookController * * @author Levin * @since 2018/6/06 0031 */ @RestController @RequestMapping(“/books”) public class BookController { @LocalLock(key = “book:arg[0]”) @GetMapping public String query(@RequestParam String token) { return “success -“ + token; } }

本文由作者按照 CC BY 4.0 进行授权