---
title: "java.servlet.Filter的应用"
author: "java_lk"
date: "2008-08-21T14:16:54Z"
tags: []
slug: "java-servlet-filter"
draft: false
lastmod: "2008-08-21T14:16:54Z"
id: 231166
url: "https://java-lk.iteye.com/blog/231166"
---

http://www.qqread.com/java/2008/05/c412172.html

Filter 技术是servlet 2.3 新增加的功能.servlet2.3是sun公司与2000年10月发布的,它的开发者包括许多个人和公司团体,充分体现了sun公司所倡导的代码开放性原则.由于众多的参与者的共同努力,servlet2.3比以往功能都强大了许多,而且性能也有了大幅提高.
        它新增加的功能包括:
        1. 应用程序生命周期事件控制;
        2. 新的国际化;
        3. 澄清了类的装载规则;
        4. 新的错误及安全属性;
        5. 不赞成使用HttpUtils 类;
        6. 各种有用的方法;
        7. 阐明并扩展了几个servlet DTD;
        8. filter功能.
        其中最重要的就是filter功能.它使用户可以改变一个request和修改一个response. Filter 不是一个servlet,它不能产生一个response,它能够在一个request到达servlet之前预处理request,也可以在离开servlet时处理response.换种说法,filter其实是一个”servlet chaining”(servlet 链).一个filter 包括:
        1. 在servlet被调用之前截获;
        2. 在servlet被调用之前检查servlet request;
        3. 根据需要修改request头和request数据;
        4. 根据需要修改response头和response数据;
        5. 在servlet被调用之后截获.
        你能够配置一个filter 到一个或多个servlet;单个servlet或servlet组能够被多个filter 使用.几个实用的filter 包括:用户辨认filter,日志filter,审核filter,加密filter,符号filter,能改变xml内容的XSLT filter等.
        一个filter必须实现javax.servlet.Filter接口并定义三个方法:
        1.void setFilterConfig(FilterConfig config) //设置filter 的配置对象;
        2. FilterConfig getFilterConfig() //返回filter的配置对象;
        3. void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) //执行filter 的工作.
        服务器每次只调用setFilterConfig方法一次准备filter 的处理;调用doFilter方法多次以处理不同的请求.FilterConfig接口有方法可以找到filter名字及初始化参数信息.服务器可以设置FilterConfig为空来指明filter已经终结.
        每一个filter从doFilter()方法中得到当前的request及response.在这个方法里,可以进行任何的针对request及response的操作.(包括收集数据,包装数据等).filter调用chain.doFilter()方法把控制权交给下一个filter.一个filter在doFilter()方法中结束.如果一个filter想停止request处理而获得对response的完全的控制,那它可以不调用下一个filter.
        一个filter可以包装request 或response以改变几个方法和提供用户定制的属性.Api2.3提供了HttpServletRequestWrapper 和HttpServletResponseWrapper来实现.它们能分派最初的request和response.如果要改变一个方法的特性,必须继承wapper和重写方法.下面是一段简单的日志filter用来记录所有request的持续时间.


```java


public class LogFilter implements Filter { 
FilterConfig config; 

public void setFilterConfig(FilterConfig config) { 
this.config = config; 
} 

public FilterConfig getFilterConfig() { 
return config; 
} 

public void doFilter(ServletRequest req, 
ServletResponse res, 
FilterChain chain) { 
ServletContext context = getFilterConfig().getServletContext(); 
long bef = system.currentTimeMillis(); 
chain.doFilter(req, res); // no chain parameter needed here 
long aft = system.currentTimeMillis(); 
context.log("Request to " + req.getRequestURI() 
+ ": " + (aft-bef)); 
} 
} 


```

  

          当server调用setFilterConfig(),filter保存config信息.在doFilter()方法中通过config信息得到servletContext.如果要运行这个filter,必须去配置到web.xml中.以tomcat4.01为例:

    log //filter 名字

    LogFilter //filter class(上例的servlet)
 
    log
    servletname

    servletname
    servletclass

    servletname
    *

    把这个web.xml放到web-inf中(详请参考tomcat帮助文档).
    当每次请求一个request时(如index.jsp),先到LogFilter中去并调用doFilter()方法,然后才到各自的servlet中去.如果是一个简单的servlet(只是一个页面,无任何输出语句),那么可能的输出是:
    Request to /index.jsp: 10
 
    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不同，后文会提到）。其匹配规则和顺序如下：
    1. 精确路径匹配。例子：比如servletA 的url-pattern为 /test，servletB的url-pattern为 /* ，这个时候，如果我访问的url为http://localhost/test ，这个时候容器就会先 进行精确路径匹配，发现/test正好被servletA精确匹配，那么就去调用servletA，也不会去理会其他的servlet了。
    2. 最长路径匹配。例子：servletA的url-pattern为/test/*，而servletB的url-pattern为/test/a/*，此时访问http://localhost/test/a时，容器会选择路径最长的servlet来匹配，也就是这里的servletB。
    3. 扩展匹配，如果url最后一段包含扩展，容器将会根据扩展选择合适的servlet。例子：servletA的url-pattern：*.action
    4. 如果前面三条规则都没有找到一个servlet，容器会根据url选择对应的请求资源。如果应用定义了一个default servlet，则容器会将请求丢给default servlet（什么是default servlet？后面会讲）。
    根据这个规则表，就能很清楚的知道servlet的匹配过程，所以定义servlet的时候也要考虑url-pattern的写法，以免出错。
    对于filter，不会像servlet那样只匹配一个servlet，因为filter的集合是一个链，所以只会有处理的顺序不同，而不会出现只选择一个filter。Filter的处理顺序和filter-mapping在web.xml中定义的顺序相同。
    二，url-pattern详解
    在web.xml文件中，以下语法用于定义映射：
    以”/’开头和以”/*”结尾的是用来做路径映射的。
    以前缀”*.”开头的是用来做扩展映射的。
    “/” 是用来定义default servlet映射的。
    剩下的都是用来定义详细映射的。比如： /aa/bb/cc.action
    所以，为什么定义”/*.action”这样一个看起来很正常的匹配会错？因为这个匹配即属于路径映射，也属于扩展映射，导致容器无法判断。
    Filter过滤器的使用
    本篇文章是介绍javax.servlet包中Filter的几个功能,一是字符编码过滤,二是拦截指文件夹中的文件,实现登录验证.实现以上两个功能需以下几个步骤:
    1、实现javax.servlet.Filter接口，编写两个类，如下：



```java

/** 
* 作用：过滤编码 
*/ 
package filter; 
import java.io.IOException; 
import javax.servlet.*; 
import javax.servlet.http.HttpServletRequest; 
public class EncodingFilter implements Filter 
{ 
protected FilterConfig filterConfig; 
private String targetEncoding; 
public EncodingFilter() 
{ 
targetEncoding = "gb2312";//直接初始化0912 
} 
public void init(FilterConfig filterconfig) throws ServletException 
{ 
filterConfig = filterconfig; 
//targetEncoding = filterconfig.getInitParameter("encoding");//web.xml挂参初始化 
} 
public void doFilter(ServletRequest servletrequest, ServletResponse servletresponse, FilterChain filterchain) 
throws IOException, ServletException 
{ 
HttpServletRequest httpservletrequest = (HttpServletRequest)servletrequest; 
httpservletrequest.setCharacterEncoding(targetEncoding); 
system.out.println("使用" targetEncoding "对请求进行编码过滤"); 
filterchain.doFilter(servletrequest, servletresponse); 
} 
public void setFilterConfig(FilterConfig filterconfig) 
{ 
filterConfig = filterconfig; 
} 
public void destroy() 
{ 
filterConfig = null; 
} 
} 
/** 
* 作用：过滤外界非法的进入页面 
* 注意：使用该功能时，一定要把登录页与被过滤文件夹设为同级，否则会出现循环 
*/ 
package filter; 
import java.io.IOException; 
import javax.servlet.*; 
import javax.servlet.http.*; 
public class ManageFilter implements Filter 
{ 
String LOGIN_PAGE; 
protected FilterConfig filterConfig; 
public ManageFilter() 
{ 
LOGIN_PAGE = "/login.jsp"; 
} 
public void doFilter(ServletRequest servletrequest, ServletResponse servletresponse, FilterChain filterchain) 
throws IOException, ServletException 
{ 
HttpServletRequest request = (HttpServletRequest) servletrequest; 
HttpServletResponse response = (HttpServletResponse) servletresponse; 
HttpSession session = request.getSession(); 
String key = ""; 
try 
{ 
//通过验证时在session中存的一个标志 
key = (String) session.getAttribute("key"); 

if (key!= null&&key.equals("ok")) 
{ 

filterchain.doFilter(servletrequest, servletresponse); 
} 
else 
{ 
response.sendRedirect(LOGIN_PAGE); 
system.out.println("被拦截一个未认证的请求"); 
} 
} 
catch (Exception exception) 
{ 
exception.printStackTrace(); 
} 
} 
public void setFilterConfig(FilterConfig filterconfig) 
{ 
filterConfig = filterconfig; 
} 
public void destroy() 
{ 
filterConfig = null; 
} 
public void init(FilterConfig filterconfig) 
throws ServletException 
{ 
filterConfig = filterconfig; 
} 
} 


```

  

2、在web.xml中做一些设置 

code 
filter.EncodingFilter 

manage 
filter.ManageFilter 

code 
/* 

manage 
<!-- <url-pattern>/ShuiBaoRHPWK_NEW/system/ruhepaiwukou/*</url-pattern>--> 
/servlets-examples/*