复工不到一个月疯狂的加班中,最近没什么时间写博客更文有点慢,好在做的项目中不全是增删改的业务逻辑,还是有一些比较有意思实用的技术点,所以整理出来分享给大家。和那些搞高端技术的大佬比不了,咱就是个还在一线搬砖的码农。
有没有遇到过这种情况:由于网速等原因,网页响应很慢,提交一次表单后发现服务久久没响应,然后你就疯狂点击提交按钮(12306就经常被这样怒怼),如果做过防重复提交还好,否则那是什么级别的灾难就不好说了。。。
今天主要是用 自定义注解、 AOP、· Guava 包中Cache来生成一种本地锁,来达到的防重复提交效果,整体的实现比较简单,没有什么太大的难度,代码也是比较少,,由于是基于内存的缓存,因此这种实现方式并不适用于分布式服务。旨在给大家介绍一种实现防重复提交的方案,要是有什么说的不对的地方大家温柔一点撕,毕竟人家还是个20出头30郎当岁的孩子。
guava包是个啥?做过Java的小伙伴应该多少都有所了解,它是google “嫌弃” JAVA自带的类库不好用,自行研发的一套工具包,对JDK工具做了很好的拓展。例如:并发[Concurrency]、缓存[Caches]、 函数式风格[Functional idioms]、 字符串处理[Strings]等。
总之一句话guava包很好用多去了解下,能不造的轮子咱们就尽量不去造,因为咱们自己造的轮子可能不太圆。不多说废话了,来看看具体的实现。
代码撸起来
1、引入Guava包依赖
第一步引入Guava的依赖包没什么好说的
1 <dependency>
2 <groupId>com.google.guava</groupId>
3 <artifactId>guava</artifactId>
4 <version>21.0</version>
5 </dependency>
2、自定义注解
服务端实现防止重复提交,一般都是利用AOP自定义注解的的方式,作用于controller的入口方法。自定义一个LocalLock注解用于需要防止重复提交的方法上。
1 /**
2 * 锁的注解
3 *
4 */
5 @Target(ElementType.METHOD)
6 @Retention(RetentionPolicy.RUNTIME)
7 @Documented
8 @Inherited
9 public @interface LocalLock {
10
11 /**
12 * @author fly
13 */
14 String key() default "";
15 }
注解定义好以后就需要做AOP拦截器切面的具体实现,在 interceptor() 方法上采用的是 Around(环绕增强) ,因此所有带 LocalLock 注解的都将被切面处理;
1 @Around("execution(public * *(..)) && @annotation(com.chengxy.annotation.LocalLock)")
既然是缓存,那紧跟的属性一定要有过期时间,通过expireAfterWrite 设置缓存的过期时间,maximumSize设置缓存的个数。
通过在内存中查询key是否存在来判断是否让再次提交,和Redis的setNX方法是一个比较像。
这里我们设置同一个方法,5秒钟内相同参数的请求只允许执行一次。
1 @Aspect
2 @Configuration
3 public class LockMethodInterceptor {
4
5 private static final Cache<String, Object> CACHES = CacheBuilder.newBuilder()
6 // 最大缓存 100 个
7 .maximumSize(1000)
8 // 设置写缓存后 5 秒钟过期
9 .expireAfterWrite(5, TimeUnit.SECONDS)
10 .build();
11
12 @Around("execution(public * *(..)) && @annotation(com.chengxy.annotation.LocalLock)")
13 public Object interceptor(ProceedingJoinPoint pjp) {
14 MethodSignature signature = (MethodSignature) pjp.getSignature();
15 Method method = signature.getMethod();
16 LocalLock localLock = method.getAnnotation(LocalLock.class);
17 String key = getKey(localLock.key(), pjp.getArgs());
18 if (!StringUtils.isEmpty(key)) {
19 if (CACHES.getIfPresent(key) != null) {
20 throw new RuntimeException("请勿重复请求");
21 }
22 // 如果是第一次请求,就将 key 当前对象压入缓存中
23 CACHES.put(key, key);
24 }
25 try {
26 return pjp.proceed();
27 } catch (Throwable throwable) {
28 throw new RuntimeException("服务器异常");
29 } finally {
30 // TODO 为了演示效果,这里就不调用 CACHES.invalidate(key); 代码了
31 }
32 }
33
34 /**
35 * key 的生成策略,如果想灵活可以写成接口与实现类的方式(TODO 后续讲解)
36 *
37 * @param keyExpress 表达式
38 * @param args 参数
39 * @return 生成的key
40 */
41 private String getKey(String keyExpress, Object[] args) {
42 for (int i = 0; i < args.length; i++) {
43 keyExpress = keyExpress.replace("arg[" + i + "]", args[i].toString());
44 }
45 return keyExpress;
46 }
47 }
3、注解使用
我们将注解加在控制层方法上,key = "city:arg[0] key自己定义,arg[0]这个匹配规则表示替换成第一个参数。那么就实现city:token在一定时间内不可以重复提交了
1 @RestController
2 @RequestMapping("/city")
3 public class BookController {
4
5 @LocalLock(key = "city:arg[0]")
6 @GetMapping
7 public String query(@RequestParam String token) {
8 return "ok- " + token;
9 }
10 }
4、测试
接下来我们就测试一下,预期结果:5秒内只有第一次的提交会正常返回,其余的显示“请勿重复提交”,看看执行结果是不是我们预期的那样,这里用postman测试。
第一次请求正常响应:
紧接着请求第二次,返回结果“重复提交”,显然我们实现成功了
Redis 分布式实现
如果需要在分布式环境下做防止重复提交,可以借助 redis来实现,和 Guava实现原理上如出一辙,自定义注解等步骤也是一样的,只是替换一下切面类里的实现方式而已。
1 /**
2 * @Author: xinzhifu
3 * @Description:
4 */
5 @Aspect
6 @Component
7 public class LockMethodInterceptor {
8
9 @Autowired
10 private RedisTemplate redisTemplate;
11
12 /**
13 * @param point
14 */
15 @Around("execution(public * *(..)) && @annotation(com.chengxy.annotation.RedisLock)")
16 public Object interceptor(ProceedingJoinPoint point) throws Throwable {
17
18 HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
19 String ip = IPUtil.getIP(request);
20 //获取注解
21 MethodSignature signature = (MethodSignature) point.getSignature();
22 Method method = signature.getMethod();
23 //目标类、方法
24 String className = method.getDeclaringClass().getName();
25 String name = method.getName();
26 String ipKey = String.format("%s#%s", className, name);
27 int hashCode = Math.abs(ipKey.hashCode());
28 String key = String.format("%s_%d", ip, hashCode);
29 log.info("ipKey={},hashCode={},key={}", ipKey, hashCode, key);
30 AvoidRepeatableCommit avoidRepeatableCommit = method.getAnnotation(AvoidRepeatableCommit.class);
31 long timeout = avoidRepeatableCommit.timeout();
32 if (timeout < 0) {
33 //过期时间5分钟
34 timeout = 60 * 5;
35 }
36 String value = (String) redisTemplate.opsForValue().get(key);
37 if (StringUtils.isNotBlank(value)) {
38 return "请勿重复提交";
39 }
40 redisTemplate.opsForValue().set(key, UUIDUtil.uuid(), timeout, TimeUnit.MILLISECONDS);
41 //执行方法
42 Object object = point.proceed();
43 return object;
44 }
45 }