[原创]java WEB学习笔记44：Filter 简介，模型，创建，工作原理，相关API，过滤器的部署及映射的方式，Demo

本博客为原创：综合 尚硅谷（http://www.atguigu.com）的系统教程（深表感谢）和 网络上的现有资源(博客，文档，图书等)，资源的出处我会标明

本博客的目的：①总结自己的学习过程，相当于学习笔记 ②将自己的经验分享给大家，相互学习，互相交流，不可商用

内容难免出现问题，欢迎指正，交流，探讨，可以留言，也可以通过以下方式联系。

本人互联网技术爱好者，互联网技术发烧友

微博：伊直都在0221

QQ：951226918

-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

1.Filter(过滤器)简介

　　1) Filter 的基本功能是对 Servlet 容器调用 Servlet 的过程进行拦截，从而在 Servlet 进行响应处理的前后实现一些特殊的功能;

　　2) 在 Servlet API 中定义了三个接口类来开供开发人员编写 Filter 程序：Filter, FilterChain, FilterConfig;

　　3) Filter 程序是一个实现了 Filter 接口的 Java 类，与 Servlet 程序相似，它由 Servlet 容器进行调用和执行

　　4) Filter 程序需要在 web.xml 文件中进行注册和设置它所能拦截的资源：Filter 程序可以拦截 Jsp, Servlet, 静态图片文件和静态 html 文件

　　是JavaWeb 的一个重要的组件，可以对发送到 Servlet 的请求进行拦截，并对响应进行拦截

　　Filter 是实现了 Filter 接口的 java 类

　　Filter 需要在 web.xml 文件中进行配置和映射

模型

2.如何创建

　　1）创建类实现Filter接口

 package com.jason.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;

 public class HelloServlet implements Filter {

     @Override
     public void init(FilterConfig filterConfig) throws ServletException {
         System.out.println("init ... ");

     }

     @Override
     public void doFilter(ServletRequest request, ServletResponse response,
             FilterChain chain) throws IOException, ServletException {
         System.out.println("doFilter ... ");

     }

     @Override
     public void destroy() {
         System.out.println("destroy ... ");

     }

 }

　　　　

　　2）在 web.xml 配置文件中，注册和映射 Filter

   <!-- 注册Filter  -->
   <filter>
           <filter-name>Hello</filter-name>
           <filter-class>com.jason.filter.HelloServlet</filter-class>
   </filter>
   <!-- 映射Filter 其中url-pattern 指定该Filter 可以拦截哪些资源，即可以通过哪些url 访问到该Filter-->
   <filter-mapping>
           <filter-name>Hello</filter-name>
         <url-pattern>/filter/test.jsp</url-pattern>
   </filter-mapping>

3.Filter工作的基本原理

　　1）当在 web.xml 中注册了一个 Filter 来对某个 Servlet 程序进行拦截处理时，这个 Filter 就成了 Servlet 容器与该 Servlet 程序的通信线路上的一道关卡，该 Filter 可以对 Servlet 容器发送给 Servlet 程序的请求和 Servlet 程序回送给 Servlet 容器的相应进行拦截，可以决定是否将请求继续传递给 Servlet 程序，以及对请求和相应信息是否进行修改

　　2）在一个 web 应用程序中可以注册多个 Filter 程序，每个 Filter 程序都可以对一个或一组 Servlet 程序进行拦截

　　3）若有多个 Filter 程序对某个 Servlet 程序的访问过程进行拦截，当针对该 Servlet 的访问请求到达时，web 容器将把这多个 Filter 程序组合成一个 Filter 链(过滤器链)。Filter 链中各个 Filter 的拦截顺序与它们在应用程序的 web.xml 中映射的顺序一致

4.相关API（重点）

　　①Filter接口：

　　　　>  public void init(FilterConfig filterConfig) throws ServletException {}

　　　　　　*在 web 应用程序启动时，web 服务器将根据 web.xml 文件中的配置信息来创建每个注册的 Filter 实例对象，并将其保存在服务器的内存中。Web容器创建 Filter 对象实例后，将立即调用该 Filter 对象的 init 方法。Init 方法在 Filter 生命周期中仅执行一次，web 容器在调用 init 方法时，会传递一个包含 Filter 的配置和运行环境的 FilterConfig 对象(FilterConfig的用法和ServletConfig类

　　　　　　* 类似于Servlet生命周期方法init()。在创建 Filter 对象后由web容器立即被调用，且只被调用一次。该方法用于对当前的Filter 进行初始化操作。Filter 实例是单例的

　　　　　　*  FilterConfig 类似于 ServletConfig

　　　　　　* 可以在web.xml 文件中配置当前的 Filter 初始化参数。配置方式和配置Servlet 方式一致

   <!-- 注册Filter  -->
   <filter>
           <filter-name>Hello</filter-name>
           <filter-class>com.jason.filter.HelloServlet</filter-class>
           <init-param>
               <param-name>name</param-name>
               <param-value>root</param-value>
           </init-param>
   </filter>
   <!-- 映射Filter 即 访问以下的 url 时候 就会被 Filter 拦截-->
   <filter-mapping>
           <filter-name>Hello</filter-name>
         <url-pattern>/filter/test.jsp</url-pattern>
   </filter-mapping>

　　　　>  public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException {}

　　　　　 * 正真 Filter 的逻辑代码需要编写在该方法中，每次拦截都会调用该方法

　　　　　 *  FilterChain：Filter 链，多个Filter 可以构成一个Filter 链

　　　　　　　　- public void doFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException;把请求传给 Filter 链下一个Filter，若当前Filter 是Filter 链的最后一个 Filter，将把请求给到目标Servlet(或者 JSP)

　　　　　

　　　　>  public void destroy() {} 释放当前 Filter 所占用的资源的方法，在Filter 被销毁之前被调用，且只被调用一次

　　注意：　　与开发Servlet不同的是，Filter接口并没有相应的实现类可供继承，要开发过滤器，只能直接实现Filter接口

5.过滤器的部署

　　1）在实现一个过滤器后，需要在 web.xml 中进行注册和设置它所能拦截的资源。这可以通过<filter>和<filter-mapping>元素来完成的

　　2）<filter>元素用于在Web应用程序中注册一个过滤器。在<filter>元素内

　　　　- <filter-name>用于为过滤器指定一个名字，该元素的内容不能为空

　　　　- <filter-class>元素用于指定过滤器的完整的限定类名

　　　　- <init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数

　　

 <filter>
           <filter-name>testFitler</filter-name>
          <filter-class>org.test.TestFiter</filter-class>
          <init-param>
          <param-name>word_file</param-name>
          <param-value>/WEB-INF/word.txt</param-value>
          </init-param>
 </filter>

　　　　　　Servlet容器对部署描述符中声明的每一个过滤器，只创建一个实例。与Servlet类似，容器将在同一个过滤器实例上运行多个线程来同时为多个请求服务，因此，开发过滤器时，也要注意线程安全的问题。

　　3）映射 Filter：<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径( url样式)

　　　　-  <filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字

　　　  -   <url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)

　　　  -   <servlet-name>指定过滤器所拦截的Servlet名称

　　　  -   <dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST. 可以设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截

　　　　-- <dispatcher> 子元素可以设置的值及其意义 *****

　　　　 -- REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。

　　　　　　　　通过GET 或者 POST 请求直接访问

　　　　 -- INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。

　　　　　　　　或者通过 <jsp:forword page="" />  或者 page  指令的erroPage 转发页面

　　　　 -- FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用

　　　　　　　　或者 <jsp:include file="/..." />

　　　　 -- ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用

　　　　　　　　在web.xml 文件中通过 error-page 节点进行声明

 <error-page>
       <exception-type>java.lang.ArithmeticException</exception-type>
       <location>/test.jsp</location>
   </error-page>

方式一：

 <filter-mapping>
      <filter-name>testFilter</filter-name>
     <url-pattern>/test.jsp</url-pattern>
 </filter-mapping>

方式二：

 <filter-mapping>
     <filter-name>testFilter</filter-name>
    <url-pattern>/index.jsp</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
 </filter-mapping>

在2.0以后可以采用 注解的方式实现映射，同Servlet参考 @WebFilter("/filter/hello1.jsp")

　　注意：在同一个 web.xml 文件中可以为同一个 Filter 设置多个映射。若一个 Filter 链中多次出现了同一个 Filter 程序，这个 Filter 程序的拦截处理过程将被多次执行

6. Demo

login1.jsp

 <%@ 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>Insert title here</title>
 </head>
 <body>

     <font color="red"> ${message }</font>
         <form action="./hello.jsp" method="post">
             username: <input type="text" name="username"/>
             password: <input type="password" name="password"/>
             <input type="submit" value="Submit">
         </form>

 </body>
 </html>

hello1.jsp

 <%@ 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>Insert title here</title>
 </head>
 <body>
     hello: ${param.username }
 </body>
 </html>

web.xml

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

   <context-param>
       <param-name>password</param-name>
       <param-value>1234</param-value>
   </context-param>

  <!-- 配置 filter  -->
   <filter>
     <filter-name>UsernameFilter</filter-name>
     <filter-class>com.jason.filter.UserNameFilter</filter-class>
     <init-param>
       <param-name>username</param-name>
       <param-value>tom</param-value>
     </init-param>
   </filter>

   <filter-mapping>
     <filter-name>UsernameFilter</filter-name>
     <url-pattern>/filter/login1.jsp</url-pattern>
   </filter-mapping>

 </web-app>

　　UserNameFilter.java

package com.jason.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.annotation.WebFilter;

/**
 * Servlet Filter implementation class UserNameFilter
 */

public class UserNameFilter implements Filter {

    /**
     * Default constructor.
     */
    public UserNameFilter() {
        // TODO Auto-generated constructor stub
    }

    /**
     * @see Filter#destroy()
     */
    public void destroy() {
        // TODO Auto-generated method stub
    }

    /**
     * @see Filter#doFilter(ServletRequest, ServletResponse, FilterChain)
     */

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

        System.out.println(" ... ");
        String initUser = filterConfig.getInitParameter("username");
        String username = request.getParameter("username");
        if(!initUser.equals(username)){
            request.setAttribute("message", "用户名不正确");
            request.getRequestDispatcher("/filter/login1.jsp").forward(request, response);
            return;
        }
        chain.doFilter(request, response);
    }

    /**
     * @see Filter#init(FilterConfig)
     */
    private FilterConfig filterConfig;
    public void init(FilterConfig filterConfig) throws ServletException {
        this.filterConfig = filterConfig;
    }

}

　　PasswordFilter.java

package com.jason.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.annotation.WebFilter;

/**
 * Servlet Filter implementation class PasswordFilter
 */
@WebFilter("/filter/hello1.jsp")
public class PasswordFilter implements Filter {

    /**
     * Default constructor.
     */
    public PasswordFilter() {
        // TODO Auto-generated constructor stub
    }

    /**
     * @see Filter#destroy()
     */
    public void destroy() {
        // TODO Auto-generated method stub
    }

    /**
     * @see Filter#doFilter(ServletRequest, ServletResponse, FilterChain)
     */
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

        String initPassword = filterConfig.getServletContext().getInitParameter("password");
        String passward = request.getParameter("password");
        if(!initPassword.equals(passward)){
            request.setAttribute("message", "密码不正确");
            request.getRequestDispatcher("/filter/login1.jsp").forward(request, response);
            return;
        }
        chain.doFilter(request, response);
    }

    /**
     * @see Filter#init(FilterConfig)
     */
    private FilterConfig  filterConfig;
    public void init(FilterConfig fConfig) throws ServletException {
        this.filterConfig = fConfig;
    }

}