过滤器(Filter)

目录

过滤器(Filter)

1.1过滤器的配置操作:

1.2:Filter详解

1.2.1: 执行流程

1.2.3: 拦截路径

1.3:过滤器链

1.4.登录校验-Filter

1.4.1:分析


前言:

在当今这个纷繁复杂的世界里,我们时刻被各种各样的事物包围着,信息如潮水般涌来,物质琳琅满目,环境状况也参差不齐。而此时,“过滤器” 悄然登场,成为了我们生活中不可或缺的关键角色。无论是清晨打开水龙头,清澈的水流过过滤器为我们带来健康的饮用水;还是在网络世界遨游,信息过滤器帮我们筛选出有价值的资讯,它的身影无处不在。这篇博客,就将带你深入了解这些神奇的过滤器,揭开它们背后隐藏的科学奥秘与实用价值,一同开启这场关于 “过滤” 的奇妙探索之旅。

过滤器(Filter)

1.Filter表示过滤器,是 JavaWeb三大组件(ServletFilterListener)之一。

2.过滤器可以把对资源的请求拦截下来,从而实现一些特殊的功能

3.使用了过滤器之后,要想访问web服务器上的资源,必须先经过滤器,过滤器处理完毕之后才可以访问对应的资源。

过滤器一般完成一些通用的操作,比如:登录校验、统一编码处理、敏感字符处理等。  

1.1过滤器的配置操作:

下面我们通过Filter快速入门程序掌握过滤器的基本使用操作:

1步,定义过滤器 :1.定义一个类,实现 Filter 接口,并重写其所有方法。

2步,配置过滤器:Filter类上加 @WebFilter 注解,配置拦截资源的路径。引导类上加

@ServletComponentScan 开启Servlet组件支持。

init 方法:过滤器的初始化方法。在 web 服务器启动的时候会自动的创建 Filter 过滤器对
象,在创建过滤器对象的时候会自动调用 init 初始化方法,这个方法只会被调用一次。
doFilter 方法(最常用):这个方法是在每一次拦截到请求之后都会被调用,所以这个方法是会被调
用多次的,每拦截到一次请求就会调用一次 doFilter() 方法。
destroy方法: 是销毁的方法。当我们关闭服务器的时候,它会自动的调用销毁方法
destroy ,而这个销毁方法也只会被调用一次。
@WebFilter(urlPatterns = "/*") //配置过滤器要拦截的请求路径( /* 表示拦 截浏览器的所有请求 )
public class DemoFilter implements Filter {
@Override //初始化方法, 只调用一次
public void init(FilterConfig filterConfig) throws
ServletException {
System.out.println("init 初始化方法执行了");
 }
@Override //拦截到请求之后调用, 调用多次
public void doFilter(ServletRequest request, ServletResponse
response, FilterChain chain) throws IOException, ServletException {
System.out.println("Demo 拦截到了请求...放行前逻辑");
//放行
chain.doFilter(request,response);
 }
@Override //销毁方法, 只调用一次
public void destroy() {
System.out.println("destroy 销毁方法执行了");
 }
}

 当我们在Filter类上面加了@WebFilter注解之后,接下来我们还需要在启动类上面加上一个注解

@ServletComponentScan,通过这个@ServletComponentScan注解来开启SpringBoot项目对于

Servlet组件的支持。

@ServletComponentScan
@SpringBootApplication
public class TliasWebManagementApplication {
public static void main(String[] args) {
SpringApplication.run(TliasWebManagementApplication.class,
args);
 }
} 123456789
重新启动服务,打开浏览器,执行部门管理的请求,可以看到控制台输出了过滤器中的内容:

注意事项:
在过滤器 Filter 中,如果不执行放行操作,将无法访问后面的资源。 放行操作:
chain.doFilter(request, response);

1.2:Filter详解

Filter 过滤器的快速入门程序我们已经完成了,接下来我们就要详细的介绍一下过滤器 Filter 在使用
中的一些细节。主要介绍以下 3 个方面的细节:
1. 过滤器的执行流程
2. 过滤器的拦截路径配置
3. 过滤器链

1.2.1: 执行流程

首先我们先来看下过滤器的执行流程:
1:过滤器当中我们拦截到了请求之后,如果希望继续访问后面的 web 资源,就要执行放行操作,放行就是调用 FilterChain 对象当中的 doFilter() 方法,在调用 doFilter() 这个方法之前所编写的代码属
于放行之前的逻辑。
2:在放行后访问完 web 资源之后还会回到过滤器当中,回到过滤器之后如有需求还可以执行放行之后的逻辑,放行之后的逻辑我们写在doFilter() 这行代码之后。
@WebFilter(urlPatterns = "/*")
public class DemoFilter implements Filter {
@Override //初始化方法, 只调用一次
public void init(FilterConfig filterConfig) throws
ServletException {
System.out.println("init 初始化方法执行了");
 }
@Override
public void doFilter(ServletRequest servletRequest,
ServletResponse servletResponse, FilterChain filterChain) throws
IOException, ServletException {
System.out.println("DemoFilter 放行前逻辑.....");
//放行请求
filterChain.doFilter(servletRequest,servletResponse);
System.out.println("DemoFilter 放行后逻辑.....");
 }
@Override //销毁方法, 只调用一次
public void destroy() {
System.out.println("destroy 销毁方法执行了");
 }
}

1.2.3: 拦截路径

执行流程我们搞清楚之后,接下来再来介绍一下过滤器的拦截路径,Filter 可以根据需求,配置不同的
拦截资源路径:

1.3:过滤器链

最后我们在来介绍下过滤器链,什么是过滤器链呢?所谓过滤器链指的是在一个web应用程序当中,可 以配置多个过滤器,多个过滤器就形成了一个过滤器链。

比如:在我们web服务器当中,定义了两个过滤器,这两个过滤器就形成了一个过滤器链。

而这个链上的过滤器在执行的时候会一个一个的执行,会先执行第一个Filter,放行之后再来执行第二个Filter,如果执行到了最后一个过滤器放行之后,才会访问对应的web资源。

访问完web资源之后,按照我们刚才所介绍的过滤器的执行流程,还会回到过滤器当中来执行过滤器放行后的逻辑,而在执行放行后的逻辑的时候,顺序是反着的。

先要执行过滤器2放行之后的逻辑,再来执行过滤器1放行之后的逻辑,最后在给浏览器响应数据。

以上就是当我们在web应用当中配置了多个过滤器,形成了这样一个过滤器链以及过滤器链的执行顺序。下面我们通过idea来验证下过滤器链。

验证步骤:

1. filter包下再来新建一个Filter过滤器类:AbcFilter

2. AbcFilter过滤器中编写放行前和放行后逻辑

3. 配置AbcFilter过滤器拦截请求路径为:/*

4. 重启SpringBoot服务,查看DemoFilterAbcFilter的执行日志

1.4.登录校验-Filter

1.4.1:分析

     过滤器 Filter 的快速入门以及使用细节我们已经介绍完了,接下来最后一步,我们需要使用过滤器Filter来完成案例当中的登录校验功能。
我们先来回顾下前面分析过的登录校验的基本流程:
    1.要进入到后台管理系统,我们必须先完成登录操作,此时就需要访问登录接口 login
登录成功之后,我们会在服务端生成一个 JWT 令牌,并且把 JWT 令牌返回给前端,前端会将 JWT 令牌存储下来。
    2.在后续的每一次请求当中,都会将 JWT 令牌携带到服务端,请求到达服务端之后,要想去访问对应的业务功能,此时我们必须先要校验令牌的有效性。
    3.对于校验令牌的这一块操作,我们使用登录校验的过滤器,在过滤器当中来校验令牌的有效性。如果令牌是无效的,就响应一个错误的信息,也不会再去放行访问对应的资源了。如果令牌存在,并且它是有效的,此时就会放行去访问对应的web 资源,执行相应的业务操作。
大概清楚了在 Filter 过滤器的实现步骤了,那在正式开发登录校验过滤器之前,我们思考两个问题:
1. 所有的请求,拦截到了之后,都需要校验令牌吗?
答案: 登录请求例外
2. 拦截到请求后,什么情况下才可以放行,执行业务操作?
答案: 有令牌,且令牌校验通过 ( 合法 ) ;否则都返回未登录错误结果 2.4.3.2 具体流程
我们要完成登录校验,主要是利用 Filter 过滤器实现,而 Filter 过滤器的流程步骤:
基于上面的业务流程,我们分析出具体的操作步骤:
1. 获取请求 url
2. 判断请求 url 中是否包含 login ,如果包含,说明是登录操作,放行
3. 获取请求头中的令牌( token
4. 判断令牌是否存在,如果不存在,返回错误结果(未登录)
5. 解析 token ,如果解析失败,返回错误结果(未登录)
6. 放行
代码实现
分析清楚了以上的问题后,我们就参照接口文档来开发登录功能了,登录接口描述如下:

 登录校验过滤器:LoginCheckFilter

@Slf4j
@WebFilter(urlPatterns = "/*") //拦截所有请求
public class LoginCheckFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest,
ServletResponse servletResponse, FilterChain chain) throws
IOException, ServletException {
//前置:强制转换为http协议的请求对象、响应对象 (转换原因:要使用子 类中特有方法)
HttpServletRequest request = (HttpServletRequest)
servletRequest;
HttpServletResponse response = (HttpServletResponse)
servletResponse;
//1.获取请求url
String url = request.getRequestURL().toString();
log.info("请求路径:{}", url); //请求路径:
http://localhost:8080/login
123456789
10
11
12
13
14
15
//2.判断请求url中是否包含login,如果包含,说明是登录操作,放行
if(url.contains("/login")){
chain.doFilter(request, response);//放行请求
return;//结束当前方法的执行
 }
//3.获取请求头中的令牌(token)
String token = request.getHeader("token");
log.info("从请求头中获取的令牌:{}",token);
//4.判断令牌是否存在,如果不存在,返回错误结果(未登录)
if(!StringUtils.hasLength(token)){
log.info("Token不存在");
Result responseResult = Result.error("NOT_LOGIN");
//把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的 用于实现对象和json的转换工具类)
String json = JSONObject.toJSONString(responseResult);
response.setContentType("application/json;charset=utf-
8");
//响应
response.getWriter().write(json);
return;
 }
//5.解析token,如果解析失败,返回错误结果(未登录)
try {
JwtUtils.parseJWT(token);
 }catch (Exception e){
log.info("令牌解析失败!");
Result responseResult = Result.error("NOT_LOGIN");
//把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的 用于实现对象和json的转换工具类)
String json = JSONObject.toJSONString(responseResult);
response.setContentType("application/json;charset=utf-
8");
//响应
response.getWriter().write(json);
return;
 }
//6.放行
chain.doFilter(request, response);
 }
}

测试 2 :先进行登录操作,再访问部门管理页面
登录校验成功之后,可以正常访问相关业务操作页面

结尾:

在探索 “过滤器” 这一主题的旅程中,我们一同见证了它在各个领域的神奇魔力,从保障水质纯净到优化信息获取,从净化空气到筛选数据。它就像一位无声的守护者,默默为我们的生活与工作筑起安全、高效的屏障。希望这篇博客能让你对身边无处不在的过滤器有全新的认识,并且在未来的日子里,当你面对繁杂与混沌时,也能想起这些精巧装置背后的智慧,巧用 “过滤” 思维,拥抱更优质的生活。愿我们都能在过滤后的世界里,找到属于自己的那片清澈天地。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值