- Filter过滤器
- Interceptor拦截器
1.Filter基础
1.1什么是Filter？
- Filter表示过滤器，是 JavaWeb三大组件(Servlet、Filter、Listener)之一。顾名思义，就是过滤。
- 过滤器可以把对资源的请求拦截下来，从而实现一些特殊的功能
- 使用了过滤器之后，要想访问web服务器上的资源，必须先经过滤器，过滤器处理完毕之后，才可以访问对应的资源。
- 过滤器一般完成一些通用的操作，比如：登录校验、统一编码处理、敏感字符处理等。
1.1Filter的生命周期
Filter的生命周期与Servlet的生命周期类似，其主要生命周期阶段有四个，Filter对象的创建、Filter对象的初始化、Filter执行doFilter()方法，以及最终Filter对象被销毁。
Filter的整个生命周期过程的执行，均由Web服务器负责管理，即Filter从创建到销毁的整个过程中的方法的调用，都是有Web服务器负责执行，程序员无法控制其执行流程。
1.2Filter的基本使用
- 第1步，定义过滤器 ：1.定义一个类，实现 Filter 接口，并重写其所有方法。
- 第2步，配置过滤器：Filter类上加 @WebFilter 注解，配置拦截资源的路径。引导java serlvett基础知识类上加 @ServletComponentScan 开启Servlet组件支持。
定义过滤器
- Filters是单例多线程的
- init方法：过滤器的初始化方法。在web服务器启动的时候会自动的创建Filter过滤器对象，在创建过滤器对象的时候会自动调用init初始化方法，这个方法只会被调用一次。
- doFilter方法：这个方法是在每一次拦截到请求之后都会被调用，所以这个方法是会被调用多次的，每拦截到一次请求就会调用一次doFilter()方法。
- destroy方法： 是销毁的方法。当我们关闭服务器的时候，它会自动的调用销毁方法destroy，而这个销毁方法也只会被调用一次。
在定义完Filter之后，Filter其实并不会生效，还需要完成Filter的配置，Filter的配置非常简单，只需要在Filter类上添加一个注解：@WebFilter，并指定属性urlPatterns，通过这个属性指定过滤器要拦截哪些请求
当我们在Filter类上面加了@WebFilter注解之后，接下来我们还需要在启动类上面加上一个注解@ServletComponentScan，通过这个@ServletComponentScan注解来开启SpringBoot项目对于Servlet组件的支持。
注意事项：
2.Filter详解
Filter过滤器的快速入门程序我们已经完成了，接下来我们就要详细的介绍一下过滤器Filter在使用中的一些细节。主要介绍以下3个方面的细节：
- 过滤器的执行流程
- 过滤器的拦截路径配置
- 过滤器链
2.1 执行流程
首先我们先来看下过滤器的执行流程：
过滤器当中我们拦截到了请求之后，如果希望继续访问后面的web资源，就要执行放行操作，放行就是调用 FilterChain对象当中的doFilter()方法，在调用doFilter()这个方法之前所编写的代码属于放行之前的逻辑。
在放行后访问完 web 资源之后还会回到过滤器当中，回到过滤器之后如有需求还可以执行放行之后的逻辑，放行之后的逻辑我们写在doFilter()这行代码之后。
2.2 拦截路径
执行流程我们搞清楚之后，接下来再来介绍一下过滤器的拦截路径，Filter可以根据需求，配置不同的拦截资源路径：
下面我们来测试"拦截具体路径"：
测试1：访问部门管理请求，发现过滤器没有拦截请求
测试2：访问登录请求/login，发现过滤器拦截请求
下面我们来测试"目录拦截"：
测试1：访问部门管理请求，发现过滤器拦截了请求
测试2：访问登录请求/login，发现过滤器没有拦截请求
2.3 过滤器链
最后我们在来介绍下过滤器链，什么是过滤器链呢？所谓过滤器链指的是在一个web应用程序当中，可以配置多个过滤器，多个过滤器就形成了一个过滤器链。
比如：在我们web服务器当中，定义了两个过滤器，这两个过滤器就形成了一个过滤器链。
而这个链上的过滤器在执行的时候会一个一个的执行，会先执行第一个Filter，放行之后再来执行第二个Filter，如果执行到了最后一个过滤器放行之后，才会访问对应的web资源。
访问完web资源之后，按照我们刚才所介绍的过滤器的执行流程，还会回到过滤器当中来执行过滤器放行后的逻辑，而在执行放行后的逻辑的时候，顺序是反着的。
先要执行过滤器2放行之后的逻辑，再来执行过滤器1放行之后的逻辑，最后在给浏览器响应数据。
以上就是当我们在web应用当中配置了多个过滤器，形成了这样一个过滤器链以及过滤器链的执行顺序。下面我们通过idea来验证下过滤器链。
验证步骤：
- 在filter包下再来新建一个Filter过滤器类：AbcFilter
- 在AbcFilter过滤器中编写放行前和放行后逻辑
- 配置AbcFilter过滤器拦截请求路径为：/*
- 重启SpringBoot服务，查看DemoFilter、AbcFilter的执行日志
AbcFilter过滤器
DemoFilter过滤器
打开浏览器访问登录接口：
通过控制台日志的输出，大家发现AbcFilter先执行DemoFilter后执行，这是为什么呢？
其实是和过滤器的类名有关系。以注解方式配置的Filter过滤器，它的执行优先级是按时过滤器类名的自动排序确定的，类名排名越靠前，优先级越高。
假如我们想让DemoFilter先执行，怎么办呢？答案就是修改类名。
测试：修改AbcFilter类名为XbcFilter，运行程序查看控制台日志
到此，关于过滤器的使用细节，我们已经全部介绍完毕了。
2.4.3 登录校验-Filter
2.4.3.1 分析
过滤器Filter的快速入门以及使用细节我们已经介绍完了，接下来最后一步，我们需要使用过滤器Filter来完成案例当中的登录校验功能。
我们先来回顾下前面分析过的登录校验的基本流程：
- 要进入到后台管理系统，我们必须先完成登录操作，此时就需要访问登录接口login。
- 登录成功之后，我们会在服务端生成一个JWT令牌，并且把JWT令牌返回给前端，前端会将JWT令牌存储下来。
- 在后续的每一次请求当中，都会将JWT令牌携带到服务端，请求到达服务端之后，要想去访问对应的业务功能，此时我们必须先要校验令牌的有效性。
- 对于校验令牌的这一块操作，我们使用登录校验的过滤器，在过滤器当中来校验令牌的有效性。如果令牌是无效的，就响应一个错误的信息，也不会再去放行访问对应的资源了。如果令牌存在，并且它是有效的，此时就会放行去访问对应的web资源，执行相应的业务操作。
大概清楚了在Filter过滤器的实现步骤了，那在正式开发登录校验过滤器之前，我们思考两个问题：
- 所有的请求，拦截到了之后，都需要校验令牌吗？
- 答案：登录请求例外
- 拦截到请求后，什么情况下才可以放行，执行业务操作？
- 答案：有令牌，且令牌校验通过(合法)；否则都返回未登录错误结果
2.4.3.2 具体流程
我们要完成登录校验，主要是利用Filter过滤器实现，而Filter过滤器的流程步骤：
基于上面的业务流程，我们分析出具体的操作步骤：
- 获取请求url
- 判断请求url中是否包含login，如果包含，说明是登录操作，放行
- 获取请求头中的令牌（token）
- 判断令牌是否存在，如果不存在，返回错误结果（未登录）
- 解析token，如果解析失败，返回错误结果（未登录）
- 放行
2.4.3.3 代码实现
分析清楚了以上的问题后，我们就参照接口文档来开发登录功能了，登录接口描述如下：
- 基本信息
- 请求参数
参数格式：application/json
参数说明：
名称类型是否必须备注usernamestring必须用户名passwordstring必须密码请求数据样例：
- 响应数据
参数格式：application/json
参数说明：
名称类型是否必须默认值备注其他信息codenumber必须响应码, 1 成功 ; 0 失败msgstring非必须提示信息datastring必须返回的数据 , jwt令牌响应数据样例：
- 备注说明
用户登录成功后，系统会自动下发JWT令牌，然后在后续的每次请求中，都需要在请求头header中携带到服务端，请求头的名称为 token ，值为 登录时下发的JWT令牌。
如果检测到用户未登录，则会返回如下固定错误信息：
登录校验过滤器：LoginCheckFilter
在上述过滤器的功能实现中，我们使用到了一个第三方json处理的工具包fastjson。我们要想使用，需要引入如下依赖：
登录校验的过滤器我们编写完成了，接下来我们就可以重新启动服务来做一个测试：
测试前先把之前所编写的测试使用的过滤器，暂时注释掉。直接将@WebFilter注解给注释掉即可。
- 测试1：未登录是否可以访问部门管理页面
由于用户没有登录，登录校验过滤器返回错误信息，前端页面根据返回的错误信息结果，自动跳转到登录页面了
- 测试2：先进行登录操作，再访问部门管理页面
登录校验成功之后，可以正常访问相关业务操作页面
版权声明：
本文来源网络，所有图片文章版权属于原作者，如有侵权，联系删除。
本文网址：https://www.bianchenghao6.com/h6javajc/25619.html