拦截器
1.HandlerInterceptor 接口
我们在提供API的时候,经常需要对api进行统一的拦截,比如打印日志、安全性校验等。需要使用Spring boot进行拦截器设置。
拦截器实现HandlerInterceptor 接口,这个接口在
spring-webmvc5.0版本之前里面的方法是抽象方法;在5.0之后,该接口包含三个default 方法。代码如下:
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package org.springframework.web.servlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.lang.Nullable;
public interface HandlerInterceptor {
default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
return true;
}
default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
}
default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
}
}
2.拦截器实现类
如下是一个拦截器记录日志的例子
import com.alibaba.fastjson.JSON;
import lombok.extern.log4j.Log4j2;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.time.Clock;
@Log4j2
public class ApiInterceptor implements HandlerInterceptor {
@Value("${interceptor.startTime}")
private String startTime = "start-time";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
if (handler instanceof HandlerMethod) {
HandlerMethod handlerMethod = (HandlerMethod) handler;
log.info("访问方法: {}.{}; 参数:{}", handlerMethod.getBean().getClass().getName(), handlerMethod.getMethod().getName(), JSON.toJSON(request.getParameterMap()));
Long startMills = Clock.systemDefaultZone().millis();
request.setAttribute(startTime, startMills);
}
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
Object startTimeMills = request.getAttribute(startTime);
if (null != startTimeMills) {
if (log.isInfoEnabled()) {
log.info("url : {}, 执行花费时间(毫秒) : {}", request.getRequestURL(), Clock.systemDefaultZone().millis() - Long.parseLong(startTimeMills.toString()));
}
request.removeAttribute(startTime);
}
}
}
3.拦截器配置类
拦截器配置类继承WebMvcConfigurationSupport类,并重写其addInterceptors方法,如下:
import com.baozun.chenda.interceptor.ApiInterceptor;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
@SpringBootConfiguration
public class CustomerWebMVCConfig extends WebMvcConfigurationSupport {
@Override
public void addInterceptors(InterceptorRegistry registry){
super.addInterceptors(registry);
registry.addInterceptor(new ApiInterceptor());
}
}
运行你的spring boot ,访问相应的方法,输出控制台会有进入跟退出相应方法的日志。