javaweb Filter详解

1. Servlet过滤器的概念

Servlet过滤器是在Java Servlet规范2.3中定义的，它能够对Servlet容器的请求和响应对象进行检查和修改

Servlet过滤器本身并不生成请求和响应对象，它只提供过滤作用

Servlet过滤器能够在Servlet被调用之前检查Request对象，修改Request Header和Request内容

在Servlet被调用之后检查Response对象，修改Response Header和Response内容。Servlet过滤器负责过滤的web组件可以是Servlet、jsp、 html文件

2. Servlet过滤器的过滤过程

servlet过滤器的过滤过程.png

3. Filter接口描述

所有的servlet过滤器类都必须实现javax.servlet.filter接口，这个接口含有3个过滤器类必须实现的方法：

init(FilterConfig config)
doFilter(ServletRequest, ServletResponse, FilterChain)
destroy()

其实可以将Filter也看作Servlet，只不过比较特殊，Filter也符合Servlet的生命周期

init(FilterConfig)：这是Servlet过滤器的初始化方法，Servlet容器创建Servlet过滤器实例后将调用这个方法，在这个方法中可以读取web.xml文件中Servlet过滤器的初始化参数

doFilter(ServletRequest, ServletResponse, FilterChain)：这个方法完成实际的过滤操作，当客户请求访问与过滤器关联的URL时，Servlet容器将先调用过滤器的doFilter方法，FilterChain参数用于访问后续过滤器

destroy()：Servlet容器在销毁过滤器实例前调用该方法，在这个方法中可以释放Servlet过滤器应用的资源

4. 过滤器的链式请求处理过程(FilterChain)

过滤器的链式请求处理过程.png

4.1. 代码演示

FilterA具体代码如下：

public class FilterA implements Filter {

    @Override
    public void destroy() {
        System.out.println("FilterA destroy");
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("FilterA before chain code");
        chain.doFilter(req, resp);
        System.out.println("FilterA after chain code");
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
        System.out.println("FilterA init");
    }

}

FilterB具体代码如下：

public class FilterB implements Filter {

    @Override
    public void destroy() {

        System.out.println("FilterB destroy"); 
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("FilterB before chain code");
        chain.doFilter(req, resp);
        System.out.println("FilterB after chain code");
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
        System.out.println("FilterB init");
    }

}

MyServlet具体代码如下：

public class MyServlet extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        
        request.getRequestDispatcher("/index.jsp").forward(request, response);

       
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }

}

JSP具体代码如下：

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
  </head>
  
  <body>
    hello world
  </body>
</html>

web.xml中的Filter配置如下：

  <filter>
    <filter-name>FilterA</filter-name>
    <filter-class>com.pro.test.filter.FilterA</filter-class>
  </filter>
  
  <filter>
    <filter-name>FilterB</filter-name>
    <filter-class>com.pro.test.filter.FilterB</filter-class>
  </filter>
  

  
  <filter-mapping>
    <filter-name>FilterA</filter-name>
    <url-pattern>/MyServlet</url-pattern>
  </filter-mapping>
  
    
  <filter-mapping>
    <filter-name>FilterB</filter-name>
    <url-pattern>/MyServlet</url-pattern>
  </filter-mapping>

当客户端发送请求/MyServlet后，控制台输出如下：

FilterA before chain code
FilterB before chain code
FilterB after chain code
FilterA after chain code

5. Fitler的特点（重要）

Filter可以看作是一个非常特殊的Servlet，在容器启动的时候就会被初始化，并且init方法就会被调用
Filter还有一个特点，如果web应用启动的时候某个Filter实例化失败了，那么整个web应用就没法启动了，例如某个Filter中的init方法执行抛异常了

struts本身就是使用Filter来启动的，利用了Filter自启动的特性，所以一定要保证Filter中的init方法的代码正确，Filter不像Servlet需要用户访问的时才实例化，即使某个Servlet抛异常了也不影响其他Servlet，但过滤器不是这样，如果有一个过滤器启动失败了，那么整个web应用就无法被访问了，所以一定要保证过滤器代码的正确性。

多个Filter过滤同一个组件的时候，按xml中filter-mapping配置的顺序进行顺序过滤。

6. 练习题

问题一：在Servlet过滤器中能否访问application范围内的共享数据？

答案：可以的，先调用FilterConfig的getServletContext方法获得ServletContext再调用ServletContext的getAttribute方法来获取application范围内的共享数据

问题二：servlet过滤器只能对Servlet进行过滤？

答案：不正确。servlet过滤器可以对servlet、jsp和html文件进行过滤

7. 总结

Filter在java web中的重要性仅次于jsp与servlet，很多框架都使用了Filter，所以掌握好Filter原理对于java web开发还是很关键的。

javaweb Filter详解