Filter过滤器简单学习

Servlet 过滤器方法

过滤器是一个实现了 javax.servlet.Filter 接口的 Java 类。javax.servlet.Filter 接口定义了三个方法：

序号	方法 & 描述
1	public void doFilter (ServletRequest, ServletResponse, FilterChain) 该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。
2	public void init(FilterConfig filterConfig) web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。
3	public void destroy() Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。

---

FilterConfig 使用

Filter 的 init 方法中提供了一个 FilterConfig 对象。

如 web.xml 文件配置如下：

<filter>
    <filter-name>LogFilter</filter-name>
    <filter-class>hentai.filter.LogFilter</filter-class>
    <init-param>
        <param-name>Name</param-name>
        <param-value>H</param-value>
    </init-param>
</filter>

在 init 方法使用 FilterConfig 对象获取参数：

public void  init(FilterConfig config) throws ServletException {
    // 获取初始化参数
    String name= config.getInitParameter("Name");
    // 输出初始化参数
    System.out.println("Name: " + name);
}

---

编写Filter

在doFilter方法中编写需要的代码。使用chain.doFilter(request,response);把请求传回过滤链。

请求到来时doFilter方法执行到chain.doFilter(request,response);处调用调用链将请求向后传递，并在此等待调用链处理请求做出响应后折返至此。

接着从此处执行到doFilter方法结束。

在前半段执行过程可以对请求和响应做出对象允许的操作，根据逻辑选择是否将请求传递下去（或对请求-响应对象进行包装再传递），若不传递则不执行chain.doFilter(request,response);直接使用response对象做出响应，完成doFilter方法的执行。

在后半段执行过程，若前半段使用包装类传递了请求-响应，可以对拦截到的后续响应数据进行处理。或者执行其他操作。

---

使用多个过滤器

Web 应用程序可以根据特定的目的定义若干个不同的过滤器。假设定义了两个过滤器 AuthenFilter 和 LogFilter。需要创建一个如下所述的不同的映射，其余的处理与上述所讲解的大致相同：

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>com.runoob.test.LogFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>

<filter>
   <filter-name>AuthenFilter</filter-name>
   <filter-class>com.runoob.test.AuthenFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>

<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

<filter-mapping>
   <filter-name>AuthenFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

类似于servlet的语法，不过符合映射的过滤器均会被执行，filter标签必须在filter-name对应的filter-mapping之前，filter的顺序任意，其执行的先后顺序与配置中其<filter-mapping>出现的顺序相同。

---

web.xml配置各节点说明

• <filter>指定一个过滤器。
  • <filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。
  • <filter-class>元素用于指定过滤器的完整的限定类名。
  • <init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。
  • 在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。
• <filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
  • <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()方法访问时，那么该过滤器就不会被调用。
  • INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
  • FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
  • ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。