javaWeb之过滤器Filter

过滤器（Filter）简介

过滤器是对web资源进行拦截，做一些处理后再交给下一个过滤器或Servlet处理，主要可以拦截request和response

过滤器是以一种组件的形式与web程序绑定，采用链式进行工作。

过滤器的好处：

可以拦截请求和响应，以便查看或者获取客户端与服务器之间的交互数据，实现过滤的功能。另外过滤器可以动态的添加或删除而不需要修改web程序的逻辑。

过滤器的作用：

过滤器一般用于登录权限验证、资源访问权限控制、敏感词汇过滤、字符编码转换等等操作，便于代码重用，不必每个servlet中还要进行相应的操作。

过滤器是基于函数回调。过滤器依赖与servlet容器。Filter在只在Servlet前后起作用

使用方法有两种：

一、使用@WebFilter注解方式

1、创建类实现Filter接口，添加@WebFilter注解

@WebFilter(filterName = "myFilter",urlPatterns = "/*")
@Order(1)//指定过滤器的执行顺序,值越小，优先级越高
public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化过滤器");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        //在DispatcherServlet之前执行
        System.out.println("添加自定义处理逻辑");
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        System.out.println("销毁过滤器");
    }
}

@WebFilter常用属性

属性	类型	是否必需	说明
asyncSupported	boolean	否	指定Filter是否支持异步模式
dispatcherTypes	DispatcherType[]	否	指定Filter对哪种方式的请求进行过滤。 支持的属性：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST； 默认过滤所有方式的请求
filterName	String	否	Filter名称
initParams	WebInitParam[]	否	配置参数
displayName	String	否	Filter显示名
servletNames	String[]	否	指定对哪些Servlet进行过滤
urlPatterns/value	String[]	否	两个属性作用相同，指定拦截的路径

过滤器的urlPatterns的过滤路径规则：

1.全路径匹配： /abc/myServlet1.do

2.部分路径匹配： /abc/*

3.通配符匹配 ：/*

4.后缀名匹配 ：*.do (注意:前面不加/)

2、启动类添加@ServletComponentScan注解

@SpringBootApplication
@ServletComponentScan//可以自动注册@WebServlet、@WebFilter、@WebListener等注解。
public class DemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.class, args);
	}

}

二、通过FilterRegistrationBean实例注册

1、创建类实现Filter接口

public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化过滤器");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        //在DispatcherServlet之前执行
        System.out.println("添加自定义处理逻辑");
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        System.out.println("销毁过滤器");
    }
}

2、注册FilterRegistrationBean实例添加上自定义的过滤器，设置拦截路径

@SpringBootApplication
public class DemoApplication {

	@Bean(name = "myFilter")
	public FilterRegistrationBean initMyFilter(){
		FilterRegistrationBean bean = new FilterRegistrationBean();
		bean.setFilter(new MyFilter());
		//需要过滤的URL路径
		List<String> urls = new ArrayList<String>();
		urls.add("/*");//过滤所有的路径
		bean.setName("myFilter");//设置名称
		bean.setUrlPatterns(urls);
		bean.setOrder(1);//优先级，最顶级
		return bean;
	}
	@Bean(name = "myFilter2")
	public FilterRegistrationBean initMyFilter2(){
		//第二个过滤器……
	}

	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.class, args);
	}
}