Listener、Filter以及Servlet中的url-pattern

1.Listener

1) 概念以及分类

Listener，监听器，可以实现对ServeltContext生命周期中初始化和销毁的监听，也可以实现对ServletContextAttribute、ServletRequestAttribute等属性变更事件的监听。Listener是基于观察者模式实现的，目前Servlet中定义了6种两类Listener，EvenListenter类型的ServletContextAttributeListener ServletRequestAttributeListener ServletRequestListener HttpSessionAttributeListener 以及基于LifecycleListeners类型的ServletContextListener HttpSessionListener。实际上这6个Listener都继承了EvenListener，并且都定义了各自需要的方法。如下表所示：





上面这些Listener基本涵盖了整个Servlet中你可能感兴趣的每种事情。这些Listener的实现类可以配置在web.xml中的listener标签中；当然也可以在应用程序中动态的添加Listener，需要注意的是ServletContextListener在容器启动之后就不能再添加新的,因为它所监听的事件不会再出现了。

2) Listener应用实例

Spring的org.springframework.web.context.ContextLoaderListener就是实现了ServeltContextListener，用于在容器启动时初始化Spring容器。在ContextLoaderListener中的contextInitialized()方法中，完成Spring容器的初始化，这个方法的参数是ServletContextEvent对象，可以通过这个对象的getServletContext()方法拿到ServletContext；有几种方法可以加载Spring容器，如果在web.xml中配置了名字为contextConfigLocation的context-param则会通过这里面配置xml文件加载Spring容器，如果没有配置，则会到/WEB-INF/下面查找默认的applicationContext.xml文件。

另外一个应用就是在配置Log4jConfigListener,这个Listener也就是继承了ServletContextListener,可以实现在springContext初始化之前设置好log4j的各项配置,便于其它组件输出日志使用.在contextInitialized初始化方法中会读取context-param中配置的”log4jConfigLocation”属性,然后通过其作为log4j配置文件的位置,如果是xml文件则通过Log4j的DOMConfigurator.configure()配置,如果是properties文件则可以通过PropertyConfigurator.configure方法来进行初始化,另外从源码看到,可以通过”log4jRefreshInterval”来配置读取文件的刷新时间.

需要注意的是,如果配置的其它ServletContextListener需要用到log4j输出日志,那么Log4jConfigListener应该作为第一个Listener进行配置.

2.Filter

1）概念

对从客户端向服务器端发送的请求进行过滤，也可以对服务器端返回的响应进行处理。它使用户可以改变一个request和修改一个 response.。Filter 不是一个servlet，它不能产生一个response，但是它能够在一个request到达servlet之前预处理request，也可以在 response离开servlet时处理response。换句话说，filter其实是客户端与servlet中间的一个传递者，并且它可以对要传递 的东西进行修改。



2) 工作流程

当客户端发生请求后，在HttpServletRequest 到达Servlet 之前，过滤器拦截客户的HttpServletRequest 。

根据需要检查HttpServletRequest ，也可以修改HttpServletRequest 头和数据。

在过滤器中调用doFilter方法，对请求放行。请求到达Servlet后，对请求进 行处理并产生HttpServletResponse发送给客户端。

在HttpServletResponse 到达客户端之前,过滤器拦截HttpServletResponse

根据需要检查HttpServletResponse ，可以修改HttpServletResponse 头和数据。

最后，HttpServletResponse到达客户端。

3) 如何实现一个Filter

Servlet API定义了Filter接口，自定义编写的Filter都需要实现这个Filter，准确的来说是实现其中的三个方法。

init(FilterConfig):初始化接口，在用户自定义的Filter初始化时被调用，它与Servelt的init方法的作用是一样的，FilterConfig与ServletConfig也类似，除了能取到ServletContext对象之外，还能获取在filter下配置的init-param参数。

doFilter(ServletRequest,ServletResponse,FilterChain):在每个用户的请求进来时，这个方法都会被调用，并在Servlet的service()方法之前被调用。而这个方法参数中的FilterChain对象代表了当前的整个请求链，所以通过FilterChain.doFilter()可以将请求继续传递下去。如果想拦截这个请求，可以不调用FilterChain.doFilter，那么这个请求就会直接返回了。所以Filter是一种责任链设计模式。

destory:当Filter对象被销毁时，这个方法被调用。注意的是当web容器调用这个方法之后，容器会再调用一次doFilter方法。

下面的代码展示了一个简单Filter的实现：

package com.meituan.lkl.filter;

import javax.servlet.*;
import java.io.IOException;

public class MyFirstFilter implements Filter {

public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("init: " + filterConfig.getServletContext().getInitParameter("test-context-param"));
System.out.println("init: " + filterConfig.getInitParameter("test-param"));
System.out.println("init: " + filterConfig.getFilterName());
System.out.println("MyFirstFilter init");
}

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
String name = request.getParameter("name");
System.out.println("doFilter name=" + name);
chain.doFilter(request, response);
String contextType = response.getContentType();
System.out.println("response:" + contextType);
}

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

这里还需要重点介绍下doFilter()方法中的FilterChain参数。Filter类的核心其实就是这个在Filter之间进行传递的FilterChain对象，在其内部的filters数组中保存了最终到Servlet对象的所有Filter对象。在FilterChain链上每执行一个Filter对象，数组的当前计数都会加1，直到计数等于数组的长度，当FilterChain上所有的Filter对象都执行完成之后，就会执行最终的Servlet。所以在FilterChain对象中也会持有Servelt对象的引用。

另外上面还出现了FilterConfig对象，这个对象代表Filter的配置，它里面封装了ServletContext对象的引用以及在web.xml中配置的一些初始化参数。下面是其对外提供的几个方法：

String getFilterName()：得到filter的名称。

String getInitParameter(String name)： 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.

Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。

ServletContext getServletContext()：返回Servlet上下文对象的引用。

4）web.xml中配置Filter

上面实现了自定义的Filter之后，如果想要真正起到作用，需要在web.xml中配置filter和filter-mapping元素对编写的Filter类进行注册并设置它所能拦截的资源。下面就是一个配置示例：

<filter>
<filter-name>testFilter</filter-name>
<filter-class>com.meituan.lkl.filter.MyFirstFilter</filter-class>
<init-param>
<param-name>test-param</param-name>
<param-value>test-param</param-value>
</init-param>
</filter>

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

5) Filter链

上面在讲FilterChain对象时就已经提到了多个Filter的情况，如果配置一组过滤器对某些web资源进行拦截，那么这组过滤器就称为过滤器链。Filter执行的顺序就是在web.xml中配置他们的顺序。能依次执行的原理参见对FilterChain的解释。



3.Servlet中的url-pattern

在web.xml中的servlet-mapping和filter-mapping都有url-pattern配置项,它们的作用是否执行这个Servlet和Filter.

Filter的url-pattern匹配是在创建FilterChain对象时进行的,它把所有定义的Filter的url-pattern与当前的URL匹配,如果匹配成功就将当前filter保存在filters数组中,然后在FilterChain中依次调用。而Servlet的url匹配是在请求对象创建时进行，创建请求时需要根据请求的url决定哪个Servlet来处理这个请求。

在web.xml加载时，会首先检查url-pattern配置是否符合规则，这个检查是在StandardContext的validateURLPattern方法中检查的，如果检查不成功，Context容器启动会失败，并报java.lang.IllegalArgumentException:Invalidurl-pattern /a.html in Servlet mapping错误。

url-pattern的解析规则，对Servlet和Filter是一样的，匹配的规则有如下三种：

精确匹配：如/foo.html只会匹配foo.html这个URL

路径匹配：如/foo/*会匹配以foo为前缀的URL

后缀匹配：如*.html会匹配所有以.html为后缀的URL

所有像/foo/、/.html和 /foo这些url形式都是错误的。

一个请求可以匹配多个Filter，但是只能匹配Servelt，所以在定义了多个Servelt的情况下，会按次序进行匹配：首先精确匹配，如定义了两个Servlet，Servlet1为/foo.html,Servlet2为/，请求URL为http://localhost/foo.html，那么只会有Servlet1会匹配。如果精确匹配不成功，那么会使用第二个原则”最长路径匹配”，如Servlet1为/foo/,Servlet2为/ *,请求的URL为http://localhost/foo/foo.html，那么Servlet1匹配成功；如果都不行，那么则使用后缀匹配，但一次请求只会成功匹配到一个Servlet。