前言
最近在做一个基于springboot的项目,顺便总结一下springboot项目中的过滤器、拦截器和以前项目的区别。
一、过滤器
1.SpringBoot中使用过滤器不需要在web.xml中配置filter,只需要添加注解@WebFilter同时实现Filter接口
import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import org.springframework.stereotype.Component;
@Component
@WebFilter(urlPatterns = "/*", filterName = "test")
public class TestFilter implements Filter {
@Override
public void init(FilterConfig arg0) throws ServletException {
System.out.println("过滤器初始化");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
throws IOException, ServletException {
System.out.printf("过滤器实现");
System.out.println(((HttpServletRequest) servletRequest).getRequestURI());
filterChain.doFilter(servletRequest, servletResponse);
}
@Override
public void destroy() {
System.out.println("过滤器销毁了");
}
}
复制代码
启动项目后查看日志:
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'characterEncodingFilter' to: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'httpPutFormContentFilter' to: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'requestContextFilter' to: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'webStatFilter' to urls: [/*]
INFO 6780 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'testFilter' to: [/*]
过滤器初始化
复制代码
可以看到过滤器已经被初始化了,接下来再访问一下
日志:过滤器实现/test
复制代码
说明过滤器已经正常执行(刚开始发现被调用了两次,第二次url打印的是/favicon.ico,这是浏览器在请求网站图标)
二、拦截器
首先创建拦截器MyInterceptor实现HandlerInterceptor
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**
* 拦截器
*/
public class MyInterceptor implements HandlerInterceptor{
//在请求处理之前进行调用(Controller方法调用之前
@Override
public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse
httpServletResponse, Object o) throws Exception {
System.out.println("preHandle被调用");
System.out.println("实现拦截器");
return true;
}
//请求处理之后进行调用,但是在视图被渲染之前(Controller方法调用之后)
@Override
public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse
httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
System.out.println("postHandle被调用");
}
//在整个请求结束之后被调用,也就是在DispatcherServlet
渲染了对应的视图之后执行
@Override
public void afterCompletion(HttpServletRequest httpServletRequest,
HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
System.out.println("afterCompletion被调用");
}
}
复制代码
然后创建一个配置类,用于注册拦截器
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
/**
* 注册拦截器
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**").
excludePathPatterns("/a.do");
}
}
复制代码
addPathPatterns和excludePathPatterns可以分别指定要拦截的请求和排除的请求,参数也可以是一个List<string>
好了,访问一下
可以看出过滤器和拦截器都正常执行了
需要注意的是,不同于过滤器,拦截器是spring的组件,不依赖servlet容器,且只有通过DispatcherServlet的请求才能被拦截。所以,过滤器只能用于web程序,而拦截器还可以用于普通java应用。
拦截器可以访问spring管理的对象以及资源,能方便的调用service对象等,所以web应用中优先考虑拦截器。