springboot整合过滤器实战步骤

 更新时间:2022年04月13日 07:58:59   作者:小z♀  
在项目开发过程中,过滤器或者拦截器几乎是必用的,他可以很方便的完成类似日志处理、token验证等一系列操作,区别于业务接口,独立进行处理,感觉就是一种Aop思想。下面模拟请求接口前的token验证,进行过滤器的实战

下面先建立一个MVC的基本请求接口,如下:

一、普通的接口访问

如上,先新增一个testController。

先用postman测试一下通不通。

结果是通的,准备工作完成。

二、增加一个过滤器

下面增加一个过滤器来实现一个接口拦截并处理token校验的模拟。

简单处理,有如下两个步骤。

1、自定义过滤器

package com.example.demo_filter_interceptor.config;
 
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
 
/**
 * @Classname TestFilter
 * @Description TODO
 * @Date 2022/4/11 19:30
 * @Created by zrc
 */
//实现Filter接口,基于回调的方式,类似ajax请求的success。
public class TestFilter implements Filter {
 
    //init方法,初始化过滤器,可以在init()方法中完成与构造方法类似的初始化功能,
    //如果初始化代码中要使用到FillerConfig对象,那么这些初始化代码就只能在Filler的init()方法中编写而不能在构造方法中编写
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
        System.out.println("第一个过滤器成功初始化。。。。。。。。。。。。。");
    }
 
    //doFilter()方法有多个参数,其中
    //参数request和response为Web服务器或Filter链中的上一个Filter传递过来的请求和响应对象;
    //参数chain代表当前Filter链的对象,
    //只有在当前Filter对象中的doFilter()方法内部需要调用FilterChain对象的doFilter()法才能把请求交付给Filter链中的下一个Filter或者目标程序处理
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest req = (HttpServletRequest) servletRequest;
        //这里为了使用getHeader方法获取token,转型成HttpServletRequest
        System.out.println("token:"+req.getHeader("token"));
        String token = req.getHeader("token");
        //再判断token是否正确
        if(null==token){
            throw new RuntimeException("token为空");
        }
        //调用doFilter方法,正常返回servletResponse
        filterChain.doFilter(servletRequest, servletResponse);
    }
 
    //destroy()方法在Web服务器卸载Filter对象之前被调用,该方法用于释放被Filter对象打开的资源,例如关闭数据库和I/O流
    @Override
    public void destroy() {
        Filter.super.destroy();
        System.out.println("过滤器被销毁");
    }
}

实现servlet的Filter接口,并重写他的三个方法,分别是init,doFilter,destroy。

  • init:过滤器初始化时回调,可以在这里做过滤器的初始化操作,例如设置白名单路径列表。
  • doFilter:过滤器初始化后并在请求到达后端且进入到注册过滤器设置的匹配路径时回调。
  • destroy:过滤器销毁时回调。

上图是一个简单实现token校验是否为空,没有进行正确与否的校验,可以引入redis(前面章节有讲到)或者其他的存储,然后进行一个正确性的校验。从request中获取token头,若存在则调用doFilter方法(通过过滤器),否则不作操作(就是不通过过滤器,不会抵达controller)。

2、注册到容器

@Configuration
public class TestFilterConfig {
 
    @Bean
    public FilterRegistrationBean filterRegistrationBean(){
        //创建一个注册过滤器对象
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();
        //设置自定义过滤器
        registrationBean.setFilter(new TestFilter());
        //设置过滤拦截匹配规则,/*是匹配所有
//        registrationBean.addUrlPatterns("/*");
        //只拦截testController下面的接口
        registrationBean.addUrlPatterns("/testController/*");
        //存在多个过滤器时,设置执行顺序,值越大,执行顺序越靠后
        registrationBean.setOrder(2);
        //返回这个注册过滤器对象
        return registrationBean;
    }
 
}

将自定义过滤器注册到容器中,通过FilterRegistrationBean的一系列方法设置过滤器的参数,例如需要过滤的路径,过滤器的优先级等等。

3、演示一下效果:

不带token:

带token:

三、增加两个过滤器

下面再整一下当存在多个过滤器时,怎么设置哪一个过滤器先拦截,哪一个后执行(优先级)。

跟第二节一样,再整一个自定义过滤器。

package com.example.demo_filter_interceptor.config;
 
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
 
/**
 * @Classname TestFilter
 * @Description TODO
 * @Date 2022/4/11 19:30
 * @Created by zrc
 */
//实现Filter接口,基于回调的方式,类似ajax请求的success。
public class TestFilter2 implements Filter {
 
    //init方法,初始化过滤器,可以在init()方法中完成与构造方法类似的初始化功能,
    //如果初始化代码中要使用到FillerConfig对象,那么这些初始化代码就只能在Filler的init()方法中编写而不能在构造方法中编写
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
        System.out.println("第二个过滤器成功初始化。。。。。。。。。。。。。");
    }
 
    //doFilter()方法有多个参数,其中
    //参数request和response为Web服务器或Filter链中的上一个Filter传递过来的请求和响应对象;
    //参数chain代表当前Filter链的对象,
    //只有在当前Filter对象中的doFilter()方法内部需要调用FilterChain对象的doFilter()法才能把请求交付给Filter链中的下一个Filter或者目标程序处理
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("这里是第一顺序的拦截器");
        filterChain.doFilter(servletRequest, servletResponse);
    }
 
    //destroy()方法在Web服务器卸载Filter对象之前被调用,该方法用于释放被Filter对象打开的资源,例如关闭数据库和I/O流
    @Override
    public void destroy() {
        Filter.super.destroy();
        System.out.println("过滤器被销毁");
    }
}

修改注册过滤器的类。

类似第一个过滤器的注册,再注册一个第二个过滤器即可,可以设置不同的拦截路径,各负责各的逻辑处理,此处只演示一下执行顺序问题,第一个设置Order参数为2,第二个设置为1,越大的越后执行。设置后,用postman测试一下。

调用接口后发现,先进入了第一个过滤器的doFilter方法,再进入的第二个过滤器的doFilter方法,验证order参数是有效的。

到此这篇关于springboot整合过滤器实战的文章就介绍到这了,更多相关springboot整合过滤器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 将Java程序的输出结果写到txt文件中的方法

    将Java程序的输出结果写到txt文件中的方法

    今天小编就为大家分享一篇将Java程序的输出结果写到txt文件中的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07
  • Java处理时间格式CST和GMT转换方法示例

    Java处理时间格式CST和GMT转换方法示例

    这篇文章主要给大家介绍了关于Java处理时间格式CST和GMT转换方法的相关资料,相信很多小伙伴在时间格式转换的时候非常头疼,文中通过代码示例介绍的非常详细,需要的朋友可以参考下
    2023-09-09
  • 两种java实现二分查找的方式

    两种java实现二分查找的方式

    这篇文章主要给大家分享的是java实现二分查找的方式,二分查找是一种查询效率非常高的查找算法。又称折半查找。下面文章我们介绍了两种方法,需要的朋友可以参考一下
    2021-09-09
  • springboot项目访问图片的3种实现方法(亲测可用)

    springboot项目访问图片的3种实现方法(亲测可用)

    本文主要介绍了springboot项目访问图片的3种实现方法,通过springboot项目访问除项目根目录之外的其它目录的图片,具有一定的参考价值,感兴趣的可以了解一下
    2023-09-09
  • Java基于装饰者模式实现的染色馒头案例详解

    Java基于装饰者模式实现的染色馒头案例详解

    这篇文章主要介绍了Java基于装饰者模式实现的染色馒头案例,简单描述了装饰者模式的概念、原理及Java使用装饰者模式的相关实现步骤、操作技巧与注意事项,需要的朋友可以参考下
    2018-05-05
  • Java基础教程之字符流文件读写

    Java基础教程之字符流文件读写

    这篇文章主要给大家介绍了关于Java基础教程之字符流文件读写的相关资料,,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-07-07
  • JAVA多线程与并发学习总结分析

    JAVA多线程与并发学习总结分析

    以下是对小编对JAVA多线程与并发的学习进行了总结介绍,需要的朋友可以过来参考下
    2013-08-08
  • 一文带你彻底剖析Java中Synchronized原理

    一文带你彻底剖析Java中Synchronized原理

    Synchronized是Java中的隐式锁,它的获取锁和释放锁都是隐式的,完全交由JVM帮助我们操作,在了解Synchronized关键字之前,首先要学习的知识点就是Java的对象结构,本文介绍的非常详细,需要的朋友可以参考下
    2023-05-05
  • BaseMapper接口的使用方法

    BaseMapper接口的使用方法

    这篇文章主要介绍了BaseMapper接口的使用方法,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2023-12-12
  • java多线程模拟交通灯管理系统

    java多线程模拟交通灯管理系统

    这篇文章主要为大家详细介绍了java多线程模拟交通灯管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-08-08

最新评论