Filter(过滤器)学习

Posted 2020-08-05 李阿昀

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Filter(过滤器)学习相关的知识，希望对你有一定的参考价值。

Filter简介

Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对WEB服务器管理的所有WEB资源：例如JSP、Servlet、静态图片文件或静态html文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
Servlet API中提供了一个Filter接口，开发WEB应用时，如果编写的Java类实现了这个接口，则把这个Java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，如下所示：
在这里插入图片描述

Filter是如何实现拦截的？

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

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

Filter开发入门

Filter开发步骤

Filter开发分为二个步骤：

编写Java类实现Filter接口，并实现其doFilter方法；
在web.xml文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。

例如，编写一个过滤器，如下：

package cn.liayun.web.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 FilterTest implements Filter {

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		// TODO Auto-generated method stub

	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		
		System.out.println("FilterTest执行之前！！！");
        // 拦截下目标资源，然后放行(目标资源也会执行)
        chain.doFilter(request, response); // 放行
        System.out.println("FilterTest执行之后！！！");
        
	}

	@Override
	public void destroy() {
		// TODO Auto-generated method stub

	}

}

在web.xml中配置过滤器：
在这里插入图片描述
代表网站首页的index.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>网站首页</title>
</head>
<body>
	<%
        System.out.println("这是网站首页");
    %>
</body>
</html>

在Chrome浏览器中输入地址http://localhost:8080/FilterDemo/index.jsp访问服务器，Eclipse的控制台会打印如下内容：
在这里插入图片描述
在这里总结一下Filter在开发中的常见应用：

Filter可以在目标资源执行之前，进行权限检查，检查用户有无权限，如有权限则放行，如没有，则拒绝访问；
Filter可以在放行之前，对request和response进行预处理，从而实现一些全局性的设置。比如：
Filter可以在放行之后，可以捕获到目标资源的输出，从而对输出做出类似于压缩这样的设置。

Filter链

在一个WEB应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。WEB服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，WEB服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则WEB服务器会检查FilterChain对象中是否还有Filter，如果有，则调用第2个Filter，如果没有，则调用目标资源。也就是说，当调用Filter链对象的doFilter()方法的时候，链对象内部会检查链里面有没有下一个Filter，如果有下一个Filter，那这时会导致下一个Filter执行，如果没有下一个Filter，那这时会导致目标资源执行。
例如，有下面这样一个Filter链。FilterTest1过滤器的代码如下：

package cn.liayun.web.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 FilterTest1 implements Filter {

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		// TODO Auto-generated method stub

	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		
		//做全局性的设置(对request和response进行一些预处理)
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");
		
		System.out.println("FilterTest1执行之前！！！");
        // 拦截下目标资源，然后放行(目标资源也会执行)
        chain.doFilter(request, response); // 放行
        System.out.println("FilterTest1执行之后！！！");
        
	}

	@Override
	public void destroy() {
		// TODO Auto-generated method stub

	}

}

FilterTest2过滤器的代码如下：

package cn.liayun.web.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 FilterTest2 implements Filter {

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		// TODO Auto-generated method stub

	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		
		System.out.println("FilterTest2执行之前！！！");
        // 拦截下目标资源，然后放行(目标资源也会执行)
        chain.doFilter(request, response); // 放行
        System.out.println("FilterTest2执行之后！！！");
        
	}

	@Override
	public void destroy() {
		// TODO Auto-generated method stub

	}

}

接着，在web.xml中配置过滤器，大家要注意：Filter在web.xml文件中是有注册顺序的。我们可能这样配置，说实话我们经常这么做不是吗？
在这里插入图片描述
从以上配置中，关于Filter在web.xml文件中的注册顺序我们是一目了然的，即FilterTest1过滤器在前，FilterTest2过滤器在后。但我们有时候又会这样配置：

那这样是不是说只要哪个<filter>标签在前，哪个过滤器就在前呢？可惜并不是这样的，在web.xml中配置的过滤器的先后顺序是依<filter-mapping>的顺序而定。我们只要了解这点就好，没人会闲的蛋疼的考你这方面的知识。
网站首页index.jsp的内容同上。最后在Chrome浏览器中输入访问服务器的地址http://localhost:8080/FilterDemo/index.jsp，将在Eclipse的控制台打印：
在这里插入图片描述

Filter的生命周期

Filter的创建

和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。WEB应用程序启动时，WEB服务器将创建Filter的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作。大家要注意以下两点：

Filter对象只会创建一次，init方法也只会执行一次；
开发人员通过init方法的参数，可获得代表当前Filter配置信息的FilterConfig对象。

Filter的销毁

destroy方法在WEB容器卸载Filter对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

一道面试题：Filter对象的生命周期

Filter对象何时被创建？
服务器一启动的时候，就会针对这个WEB应用将所有的Filter对象(拦截器)创建出来，并且以后访问的时候，都是使用同一个拦截器进行拦截。也即一个拦截器会被所有的请求所共享，每一次请求来了之后，都会导致doFilter()方法被调用一次，Filter对象只有一个，而doFilter()方法会被多次调用。
Filter对象在内存里面有几个？一个。服务器并不会针对请求创建新的Filter对象(拦截器)。
Filter对象何时被摧毁？
移除掉WEB服务器里面这个WEB应用(或停掉服务器)，就会摧毁这个WEB应用对应的拦截器。

例如，有如下一个过滤器。

package cn.liayun.web.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 FilterTest1 implements Filter {

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		System.out.println("Filter被创建了！！！");
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		
		//做全局性的设置(对request和response进行一些预处理)
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");
		
		System.out.println("FilterTest1执行之前！！！");
        // 拦截下目标资源，然后放行(目标资源也会执行)
        chain.doFilter(request, response); // 放行
        System.out.println("FilterTest1执行之后！！！");
        
	}

	@Override
	public void destroy() {
		System.out.println("Filter被销毁了！！！");
	}

}

当启动服务器的时候，Eclipse的控制台会打印Filter被创建了！！！，如下：
在这里插入图片描述
当停掉服务器时，Eclipse的控制台会打印Filter被销毁了！！！，如下：

FilterConfig接口

用户在配置Filter时，可以使用<init-param>为Filter配置一些初始化参数，当WEB容器实例化Filter对象，调用其init方法时，会把封装了Filter初始化参数的FilterConfig对象传递进来。因此开发人员在编写Filter时，通过FilterConfig对象的方法，就可获得：
在这里插入图片描述
例如，利用FilterConfig得到Filter配置信息。

package cn.liayun.web.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 FilterTest1 implements Filter {

	/*
     * Filter对象在被创建时，服务器会调用init()方法，并传递进来这样一个对象：FilterConfig(代表Filter的配置信息)
     * FilterConfig对象封装了配置的初始化参数。
     */
	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		System.out.println("Filter被创建了！！！");
		String value = filterConfig.getInitParameter("name"); //获取指定初始化参数
        System.out.println(value);
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		
		//做全局性的设置(对request和response进行一些预处理)
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");
		
		System.out.println("FilterTest1执行之前！！！");
        // 拦截下目标资源，然后放行(目标资源也会执行)
        chain.doFilter(request, response); // 放行
        System.out.println("FilterTest1执行之后！！！");
        
	}

	@Override
	public void destroy() {
		System.out.println("Filter被销毁了！！！");
	}

}

在web. xml中配置过滤器：
在这里插入图片描述
这样在启动服务器的时候，Eclipse的控制台会打印：

如果我们现在想在FilterTest1类的doFilter方法中使用FilterConfig对象封装的配置初始化参数，那又该怎么做呢？我们可以像下面这样做哟：

package cn.liayun.web.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 FilterTest1 implements Filter {
	
	private FilterConfig config;

	/*
     * Filter对象在被创建时，服务器会调用init()方法，并传递进来这样一个对象：FilterConfig(代表Filter的配置信息)
     * FilterConfig对象封装了配置的初始化参数。
     */
	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		System.out.println("Filter被创建了！！！");
		//String value = filterConfig.getInitParameter("name"); //获取指定初始化参数
        //System.out.println(value);
		this.config = filterConfig;
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		
		String value = this.config.getInitParameter("name");
        System.out.println(value);
		
		//做全局性的设置(对request和response进行一些预处理)
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");
		
		System.out.println("FilterTest1执行之前！！！");
        // 拦截下目标资源，然后放行(目标资源也会执行)
        chain.doFilter(request, response); // 放行
        System.out.println("FilterTest1执行之后！！！");
        
	}

	@Override
	public void destroy() {
		System.out.println("Filter被销毁了！！！");
	}

}

Filter的部署

Filter的部署分为两个步骤：

注册Filter；
映射Filter。

注册Filter

开发好Filter之后，需要在web.xml文件中进行注册，这样才能够被WEB服务器调用。在web.xml文件中注册Filter的范例：
在这里插入图片描述

<filter-name>用于为过滤器指定一个名字，该元素的内容不能为空；
<filter-class>元素用于指定过滤器的完整的限定类名；
<init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。如果过滤器不需要指定初始化参数，那么<init-param>元素可以不配置。

映射Filter

在web.xml文件中注册了Filter之后，还要在web.xml文件中映射Filter。
在这里插入图片描述

<filter-mapping>元素用于设置一个Filter所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet名称和资源访问的请求路径。使用Servlet名称来指定Filter拦截的资源，例如：
<filter-name>子元素用于设置Filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字；
<url-pattern>设置Filter所拦截的请求路径(过滤器关联的URL样式)；
<servlet-name>指定过滤器所拦截的Servlet名称；
<dispatcher>指定过滤器所拦截的资源被Servlet容器调用的方式，可以是REQUEST、INCLUDE、FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定Filter对资源的多种调用方式进行拦截。如下：

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

以上是关于Filter(过滤器)学习的主要内容，如果未能解决你的问题，请参考以下文章

javaweb-Servlet过滤器Filter

Servlet3.0学习总结——使用注解标注过滤器(Filter)

基于内部片段的graphql过滤器（gatsbyJS）

学习日记：关于javaweb filter中过滤了css文件的解决方法

Filter学习Filter(过滤器)常见应用

JavaWeb--Filter(过滤器)学习