之前用C++写服务器的时候,写接口限制访问次数是根据ip来限制用户的访问,手动一行一行的写,现在接触java、spring后,有了更加快捷的实现方式。总体思路还是类似的。
1. 实现方法的注解
package com.wangjie.lingguan.common.annotation;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import java.lang.annotation.*;
/**
* @Description 统计接口的访问次数
* @Author wangjie
* @Date 2017/10/12
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
@Order(Ordered.HIGHEST_PRECEDENCE)
public @interface RequestLimit {
/**
* 接口的最大访问次数
* @author wangjie
* @date 2017/10/12
*/
int maxCount() default Integer.MAX_VALUE;
/**
* 规定统计的时间段,默认一分钟
* @author wangjie
* @date 2017/10/12
*/
long timeout() default 60 * 1000;
}
2. 实现拦截器
package com.wangjie.lingguan.common.aop;
import com.wangjie.lingguan.common.RequestLimitException;
import com.wangjie.lingguan.common.annotation.RequestLimit;
import com.wangjie.lingguan.entity.User;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
import java.util.concurrent.TimeUnit;
/**
* @Description 拦截接口的请求,统计规定时间段内的请求次数
* @Author wangjie
* @Date 2017/10/12
*/
@Aspect
@Component
public class RequestLimitAop {
private static final Logger logger = LoggerFactory.getLogger("RequestLimitAop");
@Autowired
private RedisTemplate redisTemplate;
@Before("within(@org.springframework.web.bind.annotation.RestController *) && @annotation(limit)")
public void requestLimit(final JoinPoint joinPoint, RequestLimit limit) throws RequestLimitException {
try {
Object[] args = joinPoint.getArgs();
HttpServletRequest request = null;
for (int i = 0; i < args.length; i++) {
if (args[i] instanceof HttpServletRequest) {
request = (HttpServletRequest) args[i];
break;
}
}
if (request == null) {
throw new RequestLimitException("方法中缺失HttpServletRequest参数");
}
String ip = request.getRemoteAddr();//HttpRequestUtil.getIpAddr(request);
String url = request.getRequestURL().toString();
String key = "req_limit_".concat(url).concat(ip);
long count = redisTemplate.opsForValue().increment(key, 1);
if (count == 1) {
redisTemplate.expire(key, limit.timeout(), TimeUnit.MILLISECONDS);
}
if (count > limit.maxCount()) {
logger.info("用户IP[" + ip + "]访问地址[" + url + "]超过了限定的次数[" + limit.maxCount() + "]");
throw new RequestLimitException();
}
} catch (RequestLimitException e) {
throw e;
} catch (Exception e) {
logger.error("发生异常: ", e);
}
}
}
3. 实现接口访问次数限制相关的异常
package com.wangjie.lingguan.common.exception;
/**
* @Description
* @Author wangjie
* @Date 2017/10/12
*/
public class RequestLimitException extends Exception {
private static final long serialVersionUID = 1364225358754654702L;
public RequestLimitException() {
super("HTTP请求超出设定的限制");
}
public RequestLimitException(String message) {
super(message);
}
}
4. 使用示例
package com.wangjie.lingguan.controller;
import com.wangjie.lingguan.common.annotation.RequestLimit;
import com.wangjie.lingguan.entity.User;
import com.wangjie.lingguan.facade.UserFacade;
import dw.framework.response.ResultData;
import dw.support.constants.ErrorCode;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
/**
* @author wangjie
* @date 2017/7/16
*/
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserFacade userFacade;
@RequestLimit(maxCount = 2)
@RequestMapping("/login")
public ResultData login(HttpServletRequest request, User user) {
return ResultData.newResultData(user);
}
}