JSP&Servlet学习笔记(7): 过滤器

转 作者 贺含悦 | 发表于 | 分类于 2016级

过滤器概述

什么是过滤器

过滤器JavaWeb三大组件之一，它与Servlet很相似！不过滤器是用来拦截请求的，而不是处理请求的。

当用户请求某个Servlet时，会先执行部署在这个请求上的Filter，如果Filter“放行”，那么会继承执行用户请求的Servlet；如果Filter不“放行”，那么就不会执行用户请求的Servlet。

其实可以这样理解，当用户请求某个Servlet时，Tomcat会去执行注册在这个请求上的Filter，然后是否“放行”由Filter来决定。可以理解为，Filter来决定是否调用Servlet！当执行完成Servlet的代码后，还会执行Filter后面的代码。

过滤器hello world

其实过滤器与Servlet很相似，写一个类，实现Servlet接口！没错，写过滤器就是写一个类，实现Filter接口。

public class HelloFilter implements Filter {

    public void init(FilterConfig filterConfig) throws ServletException {}
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("Hello Filter");
    }
    public void destroy() {}
}

第二步也与Servlet一样，在web.xml文件中部署Filter：

<filter>
    <filter-name>helloFilter</filter-name>
    <filter-class>cn.cloud.filter.HelloFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>helloFilter</filter-name>
    <url-pattern>/index.jsp</url-pattern>
</filter-mapping>

可以访问index.jsp页面了，当用户访问index.jsp页面时，会执行HelloFilter的doFilter()方法！在我们的示例中，index.jsp页面是不会被执行的，如果想执行index.jsp页面，那么我们需要放行！

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
    System.out.println("filter start...");
    chain.doFilter(request, response);
    System.out.println("filter end...");
}

有很多错误的认为，一个请求在给客户端输出之后就算是结束了，这是不对的！其实很多事情都需要在给客户端响应之后才能完成！

过滤器详细

过滤器的生命周期

  • init(FilterConfig)：在服务器启动时会创建Filter实例，并且每个类型的Filter只创建一个实例，从此不再创建！在创建完Filter实例后，会马上调用init()方法完成初始化工作，这个方法只会被执行一次；

  • doFilter(ServletRequest req,ServletResponseres,FilterChain chain)：这个方法会在用户每次访问“目标资源（<url->pattern>index.jsp</url-pattern>）”时执行，如果需要“放行”，那么需要调用FilterChain的doFilter(ServletRequest,ServletResponse)方法；

  • destroy()：服务器会在创建Filter对象之后，把Filter放到缓存中一直使用，通常不会销毁它。一般会在服务器关闭时销毁Filter对象，在销毁Filter对象之前，服务器会调用Filter对象的destory()方法。

FilterConfig

你已经看到了吧，Filter接口中的init()方法的参数类型为FilterConfig类型。它的功能与ServletConfig相似，与web.xml文件中的配置信息对应。下面是FilterConfig的功能介绍：
ServletContext getServletContext()：获取ServletContext的方法；
String getFilterName()：获取Filter的配置名称；与< filter-name>元素对应；
String getInitParameter(String name)：获取Filter的初始化配置，与< init-param>元素对应；
Enumeration getInitParameterNames()：获取所有初始化参数的名称。

FilterChain

doFilter()方法的参数中有一个类型为FilterChain的参数，它只有一个方法：doFilter(ServletRequest,ServletResponse)。

doFilter()方法的放行，让请求流访问目标资源！其实调用该方法的意思是，当前Filter放行了，但不代表其他过滤器也放行。一个目标资源上，可能部署了多个过滤器，所以调用FilterChain类的doFilter()方法表示的是执行下一个过滤器的doFilter()方法，或者是执行目标资源！

如果当前过滤器是最后一个过滤器，那么调用chain.doFilter()方法表示执行目标资源，而不是最后一个过滤器，那么chain.doFilter()表示执行下一个过滤器的doFilter()方法。

多个过滤器执行顺序

一个目标资源可以指定多个过滤器，过滤器的执行顺序是在web.xml文件中的部署顺序。

四种拦截方式

写一个过滤器，指定过滤的资源为b.jsp，然后在浏览器中直接访问b.jsp，会发现过滤器执行了.但是，当在a.jsp中request.getRequestDispathcer(“/b.jsp”).forward(request,response)时，就不会再执行过滤器了！也就是说，默认情况下，只能直接访问目标资源才会执行过滤器，而forward执行目标资源，不会执行过滤器！
http://localhost:8080/filtertest/b.jsp–>直接访问b.jsp时，会执行过滤器内容；
http://localhost:8080/filtertest/a.jsp–> 访问a.jsp，但a.jsp会forward到b.jsp，这时就不会执行过滤器！

过滤器有四种拦截方式！分别是：REQUEST、FORWARD、INCLUDE、ERROR。

  • REQUEST：直接访问目标资源时执行过滤器。包括：在地址栏中直接访问、表单提交、超链接、重定向，只要在地址栏中可以看到目标资源的路径，就是REQUEST；

  • FORWARD：转发访问执行过滤器。包括RequestDispatcher#forward()方法、< jsp:forward>标签都是转发访问；

  • INCLUDE：包含访问执行过滤器。包括RequestDispatcher#include()方法、< jsp:include>标签都是包含访问；

  • ERROR：当目标资源在web.xml中配置为< error-page>中时，并且真的出现了异常，转发到目标资源时，会执行过滤器。

可以在< filter-mapping>中添加0~n个< dispatcher>子元素，来说明当前访问的拦截方式。

<filter-mapping>
       <filter-name>myfilter</filter-name>
       <url-pattern>/b.jsp</url-pattern>
       <dispatcher>REQUEST</dispatcher>
       <dispatcher>FORWARD</dispatcher>
</filter-mapping>
<filter-mapping>
       <filter-name>myfilter</filter-name>
       <url-pattern>/b.jsp</url-pattern>
</filter-mapping>
<filter-mapping>
       <filter-name>myfilter</filter-name>
       <url-pattern>/b.jsp</url-pattern>
       <dispatcher>FORWARD</dispatcher>
</filter-mapping>

最为常用的就是REQUEST和FORWARD两种拦截方式，而INCLUDE和ERROR都比较少用！其中INCLUDE比较好理解，ERROR方式不易理解，下面给出ERROR拦截方式的例子：

<filter-mapping>
       <filter-name>myfilter</filter-name>
       <url-pattern>/b.jsp</url-pattern>
       <dispatcher>ERROR</dispatcher>
</filter-mapping>
<error-page>
       <error-code>500</error-code>
       <location>/b.jsp</location>
</error-page>
<body>
<h1>a.jsp</h1>
<%
   if(true)
       throw new RuntimeException("嘻嘻~");
%>
</body>

过滤器的应用场景

  • 执行目标资源之前做预处理工作，例如设置编码，这种试通常都会放行，只是在目标资源执行之前做一些准备工作；
  • 通过条件判断是否放行，例如校验当前用户是否已经登录，或者用户IP是否已经被禁用；
  • 在目标资源执行后，做一些后续的特殊处理工作，例如把目标资源输出的数据进行处理；