从零开始学习Servlet(4)Servlet Filter

Servlet过滤器

• Servlet过滤器（Filter）是一个实现了 javax.servlet.Filter 接口的 Java 类
• Filter通过动态的拦截请求和响应，使用或者转换后使用其中的信息。
• Filter和Servlet可以是多对一，也可以是一对多。Filter的集合是一个链，不会像servlet那样只匹配一个servlet，Filter只会有处理的顺序不同，而不会出现只选择一个Filter。
• Filter可以在JSP和HTML文件中，调用Servlet前调用这些Filter。

过滤器的目的：

• 在客户端请求访问后端资源前，拦截这些请求，做处理。
• 在服务器处理信息，响应发送回客户端之前，处理这些响应。

Filter通过web.xml中XML标签来声明，映射到应用程序的Servlet或者URL模式。当Web服务器启动Web应用程序时，会为web.xml中声明的每一个Filter创建一个实例。Filter的执行顺序与在web.xml中的顺序一致，一般Filter配置在所有Servlet之前。

过滤器的类型：

名称	英文名称
身份验证过滤器	（Authentication Filters）
数据压缩过滤器	（Data compression Filters）
加密过滤器	（Encryption Filters）
触发资源访问事件过滤器
图像转换过滤器	（Image Conversion Filters）
日志记录和审核过滤器	（Logging and Auditing Filters）
MIME-TYPE 链过滤器	（MIME-TYPE Chain Filters）
标记化过滤器	（Tokenizing Filters）
XSL/T 过滤器	（XSL/T Filters），转换 XML 内容

Servlet过滤器实现的javax.servlet.Filter中有三个方法：

方法	描述
public void doFilter (ServletRequest, ServletResponse, FilterChain)	该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。
public void init(FilterConfig filterConfig)	web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。
public void destroy()	Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。

在web.xml中配置如下：初始化的数据可以通过FilterConfig对象获取

<filter>
    <filter-name>TestFilter</filter-name>
    <filter-class>com.test.filter.TestFilter</filter-class>
    <init-param>
        <param-name>Site</param-name>
        <param-value>TestFilte></param-value>
    </init-param>
</filter>

web.xml配置各节点说明

< filter>指定一个过滤器。
< filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。
< filter-class>元素用于指定过滤器的完整的限定类名。
< init-param>元素用于为过滤器指定初始化参数，它的子元素指定参数的名字，< param-value>指定参数的值。
< filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
< filter-name>子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字
< url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)
< servlet-name>指定过滤器所拦截的Servlet名称。
< dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个子元素用来指定 Filter 对资源的多种调用方式进行拦截。

< dispatcher>子元素可以设置的值及其意义：

• REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
• INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
• FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
• ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。

Servlet和Filter的url匹配以及url-pattern详解:

servlet容器对url的匹配过程：

• 当一个请求发送到servlet容器的时候，容器先会将请求的url减去当前应用上下文的路径作为servlet的映射url，比如我访问的是http://localhost/test/aaa.html，我的应用上下文是test，容器会将http://localhost/test去掉，剩下的/aaa.html部分拿来做servlet的映射匹配。这个映射匹配过程是有顺序的，而且当有一个servlet匹配成功以后，就不会去理会剩下的servlet了（filter不同，后文会提到）。其匹配规则和顺序如下：
• 精确路径匹配。例子：比如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
• 如果前面三条规则都没有找到一个servlet，容器会根据url选择对应的请求资源。如果应用定义了一个default servlet，则容器会将请求丢给default servlet（什么是default servlet？后面会讲）。

url-pattern详解

在web.xml文件中，以下语法用于定义映射：

• 以”/’开头和以”/*”结尾的是用来做路径映射的。
• 以前缀”*.”开头的是用来做扩展映射的。
• “/” 是用来定义default servlet映射的。
• 剩下的都是用来定义详细映射的。比如： /aa/bb/cc.action
• 所以，为什么定义”/*.action”这样一个看起来很正常的匹配会错？因为这个匹配即属于路径映射，也属于扩展映射，导致容器无法判断。

FilterConfig的使用：

在init(FilterConfig filterConfig)方法中，使用FilterConfig对象获取参数.
public void init(FilterConfig config)thorws ServletException{
//获取初始化参数
String site = config.getInitParamter(“Site”);
}

Filter中处理request和response

过滤器中我们可以根据 doFilte() 方法中的 request 对象获取表单参数信息，例如我们可以获取到请求的用户名和密码进行逻辑处理，也可以通过 response 对用户做出回应。比如如果验证用户名不正确，禁止用户访问 web 资源，并且向浏览器输出提示，告诉用户用户名或者密码不正确等等；

    if(trueName.equals(name)){
            // 把请求传回过滤链
            chain.doFilter(request, response);
        }else{
            //设置返回内容类型
            response.setContentType("text/html;charset=GBK");
            //在页面输出响应信息
            PrintWriter out = response.getWriter();
            out.print("<b>name不正确，请求被拦截，不能访问web资源</b>");
            System.out.println("name不正确，请求被拦截，不能访问web资源");
        }

本文参考菜鸟教程http://www.runoob.com