Filter过滤器的介绍.

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已经终结.

========================================================
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文件中,以下语法用于定义映射:

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

=======================================================
Filter过滤器的使用
本篇文章是介绍javax.servlet包中Filter的几个功能,一是字符编码过滤,二是拦截指文件夹中的文件,实现登录验证.实现以上两个功能需以下几个步骤:
1、实现javax.servlet.Filter接口,编写两个类,如下:

/** 

 * 作用:过滤编码 

 */ 

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中做一些设置 

 <filter> 

 <filter-name>code</filter-name> 

 <filter-class>filter.EncodingFilter</filter-class> 

</filter> 


 <filter> 

 <filter-name>manage</filter-name> 

 <filter-class>filter.ManageFilter</filter-class> 

 </filter> 


 <filter-mapping> 

 <filter-name>code</filter-name> 

 <url-pattern>/*</url-pattern> 

 </filter-mapping> 


 <filter-mapping> 

 <filter-name>manage</filter-name> 

 <url-pattern>/servlets-examples/*</url-pattern> 

</filter-mapping>



-------------------------------------------------------------
1、自己的应用:对参数进行全局过滤

package com.renren.wap.fuxi.filter;

import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

/**
 * Servlet Filter implementation class CommonParamsFilter
 */
public class CommonParamsFilter implements Filter {

    /**
     * @see Filter#destroy()
     */
    public void destroy() {
        // TODO Auto-generated method stub
    }

    /**
     * @see Filter#doFilter(ServletRequest, ServletResponse, FilterChain)
     */
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        String osStr = request.getParameter("os");
        String osVersionStr = request.getParameter("os_version");
        String appIdStr = request.getParameter("appid");
        String touchStr = request.getParameter("touch");
        try {
            int os = Integer.valueOf(osStr);
            request.setAttribute("os", os);
            request.setAttribute("sos", "&os=" + os);

        } catch (Exception e) {}
        if (osVersionStr != null) {
            request.setAttribute("osVersion", osVersionStr);
            request.setAttribute("sosVersion", "&os_version=" + osVersionStr);
        }
        if (appIdStr != null) {
            int appId = Integer.valueOf(appIdStr);
            request.setAttribute("appId", appId);
            request.setAttribute("sappId", "&appid=" + appIdStr);
        }
        if (touchStr != null) {
            request.setAttribute("touch", touchStr);
            request.setAttribute("stouch", "&touch=" + touchStr);
        }
        chain.doFilter(request, response);
    }

    /**
     * @see Filter#init(FilterConfig)
     */
    public void init(FilterConfig fConfig) throws ServletException {
        // TODO Auto-generated method stub
    }

}





2、applicationContext-filter.xml的配置


<bean id="appFilters" class="org.springframework.security.util.FilterChainProxy">
		<security:filter-chain-map path-type="ant">
			<security:filter-chain filters="characterEncodingFilter,commonParamsFilter"
				pattern="/**" />
		</security:filter-chain-map>
	</bean>

	<bean id="characterEncodingFilter" class="org.springframework.web.filter.CharacterEncodingFilter">
		<property name="encoding" value="UTF-8" />
		<property name="forceEncoding" value="true" />
	</bean>
	<bean id="commonParamsFilter" class="com.renren.wap.fuxi.filter.CommonParamsFilter" />




3、web.xml



<!-- 所有filter,委托给spring -->
	<filter>
		<filter-name>appFilters</filter-name>
		<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
		<init-param>
			<param-name>targetFilterLifecycle</param-name>
			<param-value>true</param-value>
		</init-param>
	</filter>
	<filter-mapping>
		<filter-name>appFilters</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>