后台(24)——Filter（1）

探索Android软键盘的疑难杂症
深入探讨Android异步精髓Handler
详解Android主流框架不可或缺的基石
站在源码的肩膀上全解Scroller工作机制

Android多分辨率适配框架（1）— 核心基础
Android多分辨率适配框架（2）— 原理剖析
Android多分辨率适配框架（3）— 使用指南

自定义View系列教程00–推翻自己和过往，重学自定义View
自定义View系列教程01–常用工具介绍
自定义View系列教程02–onMeasure源码详尽分析
自定义View系列教程03–onLayout源码详尽分析
自定义View系列教程04–Draw源码分析及其实践
自定义View系列教程05–示例分析
自定义View系列教程06–详解View的Touch事件处理
自定义View系列教程07–详解ViewGroup分发Touch事件
自定义View系列教程08–滑动冲突的产生及其处理

版权声明

• 本文原创作者：谷哥的小弟
• 作者博客地址：http://blog.csdn.net/lfdfhl

Filter简介

JavaWeb中的过滤器Filter可以拦截所有访问Web资源(Servlet、JSP、HTML等等)的请求及其响应。Filter本身并不会产生请求和响应对象，它只提供过滤作用；比如：在Servlet被调用之前检查或者修改Request、Request Header、Request中的内容；在Servlet被调用之后检查或者修改Response、Response Header和Response中的内容。通过Filter我们可以实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息、验证、加密等一些非常实用的功能。

Filter入门示例

Filter的实现步骤如下：

• 1、创建一个类实现Filter接口
• 2、实现接口中方法，在doFilter( )中实现过滤
• 3、在web.xml文件中配置Filter

请看如下示例

先写一个Filter

/**
 * 本文作者：谷哥的小弟
 * 博客地址：http://blog.csdn.net/lfdfhl
 */
package cn.com;

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;

public class FilterTest implements Filter{

    public FilterTest(){
        System.out.println("调用Filter构造方法");
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("调用Filter的init()方法");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("doFilter()开始过滤");
        chain.doFilter(request, response);
        System.out.println("doFilter()过滤结束");
    }

    @Override
    public void destroy() {
        System.out.println("调用Filter的destroy()方法");
    }

}

再写一个Servlet

/**
 * 本文作者：谷哥的小弟
 * 博客地址：http://blog.csdn.net/lfdfhl
 */
package cn.com;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class HttpServletTest extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        System.out.println("调用HttpServlet的doGet()方法");
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        System.out.println("调用HttpServlet的doPost()方法");
    }

}

最后在web.xml中配置Filter和Servlet

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

    <filter>
        <filter-name>TestFilter</filter-name>
        <filter-class>cn.com.FilterTest</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>TestFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <servlet>
        <servlet-name>TestServlet</servlet-name>
        <servlet-class>cn.com.HttpServletTest</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>TestServlet</servlet-name>
        <url-pattern>/servlet</url-pattern>
    </servlet-mapping>

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>

</web-app>

在这里也可看出：Filter的配置方式和Servlet非常类似！不仅如此，Filter的生命周期也与Servlet基本一致：

• 服务器启动时创建Filter对象并调用init()，该方法只调用一次.
• 访问的资源路径与Filter的拦截路径匹配时执行Filter中的doFilter()执行过滤(拦截)
• 当服务器关闭时调用Filter的destroy()

运行后输出结果：

调用Filter构造方法
调用Filter的init()方法
doFilter()开始过滤
调用HttpServlet的doGet()方法
doFilter()过滤结束

嗯哼，看到了吧：浏览器发起的请求会首先进入到Filter中后才进入到Servlet里；当Servlet中的方法执行完成后再次回到Filter。

在该实例中，我们只使用了一个Filter。其实，我们也可以编写多个Filter实现不同的功能，这些Filter将形成一个链条即FilterChain；当浏览器发起请求时，请求会先通过这个链条再到达资源。请注意一个小问题：链条中Filter的调用顺序是由其在web.xml中对应的<filter-mapping>的先后顺序决定的。

FilterConfig

我们知道Servlet中有一个ServletConfig；其实，在Filter也存在一个类似于ServletConfig的东西，它就是FilterConfig。嗯哼，想起来没有？——我们刚才的示例FilterTest中的init( )方法参数是不是一个FilterConfig呢？

FilterConfig的作用:

• 1.获取Filter的名称

• 2.获取初始化参数

• 3.获取ServletContext对象

FilterConfig的常用方法:

• getFilterName( )

• getInitParameter(String name)

• getInitParameterNames( )

• getServletContext()

Filter配置详解

Filter基本配置介绍

<filter>
    <filter-name>filter名称</filter-name>
    <filter-class>filter类全名</filter-class>
</filter>
<filter-mapping>
    <filter-name>filter名称</filter-name>
    <url-pattern>映射路径</url-pattern>
</filter-mapping>

关于<url-pattern>的配置

1、完全匹配
必须以”/”开始.
2、目录匹配
必须以”/”开始，以*结束.
3、扩展名匹配
以*.xxx结束.

关于<servlet-name>的配置

可在<filter-mapping>中利用<servlet-name>对servlet进行过滤配置。即用<servlet-name>设置当前Filter拦截哪一个servlet

关于<dispatcher>的配置

可在<filter-mapping>中利用<dispatcher>指明：Filter在资源以什么方式被Servlet容器调用时才进行拦截。<dispatcher>的取值有：REQUEST、FORWARD、ERROR、INCLUDE

可在<filter-mapping>中利用<dispatcher>设置Web资源以什么方式被Servlet容器调用时Filter才进行拦截。<dispatcher>的取值有：REQUEST、FORWARD、ERROR、INCLUDE

1、REQUEST
目标资源被访问或者系统重定向后指向该目标资源时Filter才拦截。这也是默认的值

2、FORWARD
目标资源通过RequestDispatcher.forward(request, response)被调用时Filter才拦截

3、ERROR
目标资源是在系统处理异常时被调用

4、INCLUDE
目标资源通过RequestDispatcher.include(request, response)被调用时Filter才拦截