【Filter】- 过滤器的基本使用 以及细节

Filter : 过滤器

1.基本概念

• web 中的过滤器 , 当访问服务器的资源时, 过滤器可以将请求拦截下来, 完成一些特殊的功能.
• 过滤器的作用 :
  • 一般用于完成通用的操作,比如: 登陆验证,同一编码处理,敏感字符过滤…

2.快速入门

• 步骤 :

  1. 定义一个类 , 实现 Filter 接口
  2. 重写对应的方法
  3. 配置拦截路径 (当访问这个路径的时候,拦截器会生效)

• 代码示例

package com.zyg.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 EncodingFilter
 */
@WebFilter("/*")
public class EncodingFilter implements Filter {


	public void destroy() {
		// TODO Auto-generated method stub
	}
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
		System.out.println("过滤器...");
		// 注意 : 这里要放行
		chain.doFilter(request, response);
	}

	public void init(FilterConfig fConfig) throws ServletException {
		// TODO Auto-generated method stub
	}

}

• 配置web.xml文件 (如果使用注解的方式配置就不需要再配置web.xml)

<!-- 配置过滤器 -->
  <filter>
  	<filter-name>EncodingFilter</filter-name>
  	<filter-class>com.zyg.filter.EncodingFilter</filter-class>
  </filter>
  <filter-mapping>
  	<filter-name>EncodingFilter</filter-name>
  	<!-- 拦截的路径 -->
  	<url-pattern>/*</url-pattern>
  </filter-mapping>

• 过滤器执行流程分析

  • 执行过滤器

  • 执行放行后的资源

  • 回来执行过滤器放行代码下边的代码

  • 流程描述

    当用户访问某一文件的时候 , 假设是 test.jsp 页面 访问流程是
    访问 -> 拦截器 -> 放行 -> 访问到test.jsp -> 返回 -> 经过拦截器 -> 返回请求

  • 代码测试

    • test.jsp

      <% 
       System.out.println("test.jsp 被访问....");  
       %>
      

    • Filter - doFilter 方法

      // 
      		System.out.println("在访问到指定资源之前执行的代码");
      		// 注意 : 这里要放行
      		chain.doFilter(request, response);
      		
      		// 访问到指定页面之后 返回时执行的代码
      		// code
      		System.out.println("返回...");
      

    • 示例截图
      

• 过滤器的生命周期

服务启动 -> 调用 init 方法初始化 -> 创建Filter对象 -> 每次访问浏览器拦截的路径时,都会调用 doFilter 方法 -> 服务器关闭 销毁Filter对象 -> 如果服务器是正常关闭的 调用destroy 方法

• 重写Filter类的的方法详解

  • init : 在服务器启动之后,会创建Filter对象, 然后调用init方法,只执行一次用于加载资源

  • doFilter : 用于拦截过滤

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
    	// 
    	System.out.println("在访问到指定资源之前执行的代码");
    	// 注意 : 这里要放行
    	chain.doFilter(request, response);
    	
    	// 访问到指定页面之后 返回时执行的代码
    	// code
    	System.out.println("返回...");
    	}
    	```
    
    
    
    

  • destroy : 在服务器关闭后 , Filter对象被销毁,如果服务器是正常关闭的,则会执行 destroy 方法

• 过滤器配置详解

  • 拦截路径配置 :
  1. 具体资源路径 : /index.jsp 只有访问 index.jsp 资源时,过滤器才会被执行
  2. 拦截目录 : /login/LoginServlet 访问比如路径设置的是 (/login/LoginServlet时会执行) 访问这个Servlet的时候就会被执行
  3. 后缀名拦截路径 : *.jsp 表示访问 所有后缀名是 jsp 的资源的时候 ,过滤器都会被执行
  4. 拦截所有的资源 : /* 访问所有资源的时候 , 过滤器都会被执行

  • 拦截方式配置 :

    • 资源被访问的方式

  • 通过浏览器地址访问

    • 服务器内部请求转发访问

    • 注解配置

      • 配置 dispatcherType 属性

        1. REQUEST : 默认值 , 浏览器直接请求资源
        2. FORWARD : 转发访问资源
        3. INCLUDE : 使用 include 包含的方式访问资源
        4. ERROR : 错误跳转资源
        5. ASYNC : 异步访问资源

    • 示例

      • forward

          @WebFilter(value="*.jsp" , dispatcherTypes=DispatcherType.FORWARD)
          // 请求方式 
          request.getRequestDispatcher("/test02.jsp").forward(request, response);
        

        • request

          // 注意 如果需要配置两种方式访问 只需使用 {} 即可   
          @WebFilter(value="*.jsp" , dispatcherTypes= {DispatcherType.FORWARD , DispatcherType.REQUEST})
          
          http://localhost:8080/WebExamB/testServlet 
          http://localhost:8080/WebExamB/test.jsp
          

    • web.xml 配置

      <filter-mapping>
      		<filter-name>EncodingFilter</filter-name>
      		<!-- 设置拦截的路径 -->
      		<url-pattern>/*</url-pattern>
      		<!-- 设置拦截的访问的方式 -->
          	<dispatcher>FORWARD</dispatcher>
      	</filter-mapping> 
      
      

  • 配置多个过滤器

    • 执行顺序 : 如果有两个过滤器 : 过滤器1 和 过滤器2

      1. 过滤器1
      2. 过滤器2
      3. 执行的资源
      4. 过滤器2
      5. 过滤器1

    • 过滤器先后问题 :

      1. 注解配置 : 按照类名的字符串比较规则顺序,值小的先执行
         • 比如 : AFilter 和 BFilter A 在字符顺序上是比B小的, 所以 AFilter先执行
      2. web.xml 配置 谁定义在上面 , 谁先执行