【JavaWeb学习】过滤器Filter

一、简介

　　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方法。

public class FilterDemo1 implements Filter{
    @Override
    public void init(FilterConfig arg0) throws ServletException {    
        System.out.println("Filter Init...");
    }
    @Override
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        //调用目标资源前
        System.out.println("doFiliter之前 ...");
        //调用目标资源
        chain.doFilter(req, resp);
        //调用目标资源后
        System.out.println("doFiliter之后 ...");
    }
    @Override
    public void destroy() {
        System.out.println("Filter destroy...");
    }
}

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内容基本一致。

<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>
    <filter-name>FilterDemo2</filter-name>
    <filter-class>cn.qust.web.filter.demo.FilterDemo2</filter-class>
</filter>
<filter-mapping>
    <filter-name>FilterDemo2</filter-name>
    <url-pattern>/*</url-pattern>
</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上下文对象的引用。

　　

public class FilterDemo2 implements Filter{
    @Override
    public void init(FilterConfig config) throws ServletException {
        String filterName = config.getFilterName();
        System.out.println(filterName + " Init params : ");
        //获取初始配置参数
        Enumeration<String> initParameterNames = config.getInitParameterNames();
        while(initParameterNames.hasMoreElements()){
            String name = initParameterNames.nextElement();
            String value = config.getInitParameter(name);
            System.out.println(name + ":" + value);
        }
    }
    
    @Override
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("FilterDemo2 doFiliter2之前 ...");
        chain.doFilter(req, resp);
        System.out.println("FilterDemo2 doFiliter2之后 ...");
    }
    @Override
    public void destroy() {
        System.out.println("FilterDemo2 destroy...");
    }

}

在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>
    

在tomcat的启动信息里可以看到打印结果：

五、Filter的常见应用

1、同一全站字符编码

　　思路：通过配置参数encoding指明使用何种字符编码,以处理Html Form请求参数的中文问题

　　1）在Filter实现中对request和response进行编码设置

public class CharacterEncodingFilter implements Filter{

    private FilterConfig config = null;
    private String defaultCharset = "UTF-8";
    
    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        //获取配置信息里的字符编码charset
        String charset = this.config.getInitParameter("charset");
        //如果没有配置字符编码，那么使用默认字符编码
        if(charset==null){
            charset = this.defaultCharset;
        }
        
       17         18         //设置编码    
        request.setCharacterEncoding(charset);
        response.setCharacterEncoding(charset);
        response.setContentType("text/html;charset="+charset);
        
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig config) throws ServletException {
        this.config = config;
    }
    @Override
    public void destroy() {
    }

}

　　2）web.xml注册Filter，并配置参数charset

<!-- 同一全站字符编码过滤器1 --> 
<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>cn.qust.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>charset</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

　　测试

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>表单不同的请求方式</title>
</head>
<body>
    <form action="servlet/ServletDemo1" method="get">
        国家：<input type="text" name="country"><br/>
        <input type="submit" value="GET提交">
    </form>
    <hr/>
    <form action="servlet/ServletDemo1" method="post">
        国家：<input type="text" name="country"><br/>
        <input type="submit" value="POST提交">
    </form>
</body>
</html>

　　

//测试统一全站字符编码
public class ServletDemo1 extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        String country = request.getParameter("country");
        response.getWriter().write("国家：" + country);
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

但是get请求时会乱码，post请求则正常。

改进后的编码过滤器：

package cn.qust.web.filter;

import java.io.IOException;
import java.io.UnsupportedEncodingException;

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.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;

/*真正解决全站乱码问题
 * 
 * 当某个对象的方法不适应业务需求时，通常有2种方式可以对方法进行增强：
    .编写子类，覆盖需增强的方法
    .使用Decorator设计模式对方法进行增强（包装模式）
 * 疑问：在实际应用中遇到需增强对象的方法时，到底选用哪种方式呢？
    没有具体的定式，不过有一种情况下，必须使用Decorator设计模式：即被增强的对象，开发人员只能得到它的对象，无法得到它的class文件。
    比如request、response对象，开发人员之所以在servlet中能通过sun公司定义的HttpServletRequest
esponse接口去操作这些对象，是因为Tomcat服务器厂商编写了request、response接口的实现类。web服务器在调用servlet时，会用这些接口的实现类创建出对象，然后传递给servlet程序。
    此种情况下，由于开发人员根本不知道服务器厂商编写的request、response接口的实现类是哪个？在程序中只能拿到服务器厂商提供的对象，因此就只能采用Decorator设计模式对这些对象进行增强。

 */

/*
 * Filter高级应用：Decorator设计模式
 * 涉及到的代码文件：CharacterEncodingFilter2.java    text.jsp    ServletDemo2.java
 * 测试：在text.jsp中的textArea中输入文字，提交之后有ServletDemo2正常显示出来
 */
public class CharacterEncodingFilter2 implements Filter {
    private FilterConfig config = null;
    private String defaultCharset = "UTF-8";
    
    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        
        //获取配置信息里的字符编码charset
        String charset = this.config.getInitParameter("charset");
        //如果没有配置字符编码，那么使用默认字符编码
        if(charset==null){
            charset = this.defaultCharset;
        }
        //设置编码    
        request.setCharacterEncoding(charset);
        response.setCharacterEncoding(charset);
        response.setContentType("text/html;charset="+charset);
        
        chain.doFilter(new MyRequest((HttpServletRequest) request), response);
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        this.config = filterConfig;
    }
    @Override
    public void destroy() {
    }
    //request的内部包装类
    class MyRequest extends HttpServletRequestWrapper{
        private HttpServletRequest request = null;
        public MyRequest(HttpServletRequest request) {
            super(request);
            this.request = request;
        }
        //要增强的方法
        @Override
        public String getParameter(String name) {
            String value = request.getParameter(name);
            String method = request.getMethod();
            if(value!=null && method.equalsIgnoreCase("GET")){
                try {
                    value = new String(value.getBytes("iso-8859-1"),request.getCharacterEncoding());
                } catch (UnsupportedEncodingException e) {
                    e.printStackTrace();
                }
            }
            return value;
        }
    }
}

2、禁止浏览器缓存所有动态页面

　　有 3 个 HTTP 响应头字段都可以禁止浏览器缓存当前页面，它们在 Servlet 中的示例代码如下：

• response.setDateHeader("Expires",-1);
• response.setHeader("Cache-Control","no-cache");?
• response.setHeader("Pragma","no-cache");?

并不是所有的浏览器都能完全支持上面的三个响应头，因此最好是同时使用上面的三个响应头。

Expires数据头：值为GMT时间值，为-1指浏览器不要缓存页面

Cache-Control响应头有两个常用值： 

no-cache指浏览器不要缓存当前页面。

max-age:xxx指浏览器缓存页面xxx秒

package cn.qust.web.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;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;


/*
 * Filter应用2：禁止浏览器缓存页面
 * 涉及到的代码文件：NoCacheFilter.java   index.jsp
 * 测试：在浏览器缓存文件夹中查看。
 * 实验结果：失败。缓存文件夹中依然存在着缓存文件
 */
public class NoCacheFilter implements Filter{

    @Override
    public void destroy() {
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;
        
        response.setDateHeader("Expires",-1);
        response.setHeader("Cache-Control","no-cache");
        response.setHeader("Pragma","no-cache");
        
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
        // TODO Auto-generated method stub
    }
}

3、控制浏览器缓存页面中的静态资源

场景：有些动态页面中引用了一些图片或css文件以修饰页面效果，这些图片和css文件经常是不变化的，所以为减轻服务器的压力，可以使用filter控制浏览器缓存这些文件，以提升服务器的性能。

package cn.qust.web.filter;

import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.TimeZone;

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;


/*
 * Filter应用3：控制浏览器缓存页面中的静态资源的过滤器
 * 涉及的代码文件：CacheFilter.java    image.jsp
 * 测试：打开image.jsp页面，查看缓存文件夹中的缓存
 */
public class CacheFilter implements Filter {
    private Map<String, Integer> expires = null;
    private FilterConfig config = null;
    @Override
    public void destroy() {
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;
        //获取请求地址的uri
        String uri = request.getRequestURI();
        //获取文件后缀
        String fileType = uri.substring(uri.lastIndexOf(".")+1);
        //缓存时间
        long expires = -1;
        if(this.expires.containsKey(fileType)){
            expires = System.currentTimeMillis() + this.expires.get(fileType) ;
            //时间差8个小时
            expires += 8*60*60*1000;
        }
        //设置缓存时间
        response.setDateHeader("Expires", expires);    
        System.out.println("Expires:" + expires);
        //调用目标资源
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
        this.config = arg0;
        //保存缓存文件类型及对应的缓存时间
        this.expires = new HashMap<String, Integer>();
        //把配置信息存放到map中
        Enumeration<String> names = this.config.getInitParameterNames();
        while(names.hasMoreElements()){
            String fileType = names.nextElement();
            Integer expireTime = Integer.valueOf(this.config.getInitParameter(fileType));//单位为分钟
            expireTime = expireTime * 60 * 1000;
            this.expires.put(fileType, expireTime);//单位为秒
        }
        System.out.println(this.expires.toString());
    }
}

4、实现URL级别的权限认证

5、实现用户自动登录