17.6Filter过滤器

一、Filter简介

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

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

Filter请求处理

在拦截器出来之前，Filter是web开发的基础核心，可以负责权限控制、日志记录、字符集处理等等

二、Filter是如何实现拦截的？

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

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

三、Filter开发入门

3.1、Filter开发步骤

Filter开发分为二个步骤：
1、编写java类实现Filter接口，并实现其doFilter方法。
2、在 web.xml 文件中使用和元素对编写的filter类进行注册，并设置它所能拦截的资源。

下面以字符集处理的过滤器进行举例。
在java开发中，经常会遇到中文乱码的问题，原因就是页面提交的中文是ISO88590-1格式的，到后台如果不进行转码，就会出现中文乱码。但是不能每个请求都要手动转码吧，所以采用filter就可以轻松解决这个问题了。

public class CharacterEncodingFilter implements Filter {
    private FilterConfig filterConfig = null;
    //设置默认的字符编码
    private String defaultCharset = "UTF-8";

    public void doFilter(ServletRequest req, ServletResponse resp,
                         FilterChain chain) throws IOException, ServletException {

        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;
        String charset = filterConfig.getInitParameter("charset");
        if (charset == null) {
            charset = defaultCharset;
        }
        request.setCharacterEncoding(charset);
        response.setCharacterEncoding(charset);
        response.setContentType("text/html;charset=" + charset);
        chain.doFilter(request, response);
    }

    public void init(FilterConfig filterConfig) throws ServletException {
        //得到过滤器的初始化配置信息
        this.filterConfig = filterConfig;
    }

    public void destroy() {

    }
}

原理就是在每个请求时，设置request和response的字符集都是UTF-8

3.2、Filter链

在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。

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

四、Filter的生命周期

4.1、Filter的创建

Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作，filter对象只会创建一次，init方法也只会执行一次。通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

4.2、Filter的销毁

Web容器调用destroy方法销毁Filter。destroy方法在Filter的生命周期中仅执行一次。在destroy方法中，可以释放过滤器使用的资源。

4.3、FilterConfig接口

用户在配置filter时，可以使用为filter配置一些初始化参数，当web容器实例化Filter 对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过 filterConfig对象的方法，就可获得：

1、String getFilterName()：得到filter的名称。
2、String getInitParameter(String name)：返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.
3、Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。
4、public ServletContext getServletContext()：返回Servlet上下文对象的引用。

五、Filter的部署

Filter的部署分为两个步骤：

1、注册Filter
2、映射Filter

5.1、注册Filter

开发好Filter之后，需要在web.xml文件中进行注册，这样才能够被web服务器调用

在web.xml文件中注册Filter范例：

 
        CharacterEncodingFilter
        com.critc.filter.CharacterEncodingFilter
        
            charset
            UTF-8

5.2、映射Filter

在web.xml文件中注册了Filter之后，还要在web.xml文件中映射Filter


   
        CharacterEncodingFilter
        /*

1、元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
2、子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字
3、设置 filter 所拦截的请求路径(过滤器关联的URL样式)

现在有了SpringMVC的拦截器和Struts的拦截器，Filter用的越来越少，不过原理还是要掌握的，便于读懂历史项目。

源码下载

本例子详细源码