【回炉重造系列】之简介过滤器Filter初始化以及web.xml配置

Filter过滤器：

过滤器是处于客户端与服务器资源文件之间的一道过滤网，在访问资源文件之前，通过一系列的过滤器对请求进行修改、判断等，把不符合规则的请求在中途拦截或修改。也可以对响应进行过滤，拦截或修改响应。

如图，浏览器发出的请求先递交给第一个filter进行过滤，符合规则则放行，递交给filter链中的下一个过滤器进行过滤。过滤器在链中的顺序与它在web.xml中配置的顺序有关，配置在前的则位于链的前端。当请求通过了链中所有过滤器后就可以访问资源文件了，如果不能通过，则可能在中间某个过滤器中被处理掉。

在doFilter()方法中，chain.doFilter()前的一般是对request执行的过滤操作，chain.doFilter后面的代码一般是对response执行的操作。过滤链代码的执行顺序如下：

Filter1:

public class FilterTest01 extends OncePerRequestFilter{

@Override
protected void doFilterInternal(HttpServletRequest httpServletReq,
    HttpServletResponse httpServletResp, FilterChain filterChain)
            throws ServletException, IOException {
    System.out.println("...filter1开始了....doFilterInternal...");
    filterChain.doFilter(httpServletReq,httpServletResp );
    System.out.println("...filter1结束了....doFilterInternal....");    
    }
}

Filter2:

public class FilterTest02 extends OncePerRequestFilter{

@Override
protected void doFilterInternal(HttpServletRequest httpServletReq,
    HttpServletResponse httpServletResp, FilterChain filterChain)
            throws ServletException, IOException {
    System.out.println("...filter2开始了....doFilterInternal...");
    filterChain.doFilter(httpServletReq,httpServletResp );
    System.out.println("...filter2结束了....doFilterInternal....");    
    }
}

web.xml

   <filter>
     <filter-name>filter01filter-name>
     <filter-class>com.edu.dcx.filters.FilterTest01filter-class>
     filter>
    <filter-mapping>
     <filter-name>filter01filter-name>
     <url-pattern>/*url-pattern>
     filter-mapping>
           <filter>
     <filter-name>filter02filter-name>
     <filter-class>com.edu.dcx.filters.FilterTest02filter-class>
  filter>
  <filter-mapping>
     <filter-name>filter02filter-name>
     <url-pattern>/*url-pattern>
     filter-mapping>

执行结果：

...filter1开始了....doFilterInternal...
...filter2开始了....doFilterInternal...
...filter2结束了....doFilterInternal....
...filter1结束了....doFilterInternal....

如果调换Filter过滤器的定义顺序，

web.xml

 <filter-name>filter02filter-name>
     <filter-class>com.edu.dcx.filters.FilterTest02filter-class>
  filter>
  <filter-mapping>
     <filter-name>filter02filter-name>
     <url-pattern>/*url-pattern>
     filter-mapping>
   <filter>
     <filter-name>filter01filter-name>
     <filter-class>com.edu.dcx.filters.FilterTest01filter-class>
   filter>
  <filter-mapping>
     <filter-name>filter01filter-name>
     <url-pattern>/*url-pattern>
     filter-mapping>

运行结果：

...filter2开始了....doFilterInternal...
...filter1开始了....doFilterInternal...
...filter1结束了....doFilterInternal....
...filter2结束了....doFilterInternal....

可见，过滤器执行的顺序与定义的顺序使有关的。

网上看到文章说：拦截器可以多次调用，而过滤器只能在容器初始化时调用一次。

似乎是有些不准确，应该是在对于满足拦截条件的时候调用一次，用代码说话：

在Controller层配置两个跳转：

@RequestMapping(value = "/home", method = RequestMethod.GET)
    public String home(Locale locale, Model model) {
        return "home";
    }
    @RequestMapping(value="/hello",method=RequestMethod.GET)
    public String hello(){
        return "hello";
    }

web.xml：

<filter>
     <filter-name>filter01filter-name>
     <filter-class>com.edu.dcx.filters.FilterTest01filter-class>
  filter>
   <filter-mapping>
     <filter-name>filter01filter-name>
      
     <url-pattern>/*url-pattern>
     filter-mapping>
        <filter>
     <filter-name>filter02filter-name>
     <filter-class>com.edu.dcx.filters.FilterTest02filter-class>
   filter>
  <filter-mapping>
     <filter-name>filter02filter-name>
     
     <url-pattern>/*url-pattern>
     filter-mapping>

Servlet初始化的时候，会调用一次：

INFO : org.springframework.web.servlet.DispatcherServlet - FrameworkServlet 'appServlet': initialization started
........此处省略
INFO : org.springframework.web.servlet.DispatcherServlet - FrameworkServlet 'appServlet': initialization completed in 769 ms
........此处省略
...filter1开始了....doFilterInternal...
...filter2开始了....doFilterInternal...
...filter2结束了....doFilterInternal....
...filter1结束了....doFilterInternal....

再执行：
http://localhost:8080/dcx/test/home与http://localhost:8080/dcx/test/hello

执行结果：

...filter1开始了....doFilterInternal...
...filter2开始了....doFilterInternal...
...filter2结束了....doFilterInternal....
...filter1结束了....doFilterInternal....
...filter1开始了....doFilterInternal...
...filter2开始了....doFilterInternal...
...filter2结束了....doFilterInternal....
...filter1结束了....doFilterInternal....

目前得到的结果表明，过滤器不只在servlet容器初始化的时候执行一次

再尝试不同的过滤器对不同的请求进行过滤：

web.xml：

<filter>
    <filter-name>filter01filter-name>
    <filter-class>com.edu.dcx.filters.FilterTest01filter-class>
filter>
<filter-mapping>
    <filter-name>filter01filter-name>
        
    <url-pattern>/*url-pattern>
filter-mapping>
<filter>
    <filter-name>filter02filter-name>
    <filter-class>com.edu.dcx.filters.FilterTest02filter-class>
filter>
    <filter-mapping>
        <filter-name>filter02filter-name>
        
        <url-pattern>/test/hellourl-pattern>
    filter-mapping>

Servlet初始化，因为只有Filter1对所有请求进行过滤，所以执行了Filter1

...filter1开始了....doFilterInternal...
...filter1结束了....doFilterInternal....

执行：http://localhost:8080/dcx/test/hello
因为filter1对于所有请求都进行过滤，所以出filter1，而filter2对/test/hello进行过滤，所以出现filter2

...filter1开始了....doFilterInternal...
...filter2开始了....doFilterInternal...
...filter2结束了....doFilterInternal....
...filter1结束了....doFilterInternal....

执行：http://localhost:8080/dcx/test/home
只有filter1对/test/home进行过滤，所以只有filter1

...filter1开始了....doFilterInternal...
...filter1结束了....doFilterInternal....

得出结论：

1. Filter在servlet容器初始化的时候，会执行一次（仅仅是URL符合过滤请求的时候会执行，比如说拦截的是/test/home，那么在启动的时候如果URL是localhost:8080/dcx/test并不会执行过滤器）。
2. 当URL符合过滤器的过滤规则时，过滤器会执行一次，比如过滤器的配置的是/test/home,那么当URL地址为localhost:8080/dcx/test/home时就会执行一次。

---

二、web.xml配置

WEB工程加载顺序与元素节点在文件中的配置顺序无关。即不会因为 filter 写在 listener 的前面而会先加载 filter。WEB容器的加载顺序是：ServletContext -> context-param -> listener -> filter -> servlet。并且这些元素可以配置在文件中的任意位置。
加载过程顺序如下：

1. 启动一个WEB项目的时候，WEB容器会去读取它的配置文件web.xml，读取和两个结点。
2. 紧接着，容创建一个ServletContext（servlet上下文），这个web项目的所有部分都将共享这个上下文。
3. 容器将转换为键值对，并交给servletContext。

4. 容器创建中的类实例，创建监听器。

   1、schema

   　web.xml的模式文件是由Sun公司定义的，每个web.xml文件的根元素中，都必须标明这个 web.xml使用的是哪个模式文件。其它的元素都放在之中。　　

<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

2、Web应用图标

　　指出IDE和GUI工具用来表示Web应用的大图标和小图标。

<icon>
    <small-icon>/images/app_small.gifsmall-icon>
    <large-icon>/images/app_large.giflarge-icon>
icon>

3、Web应用名称

　　提供GUI工具可能会用来标记这个特定的Web应用的一个名称

<display-name>Tomcat Exampledisplay-name>

4、Web应用描述

　　给出于此相关的说明性文本

<disciption>Tomcat Example servlets and JSP pages.disciption>

5、欢迎文件页

file-list>
    file>index.jspfile>
    file>index.htmlfile>
    file>index.htmfile>
file-list>

6、上下文参数

　　声明应用范围内的初始化参数。它用于向 ServletContext提供键值对，即应用程序上下文信息。我们的listener, filter等在初始化时会用到这些上下文中的信息。在servlet里面可以getServletContext().getInitParameter("contextConfigLocation")得到值“/WEB-INF/spring/root-context.xml”

jsp页面：

<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ page session="false" %>
<html>
<%
String context = this.getServletContext().getInitParameter("contextConfigLocation");
%> 
<head>
    <title>Hometitle>
head>
<body>
<h1>
    Hello world!  
h1>
<p><%=context %>P>
body>
html>

页面显示：

param>
    <param-name>contextConfigLocationparam-name>
    <param-value>/WEB-INF/spring/root-context.xmlparam-value>
    It is a test parameter.
param>

7、过滤器

　　将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。
具体实例，可参加本文的上文。值得注意的是，同样的过滤规则，执行的顺序是按照定义的顺序执行的。

<filter>
        <filter-name>filter02filter-name>
        <filter-class>com.edu.dcx.filters.FilterTest02filter-class>
    filter>
    <filter-mapping>
        <filter-name>filter02filter-name>
        <url-pattern>/*url-pattern>
    filter-mapping>
    <filter>
        <filter-name>filter01filter-name>
        <filter-class>com.edu.dcx.filters.FilterTest01filter-class>
    filter>
    <filter-mapping>
        <filter-name>filter01filter-name>
        <url-pattern>/*url-pattern>
    filter-mapping>
filter>

8、监听器

1）web监听器是一种Servlet中的特殊的类，它们能帮助开发者监听web中的特定事件，比如ServletContext,HttpSession,ServletRequest的创建和销毁；变量的创建、销毁和修改等。可以在某些动作前后增加处理，实现监控。

2 ）监听器常用的用途

• 统计在线人数，利用HttpSessionLisener
• 加载初始化信息：利用ServletContextListener
• 统计网站访问量
• 实现访问监控

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class>
listener>

9、

用来声明一个servlet的数据，主要有以下子元素：
1). 指定servlet的名称
2). 指定servlet的类名称
3). 指定web站台中的某个JSP网页的完整路径
4). 用来定义参数，可有多个init-param。在servlet类中通过getInitParamenter(String name)方法访问初始化参数
5). 指定当Web应用启动时，装载Servlet的次序。当值为正数或零时：Servlet容器先加载数值小的servlet，再依次加载其他数值大的servlet。当值为负或未定义：Servlet容器将在Web客户首次访问这个servlet时加载它。
6). 用来定义servlet所对应的URL，包含两个子元素
7). 指定servlet的名称
8). 指定servlet所对应的URL

<servlet>
    <servlet-name>snoopservlet-name>
    <servlet-class>SnoopServletservlet-class>
servlet>
<servlet-mapping>
    <servlet-name>snoopservlet-name>
    <url-pattern>/snoopurl-pattern>
servlet-mapping>

<servlet>
    <servlet-name>snoopservlet-name>
    <servlet-class>SnoopServletservlet-class>
    <init-param>
        <param-name>fooparam-name>
        <param-value>barparam-value>
    init-param>
    <run-as>
        <description>Security role for anonymous accessdescription>
        <role-name>tomcatrole-name>
    run-as>
servlet>
<servlet-mapping>
    <servlet-name>snoopservlet-name>
    <url-pattern>/snoopurl-pattern>
servlet-mapping>

10、会话超时配置

　　单位为分钟。

<session-config>
    <session-timeout>120session-timeout>
session-config>

11、
用来指定对应的格式的浏览器处理方式，可参考：http://yeminping.iteye.com/blog/482795

<mime-mapping>
    <extension>htmextension>
    <mime-type>text/htmlmime-type>
mime-mapping>

12、错误页面

<error-page>
    <error-code>404error-code>
    <location>/NotFound.jsplocation>
error-page>

<error-page>
    <exception-type>java.lang.NullExceptionexception-type>
    <location>/error.jsplocation>
error-page>

13、设置jsp
包括 和 两个子元素。其中 元素在JSP 1.2 时就已经存在；而 是JSP 2.0 新增的元素。
元素主要有八个子元素，它们分别为：
：设定的说明
：设定名称
：设定值所影响的范围，如： /CH2 或 /*.jsp
：若为 true，表示不支持 EL 语法
：若为 true，表示不支持 <% scripting %>语法
：设定 JSP 网页的编码
：设置 JSP 网页的抬头，扩展名为 .jspf
：设置 JSP 网页的结尾，扩展名为 .jspf

<jsp-config>
    <taglib>
        <taglib-uri>Taglibtaglib-uri>
        <taglib-location>/WEB-INF/tlds/MyTaglib.tldtaglib-location>
    taglib>
    <jsp-property-group>
        <description>Special property group for JSP Configuration JSP example.description>
        <display-name>JSPConfigurationdisplay-name>
        <url-pattern>/jsp/* url-pattern>
        <el-ignored>trueel-ignored>
        <page-encoding>GB2312page-encoding>
        <scripting-invalid>truescripting-invalid>
        <include-prelude>/include/prelude.jspfinclude-prelude>
        <include-coda>/include/coda.jspfinclude-coda>
    jsp-property-group>
jsp-config>

---

三、Mapping规则

当一个请求发送到servlet容器的时候，容器先会将请求的url减去当前应用上下文的路径作为servlet的映射url，比如我访问的是http://localhost/test/aaa.html，我的应用上下文是test，容器会将http://localhost/test去掉，剩下的/aaa.html部分拿来做servlet的映射匹配。这个映射匹配过程是有顺序的，而且当有一个servlet匹配成功以后，就不会去理会剩下的servlet了。

其匹配规则和顺序如下：

精确路径匹配。例子：比如servletA 的url-pattern为 /test，servletB的url-pattern为 /* ，这个时候，如果我访问的url为http://localhost/test ，这个时候容器就会先 进行精确路径匹配，发现/test正好被servletA精确匹配，那么就去调用servletA，也不会去理会其他的servlet了。
最长路径匹配。例子：servletA的url-pattern为/test/*，而servletB的url-pattern为/test/a/*，此时访问http://localhost/test/a时，容器会选择路径最长的servlet来匹配，也就是这里的servletB。
扩展匹配，如果url最后一段包含扩展，容器将会根据扩展选择合适的servlet。例子：servletA的url-pattern：*.action

以"/"开头和以"/*"结尾的是用来做路径映射的。以前缀"*."开头的是用来做扩展映射的。所以，为什么定义"/*.action"这样一个看起来很正常的匹配会错？因为这个匹配即属于路径映射，也属于扩展映射，导致容器无法判断。

参考：
https://www.cnblogs.com/ygj0930/p/6374212.html
https://www.cnblogs.com/huangwentian/p/6417792.html
https://www.cnblogs.com/hellojava/archive/2012/12/28/2835730.html
https://www.cnblogs.com/w-wfy/p/6425357.html
https://blog.csdn.net/xiaoyaotan_111/article/details/53817918
https://blog.csdn.net/maoyeqiu/article/details/44453983