Servlet Filter 1

1、Filter简介

）Filter也称之为过滤器，它是Servlet技术中最实用的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

）Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，如下所示：

2、Filter是如何实现拦截的？

Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源(拦截url)进行拦截后，WEB服务器每次在调用web资源之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：

调用目标资源之前，让一段代码执行

是否调用目标资源（即是否让用户访问web资源）。

web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

调用目标资源之后，让一段代码执行

3、Filter开发入门

）Filter开发分为二个步骤：

编写java类实现Filter接口，并实现(三个方法)其doFilter方法。

在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。

）Filter链 ---

在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。

个filter，如果没有，则调用目标资源。

Filter链实验（查看filterChain API文档）

4、Filter的生命周期

）init(FilterConfig filterConfig)throws ServletException：

和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法进行初始化（注：filter对象只会创建一次，init方法也只会执行一次。示例 ）

开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

）doFilter(ServletRequest,ServletResponse,FilterChain)

每次filter进行拦截都会执行

在实际开发中方法中参数request和response通常转换为HttpServletRequest和HttpServletResponse类型进行操作

）destroy()：

在Web容器卸载 Filter 对象之前被调用。

package com.itheima.filter;

import java.io.IOException;

import java.util.Enumeration;

import javax.servlet.Filter;

import javax.servlet.FilterChain;

import javax.servlet.FilterConfig;

import javax.servlet.ServletException;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

import com.sun.net.httpserver.Filter.Chain;

public class Filter1 implements Filter {

public Filter1() {

System.out.println("Filter被创建出来了。。。");

}

public void destroy() {

System.out.println("destory......");

}

public void doFilter(ServletRequest request, ServletResponse response,

FilterChain chain) throws IOException, ServletException {

System.out.println("dofilter....");

chain.doFilter(request, response);

}

public void init(FilterConfig filterConfig) throws ServletException {

System.out.println("init.....");

String value1 = filterConfig.getInitParameter("param1");

System.out.println(value1);

Enumeration enumeration =filterConfig.getInitParameterNames();

while(enumeration.hasMoreElements()){

String name = (String) enumeration.nextElement();

String value = filterConfig.getInitParameter(name);

System.out.println(name+":"+value);

}

filterConfig.getServletContext();

}

}

5、FilterConfig接口

（1）用户在配置filter时，可以使用<init-param>为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig对象的方法，就可获得：

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

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

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

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

）FilterConfig 提供参数，是Filter类私有参数，Filter2的初始化参数，不能在Filter1 中进行获取

） 配置全局参数，<context-param> 进行配置，通过ServletContext 获得

）实验：得到filter配置信息

6、注册Filter

<filter>

<filter-name>testFitler</filter-name>

<filter-class>org.test.TestFiter</filter-class>

<init-param>

<param-name>word_file</param-name>

<param-value>/WEB-INF/word.txt</param-value>

</init-param>

</filter>

<filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。

<filter-class>元素用于指定过滤器的完整的限定类名。

<init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。

7、映射Filter

<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径

）<filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字

）<url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)

）<servlet-name>指定过滤器所拦截的Servlet名称。

）<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。

）<filter-mapping> 过滤器拦截配置

如果连接目标资源是一个Servlet，可以选择url和servlet名称两种配置方式

<!-- 拦截/hello是Servlet 路径 -->

<url-pattern>/hello</url-pattern>

<!-- 拦截Servlet 还可以通过Servlet 名称进行拦截 -->

<servlet-name>HelloServlet</servlet-name>

）url-pattern 和 Servlet中路径写法一样，有三种 ： 完全匹配、目录匹配、扩展名匹配

）<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式

容器调用服务器端资源 有四种方式

REQUEST、FORWARD、INCLUDE、ERROR

8、映射Filter的多种方式

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

REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。

INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。

FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。

ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用

9、映射Filter示例

<filter-mapping>

<filter-name>testFilter</filter-name>

<url-pattern>/test.jsp</url-pattern>

</filter-mapping>

<filter-mapping>

<filter-name>testFilter</filter-name>

<url-pattern>/index.jsp</url-pattern>

<dispatcher>REQUEST</dispatcher>

<dispatcher>FORWARD</dispatcher>

</filter-mapping>