【JavaWeb学习】过滤器Filter

时间：2017-01-31 23:33:40 阅读：384 评论：0 收藏：0 [点我收藏+]

标签：ams request 元素使用 pattern 启动 -name image param

一、简介

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

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

技术分享

Filter是如何实现拦截的？

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

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

二、Filter开发入门

1、编写java类实现Filter接口，并实现其doFilter方法。

 1 public class FilterDemo1 implements Filter{
 2     @Override
 3     public void init(FilterConfig arg0) throws ServletException {    
 4         System.out.println("Filter Init...");
 5     }
 6     @Override
 7     public void doFilter(ServletRequest req, ServletResponse resp,
 8             FilterChain chain) throws IOException, ServletException {
 9         //调用目标资源前
10         System.out.println("doFiliter之前 ...");
11         //调用目标资源
12         chain.doFilter(req, resp);
13         //调用目标资源后
14         System.out.println("doFiliter之后 ...");
15     }
16     @Override
17     public void destroy() {
18         System.out.println("Filter destroy...");
19     }
20 }

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

<filter>
    <filter-name>FilterDemo1</filter-name>
    <filter-class>cn.qust.web.filter.demo.FilterDemo1</filter-class>
</filter>
<filter-mapping>
    <filter-name>FilterDemo1</filter-name>
    <url-pattern>/index.jsp</url-pattern>
</filter-mapping>

　　Filter链：在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

　　如下面的filter注册顺序，FilterDemo2和FilterDemo1内容基本一致。

 1 <filter>
 2     <filter-name>FilterDemo1</filter-name>
 3     <filter-class>cn.qust.web.filter.demo.FilterDemo1</filter-class>
 4 </filter>
 5 <filter-mapping>
 6     <filter-name>FilterDemo1</filter-name>
 7     <url-pattern>/index.jsp</url-pattern>
 8 </filter-mapping>
 9 <filter>
10     <filter-name>FilterDemo2</filter-name>
11     <filter-class>cn.qust.web.filter.demo.FilterDemo2</filter-class>
12 </filter>
13 <filter-mapping>
14     <filter-name>FilterDemo2</filter-name>
15     <url-pattern>/*</url-pattern>
16 </filter-mapping>

当访问index.jsp页面的时候，结果如下

技术分享

三、Filter的生命周期

init(FilterConfig filterConfig) throws ServletException：

和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（注：filter对象只会创建一次，init方法也只会执行一次。示例）

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

destroy()：

在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

四、FilterConfig

　　用户在配置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上下文对象的引用。

 1 public class FilterDemo2 implements Filter{
 2     @Override
 3     public void init(FilterConfig config) throws ServletException {
 4         String filterName = config.getFilterName();
 5         System.out.println(filterName + " Init params : ");
 6         //获取初始配置参数
 7         Enumeration<String> initParameterNames = config.getInitParameterNames();
 8         while(initParameterNames.hasMoreElements()){
 9             String name = initParameterNames.nextElement();
10             String value = config.getInitParameter(name);
11             System.out.println(name + ":" + value);
12         }
13     }
14     
15     @Override
16     public void doFilter(ServletRequest req, ServletResponse resp,
17             FilterChain chain) throws IOException, ServletException {
18         System.out.println("FilterDemo2 doFiliter2之前 ...");
19         chain.doFilter(req, resp);
20         System.out.println("FilterDemo2 doFiliter2之后 ...");
21     }
22     @Override
23     public void destroy() {
24         System.out.println("FilterDemo2 destroy...");
25     }
26 
27 }

在web.xml注册filter的时候配置好参数：

<filter>
    <filter-name>FilterDemo2</filter-name>
    <filter-class>cn.qust.web.filter.demo.FilterDemo2</filter-class>
    <init-param>
        <param-name>description</param-name>
        <param-value>filter过滤器的初始配置参数</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>FilterDemo2</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>