【Web入门系列】初探过滤器Filter

定义

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

开发步骤

1、编写java类实现Filter接口，并实现其doFilter方法。 2、在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。

<filter>
    <filter-name>FirstFilter</filter-name>
    <filter-class>ysdrzp.filter.FirstFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>FirstFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

<filter>
    <filter-name>SecondFilter</filter-name>
    <filter-class>ysdrzp.filter.SecondFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>SecondFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

<servlet>
    <servlet-name>TestServlet</servlet-name>
    <servlet-class>ysdrzp.filter.TestServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>TestServlet</servlet-name>
    <url-pattern>/testServlet</url-pattern>
</servlet-mapping>

public class FirstFilter implements Filter {

    /**
     *  Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，
     *  并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作.
     *  （注：filter对象只会创建一次，init方法也只会执行一次。
     */
    public FirstFilter(){
        System.out.println("1、创建过滤器实例完成");
    }

    /**
     * 通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象
     * @param config
     * @throws ServletException
     */
    @Override
    public void init(FilterConfig config) throws ServletException {
        System.out.println("2、过滤器初始化参数完成");
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        System.out.println("3、执行过滤器业务处理方法");
        chain.doFilter(req, resp);
        System.out.println("7、Servlet执行完成，又回到过滤器");
    }

    @Override
    public void destroy() {
        System.out.println("8、销毁过滤器实例");
    }
}

public class SecondFilter implements Filter {

    @Override
    public void init(FilterConfig config) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        System.out.println("4、执行第二个过滤器业务处理方法");
        chain.doFilter(req, resp);
        System.out.println("6、Servlet执行完成，又回到过滤器");
    }

    @Override
    public void destroy() {
    }

}

/**
 * 测试
 */
public class TestServlet extends HttpServlet {

    @Override
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        System.out.println("5、执行servlet业务方法");
    }

}

Filter原理

1）Filter接口中有一个doFilter方法，编写好Filter，并配置对哪个资源进行拦截后，服务器每次在调用资源的service方法之前，都会先调用一下filter的doFilter方法。2）在一个web应用中，可以编写多个Filter，这些Filter组合起来称之为一个Filter链。 web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

FilterConfig接口

用户在配置filter时，可以使用<init-param>为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。这样在编写filter时，可以通过调用filterConfig对象的方法来获取相应的信息：

#获取filter的名称

String getFilterName()

#获取部署中指定名称的初始化参数的值，如果不存在返回null

String getInitParameter(String name)

#获取过滤器的所有初始化参数的名字的枚举集合

Enumeration getInitParameterNames()

#获取Servlet上下文对象的引用

ServletContext getServletContext()

<filter>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <filter-name>FirstFilter</filter-name>
    <filter-class>ysdrzp.filter.FirstFilter</filter-class
</filter>
<filter-mapping>
    <filter-name>FirstFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

View Code

@Override
public void init(FilterConfig config) throws ServletException {
        System.out.println("2、过滤器初始化参数完成");

        // 获取过滤器在web.xml中配置的初始化参数
        String encoding = config.getInitParameter("encoding");
        System.out.println(encoding);

        // 获取过滤器在web.xml中配置的初始化参数的名称
        Enumeration<String> enums =  config.getInitParameterNames();
        while (enums.hasMoreElements()){
            // 获取参数名称
            String name = enums.nextElement();
            // 获取名称对应的值
            String value = config.getInitParameter(name);
            System.out.println(name + ":" + value);
        }
}

View Code