SpringBoot之过滤器Filter详解及登录校验

古城微笑少年丶 2024-03-23 14:39 54阅读 0赞

**目录**

1 快速入门

2.Filter详解

2.1 执行流程

2.2 拦截路径

2.3 过滤器链

3.登录校验-Filter

3.1 分析

3.2 具体流程

3.3 代码实现

--------------------

### 1 快速入门 ###

什么是Filter？

*  Filter表示过滤器，是 JavaWeb三大组件(Servlet、Filter、Listener)之一。
 *  过滤器可以把对资源的请求拦截下来，从而实现一些特殊的功能
    
     *  使用了过滤器之后，要想访问web服务器上的资源，必须先经过滤器，过滤器处理完毕之后，才可以访问对应的资源。
 *  过滤器一般完成一些通用的操作，比如：登录校验、统一编码处理、敏感字符处理等。

![bc29232243234c09ba192ad3940e2f13.png][]

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

*  第1步，定义过滤器 ：1.定义一个类，实现 Filter 接口，并重写其所有方法。
 *  第2步，配置过滤器：Filter类上加 @WebFilter 注解，配置拦截资源的路径。引导类上加 @ServletComponentScan 开启Servlet组件支持。

**定义过滤器**

//定义一个类，实现一个标准的Filter过滤器的接口
    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 销毁方法执行了");
        }
    }

>  *  init方法：过滤器的初始化方法。在web服务器启动的时候会自动的创建Filter过滤器对象，在创建过滤器对象的时候会自动调用init初始化方法，这个方法只会被调用一次。
>  *  doFilter方法：这个方法是在每一次拦截到请求之后都会被调用，所以这个方法是会被调用多次的，每拦截到一次请求就会调用一次doFilter()方法。
>  *  destroy方法： 是销毁的方法。当我们关闭服务器的时候，它会自动的调用销毁方法destroy，而这个销毁方法也只会被调用一次。

在定义完Filter之后，Filter其实并不会生效，还需要完成Filter的配置，Filter的配置非常简单，只需要在Filter类上添加一个注解：@WebFilter，并指定属性urlPatterns，通过这个属性指定过滤器要拦截哪些请求

@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);
        }
    
    }

重新启动服务，打开浏览器，执行部门管理的请求，可以看到控制台输出了过滤器中的内容：

![730c6f83d707433ba0753d316b84ee4a.png][]

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

### 2.Filter详解 ###

Filter过滤器的快速入门程序我们已经完成了，接下来我们就要详细的介绍一下过滤器Filter在使用中的一些细节。主要介绍以下3个方面的细节：

1.  过滤器的执行流程
2.  过滤器的拦截路径配置
3.  过滤器链

#### 2.1 执行流程 ####

首先我们先来看下过滤器的执行流程：

![ab50e4d99f4a46d5875077dc1bd4f858.png][]

过滤器当中我们拦截到了请求之后，如果希望继续访问后面的web资源，就要执行放行操作，放行就是调用 FilterChain对象当中的doFilter()方法，在调用doFilter()这个方法之前所编写的代码属于放行之前的逻辑。

在放行后访问完 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 销毁方法执行了");
        }
    }

![f00ed8db30f246bfa4dcaa913d47c886.png][]

#### 2.2 拦截路径 ####

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

<table> 
 <thead> 
  <tr> 
   <th>拦截路径</th> 
   <th>urlPatterns值</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>拦截具体路径</td> 
   <td>/login</td> 
   <td>只有访问 /login 路径时，才会被拦截</td> 
  </tr> 
  <tr> 
   <td>目录拦截</td> 
   <td>/emps/*</td> 
   <td>访问/emps下的所有资源，都会被拦截</td> 
  </tr> 
  <tr> 
   <td>拦截所有</td> 
   <td>/*</td> 
   <td>访问所有资源，都会被拦截</td> 
  </tr> 
 </tbody> 
</table>

下面我们来测试"拦截具体路径"：

@WebFilter(urlPatterns = "/login")  //拦截/login具体路径
    public class DemoFilter implements Filter {
        @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 init(FilterConfig filterConfig) throws ServletException {
            Filter.super.init(filterConfig);
        }
    
        @Override
        public void destroy() {
            Filter.super.destroy();
        }
    }

访问登录请求/login，发现过滤器拦截请求

![8610ec1391e24b219a31625c7cd8ec97.png][]

下面我们来测试"目录拦截"：

@WebFilter(urlPatterns = "/depts/*") //拦截所有以/depts开头，后面是什么无所谓
    public class DemoFilter implements Filter {
        @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 init(FilterConfig filterConfig) throws ServletException {
            Filter.super.init(filterConfig);
        }
    
        @Override
        public void destroy() {
            Filter.super.destroy();
        }
    }

访问部门管理请求，发现过滤器拦截了请求

![cc2b10d2de8143fdb7114808824ec016.png][]

访问登录请求/login，发现过滤器没有拦截请求

![0e6719b204bd43249b92391766e88915.png][]

#### 2.3 过滤器链 ####

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

![d914276997874c9b8e081e1d91876ffd.png][]

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

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

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

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

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

验证步骤：

1.  在filter包下再来新建一个Filter过滤器类：AbcFilter
2.  在AbcFilter过滤器中编写放行前和放行后逻辑
3.  配置AbcFilter过滤器拦截请求路径为：/\*
4.  重启SpringBoot服务，查看DemoFilter、AbcFilter的执行日志

![ef99dcf67d684663a39ee49e91b931f9.png][]

**AbcFilter过滤器**

@WebFilter(urlPatterns = "/*")
    public class AbcFilter implements Filter {
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            System.out.println("Abc 拦截到了请求... 放行前逻辑");
    
            //放行
            chain.doFilter(request,response);
    
            System.out.println("Abc 拦截到了请求... 放行后逻辑");
        }
    }

**DemoFilter过滤器**

@WebFilter(urlPatterns = "/*") 
    public class DemoFilter implements Filter {
        @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   放行后逻辑.....");
        }
    }

打开浏览器访问登录接口：

![7ff95366064b4fe581ca5f5e487d0c28.png][]

通过控制台日志的输出，大家发现AbcFilter先执行DemoFilter后执行，这是为什么呢？

其实是和过滤器的类名有关系。以注解方式配置的Filter过滤器，它的执行优先级是按时过滤器类名的自动排序确定的，类名排名越靠前，优先级越高。

假如我们想让DemoFilter先执行，怎么办呢？答案就是修改类名。

测试：修改AbcFilter类名为XbcFilter，运行程序查看控制台日志

@WebFilter(urlPatterns = "/*")
    public class XbcFilter implements Filter {
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            System.out.println("Xbc 拦截到了请求...放行前逻辑");
    
            //放行
            chain.doFilter(request,response);
    
            System.out.println("Xbc 拦截到了请求...放行后逻辑");
        }
    }

![14ada54401914af786ce7672ba3cb30e.png][]

### 3.登录校验-Filter ###

#### 3.1 分析 ####

![76d6e8d6be8747ed8b774bee68f464a1.png][]

我们先来回顾下前面分析过的登录校验的基本流程：

*  要进入到后台管理系统，我们必须先完成登录操作，此时就需要访问登录接口login。
 *  登录成功之后，我们会在服务端生成一个JWT令牌，并且把JWT令牌返回给前端，前端会将JWT令牌存储下来。
 *  在后续的每一次请求当中，都会将JWT令牌携带到服务端，请求到达服务端之后，要想去访问对应的业务功能，此时我们必须先要校验令牌的有效性。
 *  对于校验令牌的这一块操作，我们使用登录校验的过滤器，在过滤器当中来校验令牌的有效性。如果令牌是无效的，就响应一个错误的信息，也不会再去放行访问对应的资源了。如果令牌存在，并且它是有效的，此时就会放行去访问对应的web资源，执行相应的业务操作。

大概清楚了在Filter过滤器的实现步骤了，那在正式开发登录校验过滤器之前，我们思考两个问题：

1.  所有的请求，拦截到了之后，都需要校验令牌吗？
    
    答案：**登录请求例外**
2.  拦截到请求后，什么情况下才可以放行，执行业务操作？
    
    答案：**有令牌，且令牌校验通过(合法)；否则都返回未登录错误结果**

#### 3.2 具体流程 ####

我们要完成登录校验，主要是利用Filter过滤器实现，而Filter过滤器的流程步骤：

![02064f4bfa694f05987671cd42657f68.png][]

基于上面的业务流程，我们分析出具体的操作步骤：

1.  获取请求url
2.  判断请求url中是否包含login，如果包含，说明是登录操作，放行
3.  获取请求头中的令牌（token）
4.  判断令牌是否存在，如果不存在，返回错误结果（未登录）
5.  解析token，如果解析失败，返回错误结果（未登录）
6.  放行

#### 3.3 代码实现 ####

**在下述过滤器的功能实现中，我们使用到了一个第三方json处理的工具包fastjson。我们要想使用，需要引入如下依赖：**

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.76</version>
    </dependency>

**登录校验过滤器：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
    
    
            //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);
    
        }
    }

**JWT工具类**

public class JwtUtils {
    
        private static String signKey = "itheima";//签名密钥
        private static Long expire = 43200000L; //有效时间
    
        /**
         * 生成JWT令牌
         * @param claims JWT第二部分负载 payload 中存储的内容
         * @return
         */
        public static String generateJwt(Map<String, Object> claims){
            String jwt = Jwts.builder()
                    .addClaims(claims)//自定义信息（有效载荷）
                    .signWith(SignatureAlgorithm.HS256, signKey)//签名算法（头部）
                    .setExpiration(new Date(System.currentTimeMillis() + expire))//过期时间
                    .compact();
            return jwt;
        }
    
        /**
         * 解析JWT令牌
         * @param jwt JWT令牌
         * @return JWT第二部分负载 payload 中存储的内容
         */
        public static Claims parseJWT(String jwt){
            Claims claims = Jwts.parser()
                    .setSigningKey(signKey)//指定签名密钥
                    .parseClaimsJws(jwt)//指定令牌Token
                    .getBody();
            return claims;
        }
    }

####  ####

[bc29232243234c09ba192ad3940e2f13.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/b5b0323910fc4ef3a0ef5511855e6e64.png
[730c6f83d707433ba0753d316b84ee4a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/27cf83dc47854f71892fca372c83a08b.png
[ab50e4d99f4a46d5875077dc1bd4f858.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/d865b45b5f0447e7855a6a55fa153680.png
[f00ed8db30f246bfa4dcaa913d47c886.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/578ce9f570104ef3af5d460db694b428.png
[8610ec1391e24b219a31625c7cd8ec97.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/87517d21e29d4174bfd8ca375d15b6c6.png
[cc2b10d2de8143fdb7114808824ec016.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/9da9ce6c0c74470196ae20c58629e5cd.png
[0e6719b204bd43249b92391766e88915.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/88a4492f96b14dc1a5dfeb4beaec5f5b.png
[d914276997874c9b8e081e1d91876ffd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/6ceca2f423fd4b46a0ad45a706247be6.png
[ef99dcf67d684663a39ee49e91b931f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/495d4aca2e994accabba575e75e174cb.png
[7ff95366064b4fe581ca5f5e487d0c28.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/959cc58c205245088d8d526761c32448.png
[14ada54401914af786ce7672ba3cb30e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/697f5229528543e28fe4d66e8f6112c7.png
[76d6e8d6be8747ed8b774bee68f464a1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/077d8f0eb8aa49ac880ac5e0287f28f2.png
[02064f4bfa694f05987671cd42657f68.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/32e768c0fa14458ebb4fd4be11c43405.png