fliter详解（转）

web.xml中元素执行的顺序listener->filter->struts拦截器->servlet。

1.过滤器的概念

Java中的Filter 并不是一个标准的Servlet ，它不能处理用户请求，也不能对客户端生成响应。 主要用于对HttpServletRequest 进行预处理，也可以对HttpServletResponse 进行后处理，是个典型的处理链。

优点：过滤链的好处是，执行过程中任何时候都可以打断，只要不执行chain.doFilter()就不会再执行后面的过滤器和请求的内容。而在实际使用时，就要特别注意过滤链的执行顺序问题

2.过滤器的作用描述

 

• 在HttpServletRequest 到达Servlet 之前，拦截客户的HttpServletRequest 。 
•   根据需要检查HttpServletRequest ，也可以修改HttpServletRequest 头和数据。 
•  在HttpServletResponse 到达客户端之前，拦截HttpServletResponse 。 
• 根据需要检查HttpServletResponse ，可以修改HttpServletResponse 头和数据。

 

3.过滤器的执行流程（类似递归）

 

 

 

 

4.Filter接口

1.如何驱动

在 web 应用程序启动时，web 服务器将根据 web.xml 文件中的配置信息来创建每个注册的 Filter 实例对象，并将其保存在服务器的内存中

2.方法介绍

• init()  Init 方法在 Filter 生命周期中仅执行一次，web 容器在调用 init 方法时
• destory()  在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。
• doFilter() Filter 链的执行 

 

5.FilterChain接口

1.如何实例化

 

代表当前 Filter 链的对象。由容器实现，容器将其实例作为参数传入过滤器对象的doFilter()方法中

2.作用

 

调用过滤器链中的下一个过滤器

filter实例：

web.xml配置（先配置的filter先执行）

 

<!-- 编码过滤器 -->
    <filter>
        <filter-name>setCharacterEncoding</filter-name>
        <filter-class>com.company.strutstudy.web.servletstudy.filter.EncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>utf-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>setCharacterEncoding</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

<!-- 请求url日志记录过滤器 -->
    <filter>
        <filter-name>logfilter</filter-name>
        <filter-class>com.company.strutstudy.web.servletstudy.filter.LogFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>logfilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

 配置 Filter：每个过滤器需要配置在web.xml中才能生效，一个Filter需要配置<filter> 和 <filter-mapping>标签。

 

1）<filter>  ：配置 Filter 名称，实现类以及初始化参数。可以同时配置多个初始化参数。

2）<filter-mapping> ：配置什么规则下使用这个Filter 。

①、<url-pattern> ：配置url的规则，可以配置多个，也可以使用通配符（*）。例如 /jsp/* 适用于本ContextPath下以“/jsp/ ”开头的所有servlet路径， *.do 适用于所有以“ .do”结尾的servlet路径。

 

②、<dispatcher> ：配置到达servlet的方式，可以同时配置多个。有四种取值：REQUEST、FORWARD、ERROR、INCLUDE。如果没有配置，则默认为REQUEST。它们的区别是：

# REQUEST ：表示仅当直接请求servlet时才生效。

# FORWARD ：表示仅当某servlet通过forward转发到该servlet时才生效。

# INCLUDE ：Jsp中可以通过<jsp:include/>请求某servlet， 只有这种情况才有效。

# ERROR ：Jsp中可以通过<%@page errorPage="error.jsp" %>指定错误处理页面，仅在这种情况下才生效。

 

③、<url-pattern>和<dispatcher> 是且的关系，只有满足<url-pattern>的条件，且满足<dispatcher>的条件，该Filter 才能生效。

编码拦截器：

 

 

public class EncodingFilter implements Filter {
    private String encoding;
    private Map<String, String> params = new HashMap<String, String>();
    // 项目结束时就已经进行销毁
    public void destroy() {
        System.out.println("end do the encoding filter!");
        params=null;
        encoding=null;
    }
    public void doFilter(ServletRequest req, ServletResponse resp,
            FilterChain chain) throws IOException, ServletException {
        //UtilTimerStack.push("EncodingFilter_doFilter:");
        System.out.println("before encoding " + encoding + " filter！");
        req.setCharacterEncoding(encoding);
        // resp.setCharacterEncoding(encoding);
        // resp.setContentType("text/html;charset="+encoding);
        chain.doFilter(req, resp);
        System.out.println("after encoding " + encoding + " filter！");
        System.err.println("----------------------------------------");
        //UtilTimerStack.pop("EncodingFilter_doFilter:");
    }

    // 项目启动时就已经进行读取
    public void init(FilterConfig config) throws ServletException {
        System.out.println("begin do the encoding filter!");
        encoding = config.getInitParameter("encoding");
        for (Enumeration e = config.getInitParameterNames(); e
                .hasMoreElements();) {
            String name = (String) e.nextElement();
            String value = config.getInitParameter(name);
            params.put(name, value);
        }
    }
 }

日志拦截器：

public class LogFilter implements Filter {
    FilterConfig config;

    public void destroy() {
        this.config = null;
    }

    public void doFilter(ServletRequest req, ServletResponse res,
            FilterChain chain) throws IOException, ServletException {
        // 获取ServletContext 对象，用于记录日志
        ServletContext context = this.config.getServletContext();
        //long before = System.currentTimeMillis();
        System.out.println("before the log filter!");
        //context.log("开始过滤");
        // 将请求转换成HttpServletRequest 请求
        HttpServletRequest hreq = (HttpServletRequest) req;
        // 记录日志
        System.out.println("Log Filter已经截获到用户的请求的地址:"+hreq.getServletPath() );
        //context.log("Filter已经截获到用户的请求的地址: " + hreq.getServletPath());
        try {
            // Filter 只是链式处理，请求依然转发到目的地址。
            chain.doFilter(req, res);
        } catch (Exception e) {
            e.printStackTrace();
        }
        System.out.println("after the log filter!");
        //long after = System.currentTimeMillis();
        // 记录日志
        //context.log("过滤结束");
        // 再次记录日志
        //context.log(" 请求被定位到" + ((HttpServletRequest) req).getRequestURI()
        //      + "所花的时间为: " + (after - before));
    }

    public void init(FilterConfig config) throws ServletException {
        System.out.println("begin do the log filter!");
        this.config = config;
    }

 }

HelloServlet类：

public class HelloWorldServlet extends HttpServlet{

    /**
     * 查看httpservlet实现的service一看便知，起到了一个controll控制器的作用(转向的)
     * 之后便是跳转至我们熟悉的doget,dopost等方法中
     */
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        System.out.println("doservice..."+this.getInitParameter("encoding"));

        super.service(req, resp);
    }

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        System.out.println("doget...");
        doPost(req, resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        System.out.println("dopost...");
    }



 }

结果： 

 

before encoding utf-8 filter！
  before the log filter!
  Log Filter已经截获到用户的请求的地址:/hello
  doservice...UTF-8
  doget...
  dopost...
  after the log filter!
  after encoding utf-8 filter！
  ----------------------------------------

 

总结：

1.过滤器执行流程

2.常用过滤器