记录一下Spring框架中的频率次数拦截限制

定义注解

1
2
3
4
5
6
7
@Documented
@Target(ElementType.METHOD) // 说明该注解只能放在方法上面
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestLimit {
    long time() default 60000; // 限制时间 单位：毫秒
    int count() default 20; // 允许请求的次数
}

配置拦截器

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
@Component
class ReqLimitInterceptor implements HandlerInterceptor {
	
	private static ConcurrentHashMap<String, ExpiringMap<Object, Object>> book = new ConcurrentHashMap<String, ExpiringMap<Object, Object>>();

	@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
		String url = request.getParameter("robotUrl")==null?request.getRequestURI():request.getParameter("robotUrl");
		HandlerMethod handlerMethod = (HandlerMethod) handler;
        // 获取接口方法的注解
        RequestLimit annotation = handlerMethod.getMethodAnnotation(RequestLimit.class);
        if (annotation == null) {
            return true;
        }
		// 获取Map对象， 如果没有则返回默认值使用book.getOrDefault
		// 第一个参数是key， 第二个参数是默认值
		ExpiringMap<Object, Object> expiringMap = book.get(request.getRequestURI()) == null?
				ExpiringMap.builder().variableExpiration().build():book.get(request.getRequestURI());
		
		Integer count = (Integer) expiringMap.get(url);
		if(count == null) {
			count = 0;
		}
		
		if (count >= annotation.count()) { // 超过次数，不执行目标方法
			throw new TechnologyException("ERR-0300", new Object[] {annotation.time(), annotation.count()});
		} else if (count == 0){ // 第一次请求时，设置有效时间
			expiringMap.put(url, count + 1, ExpirationPolicy.CREATED, annotation.time(), TimeUnit.MILLISECONDS);
		} else { // 未超过次数， 记录加一
			expiringMap.put(url, count + 1);
		}
		book.put(request.getRequestURI(), expiringMap);
		return true;
    }

	@Override
	public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
			throws Exception {

	}

	@Override
	public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
			throws Exception {

	}
}

这里使用了一个三方net.jodah.expiringmap.ExpiringMap用于实现Map数据过期自动删除,也可以使用redis缓存等实现。
同时除了拦截器也可以使用AOP实现。
需要配合异常拦截器返回异常结果

使用方法

Controller方法加上注解即可

1
@RequestLimit(time = 60000, count = 20)

SpringMVC需要在配置文件中添加配置

1
2
3
4
5
<!-- 拦截器 -->
<mvc:interceptors>
    <!--拦截所有资源-->
    <bean class="*.ReqLimitInterceptor"></bean>
</mvc:interceptors>