JavaWeb_Filter过滤器篇

Posted 2022-12-04 葡萄籽-June

Filter过滤器篇

学习JavaWeb，过滤器是必不可少之一。那么，什么是过滤器？过滤器有何作用？等是需要我们探讨的问题(⊙o⊙)~

---

本文会围绕JavaWeb三大组件之一的过滤器（filter）进行学习与实践。

文章目录

• Filter过滤器篇
• 前言
• 一、什么是过滤器
• 二、Filter 的生命周期
• 三、FilterConfig 类
• 四、FilterChain 过滤器链

前言

Filter也称之为过滤器，它是Servlet技术中最实用的技术，Web开发人员通过Filter技术，对web服务器管理的所有web资源。

例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

它主要用于对用户请求进行预处理，也可以对HttpServletResponse进行后处理。

Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源进行拦截后，Web服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：以上

【1】 调用目标资源之前，让一段代码执行。 是否调用目标资源（即是否让用户访问web资源）。
【2】web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象.
【3】它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

---

一、什么是过滤器

事实上，由上总结：

【1】Filter 过滤器它是JavaWeb 的三大组件之一。
三大组件分别是：Servlet 程序、Listener 监听器、Filter 过滤器
【2】Filter 过滤器它是JavaEE 的规范。也就是接口
【3】Filter 过滤器它的作用是：拦截请求，过滤响应。

【注】过滤器很常用的就主要应用场景处理分发（权限检查）、日记操作、事务管理等等

二、Filter 的生命周期

Filter 的生命周期包含几个方法

1. 构造器
2. init()

第1，2 步，在web 工程启动的时候执行（Filter 已经创建）

3. doFilter ()

第3 步，每次拦截到请求，就会执行

4. destroy()

第4 步，停止web 工程的时候，就会执行（停止web 工程，也会销毁Filter 过滤器）

三、FilterConfig 类

FilterConfig 类是Filter 过滤器的配置文件类。
Tomcat 每次创建Filter 的时候，也会同时创建一个FilterConfig 类，这里包含了Filter 配置文件的配置信息。

FilterConfig 类的作用——获取filter 过滤器的配置内容，主要包括下面：
【1】获取Filter 的名称filter-name 的内容
【2】获取在Filter 中配置的init-param 初始化参数
【3】获取ServletContext 对象

---

四、FilterChain 过滤器链

FilterChain 就是过滤器链（多个过滤器如何一起工作）。

多个过滤器执行的特点：

1、所有filter和目标资源默认都执行在同一线程中；
2、多个fliter共同执行的时候，它们都使用同一个Request对象；

FilterChain.doFilter()方法的作用:

1、执行下一个Filter过滤器（如果后面还有的话）；
2、执行目标资源（若执行完所有需要执行的Filter时）；

【注】在多个filter执行的时候，他们执行的优先顺序总是由它们在web.xml中从上到下的配置顺序进行执行的。

---

【注】Filter 过滤器它只关心请求的地址是否匹配，不关心请求的资源是否存在。

由上述可知，filter的应用步骤大致可分为：

1、编写一个类去实现Filter 接口
2、实现过滤方法doFilter()
3、到web.xml 中去配置Filter 的拦截路径

下面是简单应用：

要求：在web 工程下，有一个admin 目录。这个admin 目录下的所有资源（html 页面、jpg 图片、jsp 文件、等等）都必须是用户登录之后才允许访问。
思考：我们知道，用户登录之后都会把用户登录的信息保存到Session 域中。所以要检查用户是否登录，可以判断Session 中否包含有用户登录的信息即可！

<%
	Object user = session.getAttribute("user");
	// 如果等于null，说明还没有登录
	if (user == null) 
		request.getRequestDispatcher("/login.jsp").forward(request,response);
		return;
	
%>

Filter 的工作流程图大致：

根据上述流程图，filter代码例子如下：

public class AdminFilter implements Filter 
	/**
	* doFilter 方法，专门用于拦截请求。可以做权限检查
	*/
	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain
filterChain) throws IOException, ServletException 
		HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
		HttpSession session = httpServletRequest.getSession();
		Object user = session.getAttribute("user");
		// 如果等于null，说明还没有登录
		if (user == null) 
			servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest,servletResponse		);
			return;
		 else 
			// 让程序继续往下访问用户的目标资源
			filterChain.doFilter(servletRequest,servletResponse);
		
	

web.xml 中的配置：

	<!--filter 标签用于配置一个Filter 过滤器-->
	<filter>
		<!--给filter 起一个别名-->
		<filter-name>AdminFilter</filter-name>
		<!--配置filter 的全类名-->
		<filter-class>com.atguigu.filter.AdminFilter</filter-class>
	</filter>
	<!--filter-mapping 配置Filter 过滤器的拦截路径-->
	<filter-mapping>
		<!--filter-name 表示当前的拦截路径给哪个filter 使用-->
		<filter-name>AdminFilter</filter-name>
		<!--url-pattern 配置拦截路径
		/ 表示请求地址为：http://ip:port/工程路径/ 映射到IDEA 的web 目录
/admin/* 表示请求地址为：http://ip:port/工程路径/admin/*
-->
		<url-pattern>/admin/*</url-pattern>
	</filter-mapping>