如何在SpringBoot项目中使用过滤器和拦截器

简介: 过滤器和拦截器是日常开发中常用技术,用于对特定请求进行增强处理,如插入自定义代码以实现特定功能。过滤器在请求到达 `servlet` 前执行,而拦截器在请求到达 `servlet` 后执行。`SpringBoot` 中的拦截器依赖于 `SpringBoot` 容器,过滤器则由 `servlet` 提供。通过实现 `Filter` 接口并重写 `doFilter()` 方法可实现过滤器;通过实现 `HandlerInterceptor` 接口并重写相应方法可实现拦截器。两者的主要区别在于执行时机的不同,需根据具体场景选择使用。

过滤器和拦截器都是日常开发中经常使用到的技术,他们都可以对特定的请求进行增强处理,比如在请求之前或之后插入自定义的代码,完成想要的功能。过滤器和拦截器最本质的区别是,过滤器是在请求到达servlet之前执行,拦截器则在请求到达servlet之后执行。需要注意的是,SpringBoot中的拦截器依赖于SpringBoot容器,而过滤器是servlet本身提供的。

过滤器的实现

过滤器依赖servlet中的Filter接口,自定义一个Filter的实现类,重写doFilter()方法

java

代码解读

复制代码

@Component
public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("hello");
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("world");
    }
}

filterChain.doFilter(servletRequest,servletResponse);这个方法的作用是放行请求,在这条语句的前后可以做一些自定义的操作,比如记录日志、定义请求和返回的字符集编码、或者对请求的参数进行处理等。现在过滤器还不能使用,因为SpringBoot的过滤器依赖其提供的过滤器链,所以要先把自定义的过滤器注册到过滤器链中。

java

代码解读

复制代码

@Configuration
public class WebConfig {
    private final MyFilter myFilter;
    @Autowired
    public WebConfig(MyFilter myFilter){
        this.myFilter = myFilter;
    }
    @Bean
    public FilterRegistrationBean<MyFilter> registFilter(){
        FilterRegistrationBean<MyFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(myFilter);
        registrationBean.addUrlPatterns("/*");
        registrationBean.setOrder(1);
        return registrationBean;
    }
}

上面的配置类中,我们将MyFilter对象注册到FilterRegistrationBean中,可以理解为通过FilterRegistrationBean将自定义的过滤器注册到了过滤器链中。setOrder(int)的作用是设置过滤器在过滤器链中的执行顺序,直越小顺序越靠前。addUrlPatterns(String... param)方法用来设置要拦截的请求路径。现在请求项目中的任意接口,都会在请求前打印hello,在请求后打印world

拦截器的实现

拦截器是基于SpringBootdispatcherServlet的处理器Handler拦截器实现的,直接上代码

java

代码解读

复制代码

@Component
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("请求前执行");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("返回ModelAndView前执行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("处理完请求后执行");
    }
}

上面是自定义的拦截器,重写了处理器拦截器接口的preHandlepostHandleafterCompletion方法,分别表示请求前执行返回ModelAndView前执行处理完请求后执行,然后同样的需要将拦截器注册到拦截器链中,代码如下

java

代码解读

复制代码

@Configuration
public class WebConfig implements WebMvcConfigurer {
    private final MyFilter myFilter;
    private final MyInterceptor myInterceptor;

    @Autowired
    public WebConfig(MyFilter myFilter,
                     MyInterceptor myInterceptor){
        this.myFilter = myFilter;
        this.myInterceptor = myInterceptor;
    }
    @Bean
    public FilterRegistrationBean<MyFilter> registFilter(){
        FilterRegistrationBean<MyFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(myFilter);
        registrationBean.addUrlPatterns("/*");
        registrationBean.setOrder(1);
        return registrationBean;
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor).
                addPathPatterns("/**").order(1);
    }
}

直接沿用了自定义过滤器的配置类,并实现SpringMvc的配置接口WebMvcConfigurer,重写addInterceptors()方法,将我们自定义的拦截器注册到拦截器链中,同样的,也可以使用order()方法设置拦截器的在链中的执行顺序,值越小则优先级越高。addPathPatterns("/**")表示拦截任意请求。

测试拦截器和过滤器

编写一个测试Controller

java

代码解读

复制代码

@RestController
@RequestMapping("/sys")
public class SysUserController {
    @GetMapping(value = "/test")
    public String test() {
        return "200";
    }
}

上面的接口路径既符合过滤器的过滤条件,也符合拦截器的拦截条件,使用postman工具请求测试

控制台打印的数据如下图所示:

可以看到先执行了过滤器的请求前置代码打印了hello,然后过滤器放行后才进入到servlet控制层执行了控制器的前置、中置及后置方法,最后当控制层处理完请求后,最后才执行了过滤器中的请求后置代码打印了world

总结

  • 过滤器是在servlet之外执行的,过滤器的代码只会在servlet外层执行
  • 拦截器是基于servlet的处理器handler的,所以拦截器会在控制器处理器这一层执行
  • 过滤器和拦截器的主要区别是执行的时机不同,虽然他们的作用相似,但是在实际开发中,要根据具体的场景,在两者中做出更合适的选择


转载来源:https://juejin.cn/post/7407621980574990399

相关文章
|
2天前
|
前端开发 Java
表白墙/留言墙 —— 初级SpringBoot项目,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
文章通过一个表白墙/留言墙的初级SpringBoot项目实例,详细讲解了如何进行前后端开发,包括定义前后端交互接口、创建SpringBoot项目、编写前端页面、后端代码逻辑及实体类封装的全过程。
12 3
表白墙/留言墙 —— 初级SpringBoot项目,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
|
1天前
|
前端开发 Java Apache
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
本文详细讲解了如何整合Apache Shiro与Spring Boot项目,包括数据库准备、项目配置、实体类、Mapper、Service、Controller的创建和配置,以及Shiro的配置和使用。
24 1
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
|
2天前
|
前端开发 Java 数据安全/隐私保护
用户登录前后端开发(一个简单完整的小项目)——SpringBoot与session验证(带前后端源码)全方位全流程超详细教程
文章通过一个简单的SpringBoot项目,详细介绍了前后端如何实现用户登录功能,包括前端登录页面的创建、后端登录逻辑的处理、使用session验证用户身份以及获取已登录用户信息的方法。
26 2
用户登录前后端开发(一个简单完整的小项目)——SpringBoot与session验证(带前后端源码)全方位全流程超详细教程
|
8天前
|
Java 关系型数据库 数据库连接
SpringBoot项目使用yml文件链接数据库异常
【10月更文挑战第3天】Spring Boot项目中数据库连接问题可能源于配置错误或依赖缺失。YAML配置文件的格式不正确,如缩进错误,会导致解析失败;而数据库驱动不匹配、连接字符串或认证信息错误同样引发连接异常。解决方法包括检查并修正YAML格式,确认配置属性无误,以及添加正确的数据库驱动依赖。利用日志记录和异常信息分析可辅助问题排查。
30 10
|
1天前
|
NoSQL Java MongoDB
Springboot WebFlux项目结合mongodb进行crud
这篇文章介绍了如何使用Spring Boot WebFlux框架结合MongoDB进行基本的CRUD(创建、读取、更新、删除)操作,包括项目设置、实体类和Repository的创建、控制器的实现以及配置文件的编写。
6 0
Springboot WebFlux项目结合mongodb进行crud
|
2天前
|
前端开发 Java 数据库连接
表白墙/留言墙 —— 中级SpringBoot项目,MyBatis技术栈MySQL数据库开发,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
本文是一份全面的表白墙/留言墙项目教程,使用SpringBoot + MyBatis技术栈和MySQL数据库开发,涵盖了项目前后端开发、数据库配置、代码实现和运行的详细步骤。
7 0
表白墙/留言墙 —— 中级SpringBoot项目,MyBatis技术栈MySQL数据库开发,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
|
2天前
|
Java Maven Spring
SpringBoot项目创建失败或无法启动,启动报错时的常见问题及解决方案
文章列举了在IDEA中创建Spring Boot项目时可能遇到的常见问题及其解决方案,如项目不被识别为Maven项目、依赖未找到或报红、JDK版本不一致和POM文件中的Jar包下载失败等问题。
6 0
SpringBoot项目创建失败或无法启动,启动报错时的常见问题及解决方案
|
7天前
|
Java 关系型数据库 MySQL
SpringBoot项目使用yml文件链接数据库异常
【10月更文挑战第4天】本文分析了Spring Boot应用在连接数据库时可能遇到的问题及其解决方案。主要从四个方面探讨:配置文件格式错误、依赖缺失或版本不兼容、数据库服务问题、配置属性未正确注入。针对这些问题,提供了详细的检查方法和调试技巧,如检查YAML格式、验证依赖版本、确认数据库服务状态及用户权限,并通过日志和断点调试定位问题。
|
12天前
|
JavaScript 前端开发 Java
SpringBoot项目的html页面使用axios进行get post请求
SpringBoot项目的html页面使用axios进行get post请求
31 6
|
7天前
|
存储 NoSQL Java
Spring Boot项目中使用Redis实现接口幂等性的方案
通过上述方法,可以有效地在Spring Boot项目中利用Redis实现接口幂等性,既保证了接口操作的安全性,又提高了系统的可靠性。
10 0