在Spring Boot中,可以通过实现HandlerInterceptor
接口来实现拦截器。
以下是一个简单的示例:
@Component
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//在请求处理之前进行调用(Controller方法调用之前)
System.out.println("请求路径:" + request.getRequestURI());
return true; //如果返回false,请求将会被拦截
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
//请求处理之后进行调用,但是在视图被渲染之前(Controller方法调用之后)
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
//在整个请求结束之后被调用,也就是在DispatcherServlet 渲染了对应的视图之后执行(主要是用于清理资源等工作)
}
}
在上述代码中,MyInterceptor
类实现了HandlerInterceptor
接口,并重写了其中的preHandle
、postHandle
和afterCompletion
方法,分别表示在请求处理之前、请求处理之后和整个请求结束之后的操作。
方法的详解
返回值类型 | 方法声明 | 描述 |
Boolean | public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) | 该方法在控制器处理请求方法前执行,其返回值表示是否中断后续操作,返回true表示继续向下执行,返回false表示中断后续操作 |
void | public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) | 该方法在控制器处理请求方法调用之后,解析视图之前执行,可以通过此方法对请求域中的模型和视图做进一步修改 |
void | public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) | 该方法在视图渲染结束后执行,可以通过此方法实现资源清理,记录日志信息等工作。 |
最后,通过将MyInterceptor
类注入到Spring Boot中,即可实现拦截器功能。例如,在Spring Boot的WebMvcConfigurer
配置类中,通过addInterceptors
方法添加拦截器:
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Autowired
private MyInterceptor myInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(myInterceptor).addPathPatterns("/**");
}
}
在上述代码中,通过addInterceptors
方法添加了MyInterceptor
拦截器,并指定了拦截的请求路径。
addPathPatterns:该方法用于指定拦截路径,例如拦截路径为“/**”,表示拦截所有请求,包括对静态资源的请求。
excludePathPatterns:该方法用于排除拦截路径,即指定不需要被拦截器拦截的请求。