过滤器Filter

原创已于 2022-05-04 14:45:06 修改 · 297 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#html #java #tomcat #spring

于 2022-04-25 16:55:27 首次发布

本文详细介绍了Java Web过滤器的概念，包括如何在web.xml和注解中配置，过滤器的生命周期过程，以及通过实例演示了过滤器如何拦截和处理请求。重点讲解了初始化、doFilter和销毁方法的作用。

什么是过滤器？

过滤器是一个程序，对web资源进行拦截，做一些处理之后再交给下一个过滤器或者Servlet处理，通常是用来拦截Request进行处理的，也可以对返回的Response进行拦截处理。本质上仍然是一个Servlet、一个类，但只做该做的方法，如doFilter。

配置Filter

1）在web.xml中配置url-pattern，即要拦截的资源。如下图，配置名称为"MyFilter01"的过滤器对指定资源"/MyServlet"进行处理。

  <!-- 配置过滤器，注意，是对URL进行拦截或是过滤 -->
  <filter>
    <filter-name>MyFilter01</filter-name>
    <filter-class>filter.MyFilter01</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>MyFilter01</filter-name>
    <url-pattern>/MyServlet</url-pattern>
  </filter-mapping>

若有多个过滤器的指定资源一致，执行顺序由 <filter-mapping>先后顺序决定，与 <filter>无关。

2）通过注解配置

@WebFilter(filterName = "MyFilter01",urlPatterns = "/MyServlet"
           /*可有可无*/initParams = {
                @WebInitParam(name = "charset", value = "utf-8")/*这里可以放一些初始化*/}
           )

配置对象（urlPatterns）通常表示为：

以指定资源匹配。例如"/index.jsp"
以目录匹配。例如"/servlet/*"
以后缀名匹配，例如"*.jsp"
通配符，拦截所有web资源。"/*"

注意：

使用注解配置的话，filter的执行顺序跟名称的字母顺序有关，例如AFilter会比BFilter先执行
如果既有在web.xml中声明的Filter，也有通过注解配置的Filter，那么会优先执行web.xml中配置的Filter

过滤器生命周期

1）初始化 init

public void init(FilterConfig config) throws ServletException {

	     /*初始化方法  接收一个FilterConfig类型的参数 该参数是对Filter的一些配置*/
	}

web程序启动时，web服务器创建Filter对象，调用init初始化方法，读取web.mxl配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准（Filter对象只会创建一次，init方法也只会执行一次）。

2）过滤功能 doFilter(req.resp)

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

   /*过滤方法 主要是对request和response进行一些处理，然后交给下一个过滤器或Servlet处理*/
		chain.doFilter(request, response);
	}

这个方法完成实际的过滤操作。当客户请求访问与过滤器关联的url的时候，Servlet过滤器将先执行doFilter方法。FilterChain参数用于访问后续过滤器。

doFilter(req.resp)方法：

可以修饰或是改变req,resp对象的行为，可以多次这样做，比如:

请求日志过滤
可以在应用中统计哪些资源妨问最频繁
一天之中哪些时间段站问量最多
些用户最活跃
大小图过滤,提高性能·资源下载次数
通过查日志，也可以知道服务器这一部分是不是工作正常

3）销毁 destroy

public void destroy() {
		
        /*销毁时调用*/
    }

Filter对象创建后会驻留在内存，当web应用移除或服务器停止时才销毁。在web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

实例

MyServlet

package servlet;

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * <li>Servlet，做核心业务
 */
public class MyServlet extends HttpServlet {

	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

		// 模拟核心业务
		System.out.println("2020052029，我的Servlet在工作...");
	}

	protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		doGet(request, response);
	}

}

过滤器源代码：（通过注解拦截资源"/MyServlet"）

package 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;

/**
 * <li>过滤器
 */
@WebFilter(filterName = "MyFilter01",urlPatterns = "/MyServlet")
public class MyFilter01 implements Filter {
	
	public void init(FilterConfig config) throws ServletException {
		 System.out.println("过滤器初始化");
	     /*初始化方法  接收一个FilterConfig类型的参数 该参数是对Filter的一些配置*/
	}
    
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
		// 相当于是模拟预设工作
		System.out.println("2020052029 这是准备工作.....");
		// 放行【如果没有下面的doFilter过程，即为拦截了】，放行后可以到达servlet
		chain.doFilter(request, response);
		// 相当于是模拟善后工作【servlet工作完后，再回到这里】
		System.out.println("2020052029 这是善后工作.....");
	}
	
	public void destroy() {
		System.out.println("过滤器销毁");
        /*销毁时调用*/
    }
}

运行MyServlet，控制台显示：