在Spring Boot中,HandlerInterceptor
是一个强大的工具,用于拦截HTTP请求和响应。它允许你在请求处理的不同阶段执行自定义逻辑,例如在请求到达控制器之前或响应发送到客户端之前。
步骤1: 创建自定义拦截器
首先,你需要创建一个实现了 HandlerInterceptor
接口的类。这个接口有三个方法:
preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
: 在请求处理之前调用(Controller方法调用之前)。postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
: 在请求处理之后但在视图渲染之前调用(Controller方法调用之后)。afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
: 在整个请求结束之后调用,即在视图渲染之后。
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 在请求处理之前进行调用(Controller方法调用之前)
System.out.println("Pre Handle method is Calling");
return true; // 如果返回false,则不会继续执行后续的Interceptor和Controller
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
// 在请求处理之后但在视图渲染之前调用(Controller方法调用之后)
System.out.println("Post Handle method is Calling");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
// 在整个请求结束之后调用,即在视图渲染之后
System.out.println("Request and Response is completed");
}
}
步骤2: 注册拦截器
接下来,你需要将你的拦截器注册到Spring MVC的拦截器链中。这可以通过实现 WebMvcConfigurer
接口并重写 addInterceptors
方法来完成。
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**"); // 对所有路径应用拦截器
}
}
在这个配置类中,我们通过 addInterceptors
方法添加了我们的自定义拦截器,并通过 addPathPatterns
方法指定了拦截器应该应用于哪些URL模式。
步骤3: 测试拦截器
现在,当你启动Spring Boot应用并访问任何URL时,你应该能在控制台看到由拦截器打印的消息。这表明拦截器已经成功地被触发并执行了相应的方法。
总结
使用 HandlerInterceptor
可以有效地管理HTTP请求和响应的处理流程,为应用提供额外的灵活性和控制力。通过实现 HandlerInterceptor
接口并注册到Spring MVC的拦截器链中,你可以在请求处理的不同阶段插入自定义逻辑,从而满足特定的业务需求。