Spring Boot 监听器、拦截器以及过滤器的作用、差异?

简介: Spring Boot 监听器、拦截器以及过滤器的作用、差异?

Spring Boot 常用的增强功能之一就是支持监听器、拦截器以及过滤器。这些功能为我们提供了在应用程序运行时对请求和响应进行操作的机制。本文将详细介绍 Spring Boot 监听器、拦截器以及过滤器的作用、差异以及如何使用。

监听器

监听器是一种组件,它可以监听应用程序中发生的各种事件,并在某个事件触发时执行代码。在 Spring Boot 中,我们可以通过实现 ApplicationListener 接口或者使用 @EventListener 注解来编写监听器。常用的事件包括应用程序启动、上下文创建、上下文刷新、上下文关闭等。

下面是一个简单的示例,演示了如何编写一个 Spring Boot 监听器:

@Component
public class MyAppListener implements ApplicationListener<ApplicationEvent> {
   

    @Override
    public void onApplicationEvent(ApplicationEvent event) {
   
        if (event instanceof ContextRefreshedEvent) {
   
            System.out.println("Application context refreshed event received.");
        }
    }
}

上述监听器类实现了 ApplicationListener 接口,并重写了 onApplicationEvent 方法,用以对指定事件进行处理。在本例中,该监听器仅对应用程序上下文刷新事件做出响应,并在该事件触发时打印一条日志。

拦截器

拦截器是一种组件,它可以截获 HTTP 请求和响应,并在请求前后执行一些操作。拦截器通常用于身份验证、日志记录、性能分析等。在 Spring Boot 中,我们可以通过实现 HandlerInterceptor 接口或者继承 HandlerInterceptorAdapter 类来编写拦截器。

下面是一个简单的示例,演示了如何编写一个 Spring Boot 拦截器:

@Component
public class MyInterceptor extends HandlerInterceptorAdapter {
   

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
   
        System.out.println("Pre-handle method is called.");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
   
        System.out.println("Post-handle method is called.");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
            Exception ex) throws Exception {
   
        System.out.println("After completion method is called.");
    }
}

上述拦截器类继承了 HandlerInterceptorAdapter 类,并重写了其三个方法:preHandlepostHandleafterCompletion。在本例中,preHandle 方法在请求前被调用,postHandle 方法在请求处理完成后被调用,afterCompletion 方法在视图渲染完成后被调用。

过滤器

过滤器是一种用于对请求和响应实施过滤的组件。它可以拦截 Web 应用程序中的请求,并允许我们在该请求被路由到控制器前或响应被发送到客户端前修改它们。在 Spring Boot 中,我们可以通过实现 Filter 接口来编写过滤器。

下面是一个简单的示例,演示了如何编写一个 Spring Boot 过滤器:

@Component
public class MyFilter implements Filter {
   

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
   
        System.out.println("Filter initialized.");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
   
        System.out.println("Before the request is processed by the servlet.");
        chain.doFilter(request, response);
        System.out.println("After the response is generated by the servlet.");
    }

    @Override
    public void destroy() {
   
        System.out.println("Filter destroyed.");
    }
}

上述过滤器类实现了 Filter 接口,并重写了其三个方法:initdoFilterdestroy。在本例中,init 方法在过滤器被初始化时被调用,doFilter 方法用于拦截请求,并在请求处理完成后生成响应,destroy 方法在过滤器生命周期结束时被调用。

监听器、拦截器、过滤器的区别

尽管监听器、拦截器和过滤器都可以用于拦截请求和响应,并在请求前后执行一些操作,但它们之间还是存在一些区别。下面是一些重要的差异:

  1. 监听器可用于监听应用程序生命周期事件,而拦截器和过滤器则主要用于拦截请求和响应;
  2. 拦截器和过滤器能够读取请求头、请求体、响应头和响应体,而监听器则不能;
  3. 过滤器是 Java Servlet 的标准规范组件,而监听器和拦截器则是 Spring Boot 的扩展组件。

如何使用

在 Spring Boot 中,我们可以通过注解将监听器、拦截器和过滤器添加到应用程序中。下面是一个简单的示例,演示了如何使用 @WebListener 注解和 FilterRegistrationBean 类来添加监听器和过滤器:

@Configuration
public class MyConfig {
   

    @Bean
    public FilterRegistrationBean<MyFilter> myFilter() {
   
        FilterRegistrationBean<MyFilter> registration = new FilterRegistrationBean<>();
        registration.setFilter(new MyFilter());
        registration.addUrlPatterns("/myfilter/*");
        registration.setOrder(1);
        return registration;
    }

    @WebListener
    public class MyAppListener implements ApplicationListener<ApplicationEvent> {
   

        @Override
        public void onApplicationEvent(ApplicationEvent event) {
   
            if (event instanceof ContextRefreshedEvent) {
   
                System.out.println("Application context refreshed event received.");
            }
        }
    }
}

在上述代码中,我们使用 @WebListener 注解来标记一个内部类,该类实现了 ApplicationListener 接口。此外,我们还使用了 FilterRegistrationBean 类,将自定义的过滤器添加到应用程序上下文中。

总结

本文介绍了 Spring Boot 监听器、拦截器和过滤器的作用、差异以及如何使用。监听器、拦截器和过滤器都是 Spring Boot 提供的强大机制,它们为我们提供了灵活的方式来拦截请求和响应,并进行特定操作。掌握这些功能可以使您的应用程序更加灵活、可维护和高效。

目录
相关文章
|
1月前
|
Java Spring 容器
【二十二】springboot整合拦截器实战并对比过滤器
【二十二】springboot整合拦截器实战并对比过滤器
46 0
|
18天前
|
前端开发 Java 程序员
Spring Boot统一功能处理(拦截器, 统一数据返回格式, 统一异常处理)
Spring Boot统一功能处理(拦截器, 统一数据返回格式, 统一异常处理)
26 1
|
1月前
|
SQL 前端开发 Java
SpringBoot 拦截器 统一结果返回 统一异常处理
SpringBoot 拦截器 统一结果返回 统一异常处理
50 0
|
1月前
|
前端开发 Java 数据安全/隐私保护
Spring Boot使用拦截器:概念与实战
【4月更文挑战第29天】拦截器(Interceptors)在Spring Boot应用中常用于在请求处理的前后执行特定的代码,如日志记录、认证校验、权限控制等。本篇博客将详细介绍Spring Boot中拦截器的概念及其实战应用,帮助开发者理解和利用拦截器来增强应用的功能。
37 0
|
1月前
|
前端开发 Java Spring
[AIGC] Spring Interceptor 拦截器详解
[AIGC] Spring Interceptor 拦截器详解
|
1月前
|
Java Spring
flowable 监听器无法获取spring bean ,自动注入bean为null,解决方案
flowable 监听器无法获取spring bean ,自动注入bean为null,解决方案
|
1月前
|
存储 前端开发 NoSQL
【二十一】springboot整合过滤器实战
【二十一】springboot整合过滤器实战
21 0
|
1月前
|
缓存 前端开发 Java
【Spring底层原理高级进阶】轻松掌握 Spring MVC 的拦截器机制:深入理解 HandlerInterceptor 接口和其实现类的用法
【Spring底层原理高级进阶】轻松掌握 Spring MVC 的拦截器机制:深入理解 HandlerInterceptor 接口和其实现类的用法
|
1月前
spring-state-machine拦截器
spring-state-machine拦截器
30 0
|
XML 搜索推荐 Java
Spring源码 --- 监听器的原理 (下)
Spring源码 --- 监听器的原理 (下)
132 0
Spring源码 --- 监听器的原理 (下)