SpringBoot过滤器使用
最近SpringBoot项目中用到过滤器(Filter)和拦截器，发现网上的资料有很多不能够正确运行，就自己整理写了一个过滤器测试一下。
一 SpringBoot使用过滤器
SpringBoot使用过滤器有两种方式：
1、使用spring boot提供的FilterRegistrationBean注册Filter
2、使用原生servlet注解定义Filter
两种方式的本质都是一样的，都是去FilterRegistrationBean注册自定义Filter
二使用SpringBoot配置类实现:
2.1定义一个Filte类
public class MyFilter implements Filter{
@Override public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("您已经进入过滤器");
// 打印请求信息
HttpServletRequest request = (HttpServletRequest) servletRequest;
System.out.println ("------------- LogFilter 开始 -------------");
System.out.println ("请求地址: {} {}", request.getRequestURL().toString(), request.getMethod());
System.out.println ("远程地址: {}", request.getRemoteAddr());
long startTime = System.currentTimeMillis();
System.out.println ("------------- LogFilter 结束 耗时：{} ms -------------", System.currentTimeMillis() - startTime);
filterChain.doFilter(servletRequest,servletResponse);
}
@Override public void destroy() {
}
}
2.2注册自定义MyFilter
@Configuration //定义此类为配置类,必须增加
public class FilterConfig {
@Bean
public FilterRegistrationBean myFilterRegistrationBean(){
FilterRegistrationBean filterRegistrationBean=new FilterRegistrationBean(new MyFilter());
//添加过滤器路径
filterRegistrationBean.addUrlPatterns("/user/*");
filterRegistrationBean.addUrlPatterns("/login/*");
return filterRegistrationBean;
}
}
2.3定义一个控制器Controller进行验证
@Controller
public class HomeController {
@RequestMapping("/login")
public String login(){
return "login";
}
@RequestMapping("/index")
public String index(){
return "index";
}
}
运行程序，验证结果。
三使用注解方式实现:
3.1定义一个过滤器类Filter
在类的上方使用 @WebFilter 注解来创建Filter即可
//过滤器
@WebFilter(urlPatterns = "/myfilter")
@Component
public class MyFilter implements Filter {
@Override public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("您已经进入过滤器");
filterChain.doFilter(servletRequest,servletResponse);
}
@Override public void destroy() {
}
}
}
3.2 在启动类上面增加注解@ServletComponentScan
扫描filter包中的注解，然后运行程序进行测试。
@SpringBootApplication
@MapperScan("com.example.demo.mapper")
@ServletComponentScan(basePackages
= "com.example.demo.Filter")
public class DemoApplication {
SpringApplication.run(DemoApplication.class, args);
}
注:这里直接用@WebFilter就可以进行配置，同样，可以设置url匹配模式，过滤器名称等。这里需要注意一点的是@WebFilter这个注解是Servlet3.0的规范，并不是Spring boot提供的。除了这个注解以外，我们需在启动类中加注解：@ServletComponetScan，指定扫描的包。
