JavaWeb笔记——三大组件之过滤器

过滤器JavaWeb三大组件之一，它与Servlet很相似！不它过滤器是用来拦截请求的，而不是处理请求的。
 当用户请求某个Servlet时，会先执行部署在这个请求上的Filter，如果Filter“放行”，那么会继承执行用户请求的Servlet；如果Filter不“放行”，那么就不会执行用户请求的Servlet。
 其实可以这样理解，当用户请求某个Servlet时，Tomcat会去执行注册在这个请求上的Filter，然后是否“放行”由Filter来决定。可以理解为，Filter来决定是否调用Servlet！当执行完成Servlet的代码后，还会执行Filter后面的代码。

 

使用过滤器需自定义类实现Filter接口，并在web.xml配置<filter>和<filter-mapping>标签，web.xml示例如下：

<filter>
     <filter-name>AFilter</filter-name>

    <filter-class>com.pwc.web.filter.AFilter</filter-class>

</filter>

<filter-mapping>

    <filter-name>AFilter</filter-name>

    <url-pattern>/*</url-pattern>

</filter-mapping> 

 
=============================================

 
1　过滤器的生命周期
 

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

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

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

 
---------------------------------- 

2　FilterConfig

Filter接口中的init()方法的参数类型为FilterConfig类型。它的功能与ServletConfig相似，与web.xml文件中的配置信息对应。下面是FilterConfig的功能介绍：

l  ServletContext getServletContext()：获取ServletContext的方法。

l  String getFilterName()：获取Filter的配置名称；与<filter-name>元素对应。

l  String getInitParameter(String name)：获取Filter的初始化配置，与<init-param>元素对应。

l  Enumeration getInitParameterNames()：获取所有初始化参数的名称。

---------------------------------- 

3　FilterChain

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

前面我们说doFilter()方法的放行，让请求流访问目标资源！但这么说不严密，其实调用该方法的意思是，“我（当前Filter）”放行了，但不代表其他人（其他过滤器）也放行。

也就是说，一个目标资源上，可能部署了多个过滤器，就好比在你去北京的路上有多个打劫的匪人（过滤器），而其中第一伙匪人放行了，但不代表第二伙匪人也放行了，所以调用FilterChain类的doFilter()方法表示的是执行下一个过滤器的doFilter()方法，或者是执行目标资源！

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

 
----------------------------------  

4　多个过滤器执行顺序

<filter-mapping>的配置顺序决定了过滤器的执行顺序
 

----------------------------------  

5　四种拦截方式

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

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

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

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

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

 

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

---------------------------------- 

6　过滤器的应用场景

过滤器的应用场景：

l  执行目标资源之前做预处理工作，例如设置编码，这种试通常都会放行，只是在目标资源执行之前做一些准备工作；

l  通过条件判断是否放行，例如校验当前用户是否已经登录，或者用户IP是否已经被禁用；

l  在目标资源执行后，做一些后续的特殊处理工作，例如把目标资源输出的数据进行处理；

 
---------------------------------- 

7　设置目标资源

在web.xml文件中部署Filter时，可以通过“*”来执行目标资源：

<filter-mapping>        <filter-name>myfilter</filter-name>        <url-pattern>/*</url-pattern>     </filter-mapping>

 

这一特性与Servlet完全相同！通过这一特性，我们可以在用户访问敏感资源时，执行过滤器，例如：<url-pattern>/admin/*<url-pattern>，可以把所有管理员才能访问的资源放到/admin路径下，这时可以通过过滤器来校验用户身份。

还可以为<filter-mapping>指定目标资源为某个Servlet，例如：

<servlet>        <servlet-name>myservlet</servlet-name>        <servlet-class>cn.itcast.servlet.MyServlet</servlet-class>     </servlet>     <servlet-mapping>        <servlet-name>myservlet</servlet-name>        <url-pattern>/abc</url-pattern>     </servlet-mapping>     <filter>        <filter-name>myfilter</filter-name>        <filter-class>cn.itcast.filter.MyFilter</filter-class>     </filter>     <filter-mapping>        <filter-name>myfilter</filter-name>        <servlet-name>myservlet</servlet-name>     </filter-mapping>

 

当用户访问http://localhost:8080/filtertest/abc时，会执行名字为myservlet的Servlet，这时会执行过滤器。

 
---------------------------------- 

8　Filter小结

Filter的三个方法：

l  void init(FilterConfig)：在Tomcat启动时被调用；

l  void destroy()：在Tomcat关闭时被调用；

l  void doFilter(ServletRequest,ServletResponse,FilterChain)：每次有请求时都调用该方法；

 

FilterConfig类：与ServletConfig相似，用来获取Filter的初始化参数

l  ServletContext getServletContext()：获取ServletContext的方法；

l  String getFilterName()：获取Filter的配置名称；

l  String getInitParameter(String name)：获取Filter的初始化配置，与<init-param>元素对应；

l  Enumeration getInitParameterNames()：获取所有初始化参数的名称。

 

FilterChain类：

l  void doFilter(ServletRequest,ServletResponse)：放行！表示执行下一个过滤器，或者执行目标资源。可以在调用FilterChain的doFilter()方法的前后添加语句，在FilterChain的doFilter()方法之前的语句会在目标资源执行之前执行，在FilterChain的doFilter()方法之后的语句会在目标资源执行之后执行。

 

四各拦截方式：REQUEST、FORWARD、INCLUDE、ERROR，默认是REQUEST方式。

l  REQUEST：拦截直接请求方式；

l  FORWARD：拦截请求转发方式；

l  INCLUDE：拦截请求包含方式；

l  ERROR：拦截错误转发方式。