Java web 过滤器

    以前做servlet程序时，基本上都要解决字符编码问题，很是麻烦。 以前做项目时，也发现多个Servlet之间转发容易产生问题。 比如，显示访问计数，我把它单独写成了一个Servlet，什么地方需要它时，便由那个Servlet.include引用计数的Servlet。但这样总会产生一些问题和使用上的不便。比如include的Servlet必须使用相同的流，如果使用forward后任何输出都无效了。 之后就查了一下资料，就提到了过滤器。不过那时还没学过滤器，在这后的也听到老师讲字符编码的时候也提到了过滤器。 那时我便对过滤器产生了兴趣，今日也终于一睹芳容！让人十分喜欢！
     ServletFilter，Servlet过滤器： 

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

ServletAPI提供了一个Filter接口，实现这个接口的Servlet就是一个过虑器。 过虑器在WEB应用访问流程图
       

由图可见，只要我们编写了过滤器，可以对一切访问WEB应用的连接进行过滤。比如，用户访问权限、统一WEB编码… 

Filter是如何实现拦截的？ 

实现了Filter接口的Servlet是过滤器，因为Filter接口有一个doFilter(ServletRequest request, ServletResponse response, FilterChain chain)方法，只要用户访问我们在web.xml中配置的映射目录，服务器便会调用过滤器的doFilter方法。我们在这里实现过虑功能代码，当我们调用chain.doFilter(request, response);方法时，将请求反给服务器服务器再去调用相当的Servlet。如果我们不调用此方法，说明拒绝了用户的请求。 

Filter开发入门： 

在WEB应用中添加一个过滤器，有两步工作需要完成： 

1.编写实现了Filter接口的Servlet——过滤器。 

2.在web.xml中配置过滤器： 

(1). <filter>标签添加器 

(2). <filter-mapping>注册过滤器的映射目录（过滤目录），与注册Servlet一样。 

在实际WEB应用中，我们可能需要编写多个过虑器，组成过滤链。比如：1.统一WEB编码的过滤器（过虑所有访问）2.用户访问权限管理。这样，用户的访问需要选经过过滤器1过滤然后再经过过滤器2过滤。doFilter中有一个FilterChain参数，这个参数是服务器根据web.xml中配置的过滤器，按照先后顺序生成的过滤器链。当我们在doFilter方法中调用chain.doFilter(request, response);方法时，服务器会查找 过滤链中是否还有过滤器，如果有继续调用下一个过滤器，如果没有将调用相应的Servlet处理用户请求。 

过滤器生命周期的四个阶段：

1、实例化：Web容器在部署Web应用程序时对所有过滤器进行实例化。Web容器回调它的无参构造方法。2、初始化：实例化完成之后，马上进行初始化工作。Web容器回调init()方法。

3、过滤：请求路径匹配过滤器的URL映射时。Web容器回调doFilter()方法——主要的工作方法。

4 、销毁：  Web 容器在卸载 Web 应用程序前， Web 容器回调 destroy() 方法。  

Filter接口的其他细节： 

1.Filter的Init(FilterConfig filterConfig)方法： 

与Servlet的Init方法一样，在创建时被调用，之后被保存在内存中直至服务器重启或关闭时Filter实例才会被销毁。与Servlet不同之处在于，服务器启动时就会实例化所有Filter，而Servlet中有当用户第一次访问它时才会被实例化。我们通过在web.xml使用<init-param>对Filter配置的初始化参数，可以通过FilterConfig来获得。 

FilterConfig的方法有： 

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

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

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

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

2.Filter的destroy()方法： 

当服务器重启或关闭时，在销毁Filter之前调用此方法。 

编写配置Filter练习程序： 

1. 编写一个用于统一WEB字符编码的Filter： 

package cn.demo.servlet;

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; 
import javax.servlet.http.HttpServletRequest; 
import javax.servlet.http.HttpServletResponse; 
public class Encoding implements Filter { 
public void destroy() { 
// TODO Auto-generated method stub 
} 
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
//设置request和response使用的编码均为UTF-8。 
request.setCharacterEncoding("UTF-8"); 
response.setCharacterEncoding("UTF-8"); 
response.setContentType("text/html;charset=UTF-8"); 
//设置完成后，交回给服务器
chain.doFilter(request, response);
}
public void init(FilterConfig request) throws ServletException { 
// TODO Auto-generated method stub 
} 
}  

2. 配置web.xml文件，添加下面部分： 

<display-name>EncodingFilter</display-name>
    <filter-name>EncodingFilter</filter-name>
    <filter-class>cn.demo.servlet.EncodingFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>EncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

3. 上面是Filter的简单使用方式，后面会讲到高级应用。

我们已经知道了request和response是服务器给我们封装好了的两个Http请求对象。我们对它进行了功能上的扩充。如果我们不知道request和response是谁创建的具体内容是什么，我们应该如何对它们的功能进行扩充？我们有两种方式可以扩充： 

1. 编写一个子类，覆盖需要覆盖的方法。 

2. 使用Decorator设计模式，来扩充我们想要的功能。 

Decorator设计模式： 

我们有时无法使用方法1,因为我们不知道一个对象的具休类，比如它是一个接口对象，实现类是谁？。所以我们最好使用方法2，之前我们有接触过工厂设计模式和单例设计模式，Java真是高级应用的完美体现。什么是Decorator设计模式？中文名称是“装饰”模式，下面我们使用此模式为request做一下功能上的扩充： 

1.我们实现继承request接口类型ServletRequest。哦天哪，ServletRequest有太多的方法，难道我们要实现每一个方法？Servlet设计者们想到了这一点，并给我们提供了一个包装类——HttpServletRequestWrapper。我们就使用它做为父类吧！ 

2.在我们自定义类内部添加一个HttpServletRequest类型成员，因为我们就要装饰它。 

3.编写我样想覆盖的方法，也就是我们想提供特殊功能的方法。 

举例，上边我们编写的统一WEB编码的filter是存在问题的，如果我们提交一个表单，表单的提交方式为GET，那么我们设置request的编码是不起作用的。所以在这里我们就使用Decorator设计模式来完善统一编码的功能： 

编写自定义类MyServletRequest.java类： 

class MyServletRequest extends HttpServletRequestWrapper { 
// 要装饰的对象 
HttpServletRequest myrequest; 
public MyServletRequest(HttpServletRequest request) { 
super(request); 
this.myrequest = request; 
} 
// 要增强的功能方法 
@Override 
public String getParameter(String name) { 
// 使用被装饰的成员，获取数据 
String value = this.myrequest.getParameter(name); 
if (value == null) 
return null; 
// 将数据转码后返回 
try { 
value = new String(value.getBytes("ISO8859-1"), "UTF-8"); 
} catch (UnsupportedEncodingException e) { 
e.printStackTrace(); 
} 
return value; 
} 
} 

修改EncodingFilter.java过滤器的代码如下：

public class EncodingFilter implements Filter { 
public void destroy() { 
// TODO Auto-generated method stub 
} 
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { 
chain.doFilter(new MyServletRequest((HttpServletRequest)request), response); 
} 
public void init(FilterConfig request) throws ServletException { 
// TODO Auto-generated method stub 
} 
}  

呵呵，看到Decorator设计模式的强大了吧！这一部分属于Filter的高级应用。 我原本并没想到这么多，以为request和response已经足够用了，即使够用，但效率和代码还不够优美，加上这些高级应用变得比较优美，程序和编写和维护都十分方便！