SpringBoot过滤器与拦截器深入分析实现方法

更新时间：2022年11月04日 10:00:42 作者：twilight0402

大家应该都晓得实现过滤器需要实现 javax.servlet.Filter 接口，而拦截器会在处理指定请求之前和之后进行相关操作，配置拦截器需要两步，本文通过实例代码给大家介绍SpringBoot 过滤器和拦截器的相关知识，感兴趣的朋友一起看看吧

过滤器

实现过滤器需要实现 javax.servlet.Filter 接口。重写三个方法。其中 init() 方法在服务启动时执行，destroy() 在服务停止之前执行。

可用两种方式注册过滤器：

使用 FilterRegistrationBean 来注入。可使用 setOrder(0) 设置过滤器的优先级，越小优先级越高。
使用 @WebFilter(filterName = "myFilter2" ,urlPatterns = "/*") 配合 @ServletComponentScan() 实现注入。（@Order 注解无效）

编写过滤器

package com.example.recorddemo.filters;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
public class MyFilter1 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化过滤器：" + filterConfig.getFilterName());
    }
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("在请求之前做处理");
        if (servletRequest instanceof HttpServletRequest) {
            System.out.println("  URL:" + ((HttpServletRequest)servletRequest).getRequestURL());
        }
        // 调用filter链中的下一个filter
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("在请求之后做处理");
    }
    @Override
    public void destroy() {
        System.out.println("销毁：MyFilter1");
    }
}

注册过滤器

基于 FilterRegistrationBean

在配置类中注册一个 FilterRegistrationBean 类型的Bean。

如果没有设置 UrlPatterns ，那么会自动关联到 /* 上。
如果没有设置过滤器的名字，那么会自动推理出一个过滤器名称（bean的名字）

When no URL pattern or servlets are specified the filter will be associated to ‘/*’. The filter name will be deduced if not specified.

fileter默认是enable的，将其设置为false表示关闭当前过滤器。
可通过 setOrder(0) 方法设置过滤器的优先级，如果优先级相同，则先定义的优先级更高。

@Configuration
public class FilterConfiguration {
    @Bean
    public FilterRegistrationBean myFilter1(){
        MyFilter1 filter = new MyFilter1();
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(filter);
//        filterRegistrationBean.addUrlPatterns("/*");
//        filterRegistrationBean.setEnabled(true);
        return filterRegistrationBean;
    }
}

基于 @WebFilter

使用 @WebFilter 修饰filter。
在任意configuration类中添加 @ServletComponentScan("com.example.recorddemo.filters")，包名可以不填。

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
@WebFilter(filterName = "myFilter2" ,urlPatterns = "/*")
public class MyFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        // 调用filter链中的下一个filter
        filterChain.doFilter(servletRequest, servletResponse);
    }
    @Override
    public void destroy() {}
}

拦截器

拦截器会在处理指定请求之前和之后进行相关操作，配置拦截器需要两步

编写拦截器类（实现 HandlerInterceptor 接口）
添加已实现的拦截器（实现 WebMvcConfigurer 接口，并重写 addInterceptors() 方法）
添加addPathPatterns()规定拦截哪些请求。（/*表示只拦截/下的所有目录，但是不包括子目录, /**表示拦截/下的所有目录，及其子目录）

拦截器类：

package com.example.recorddemo.interceptor;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
 * @author wangchao
 */
@Component
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // handle可拿到执行方法的反射对象。
        System.out.println("preHandle: MyInterceptor");
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 对于RESTful 接口用处不大
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 可捕捉异常，但是springboot已经有了全局异常捕捉
    }
}

配置拦截器：

package com.example.recorddemo.configuration;
import com.example.recorddemo.interceptor.MyInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.annotation.Resource;
@Configuration
public class InterceptorConfiguration implements WebMvcConfigurer {
    @Resource
    MyInterceptor myInterceptor;
    /**
     * 添加拦截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor).addPathPatterns("/**");
    }
}

registry.addInterceptor() 方法会返回当前的 interceptor，因此可直接执行 addPathPatterns() 方法

    public InterceptorRegistration addInterceptor(HandlerInterceptor interceptor) {
        InterceptorRegistration registration = new InterceptorRegistration(interceptor);
        this.registrations.add(registration);
        return registration;
    }

拦截器的执行顺序类似于栈，按照如下顺序执行：

preHandle-1, preHandle-2, postHandle-2, postHandle-1, afterCompletion-2, afterCompletion-1

到此这篇关于SpringBoot过滤器与拦截器深入分析实现方法的文章就介绍到这了,更多相关SpringBoot过滤器与拦截器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java中的序列化(Serializable)和反序列化
这篇文章主要介绍了Java中的序列化(Serializable)和反序列化, JAVA序列化与反序列化就是JAVA对象与一串字节流之间的相互转换, 我们在程序中创建的JAVA对象只存在于JVM中,需要的朋友可以参考下
2023-09-09
Java利用POI读取、写入Excel的方法指南
这篇文章主要给大家介绍了关于Java利用POI读取、写入Excel的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2019-03-03
Invalid bound statement(not found):错误的解决方案
本文介绍了在开发Java SpringBoot应用程序时出现的"Invalidboundstatement(notfound)"错误的原因及解决方法,该错误通常与MyBatis或其他持久化框架相关,可能是由于配置错误、拼写错误或其他问题引起的,解决方法包括检查SQL映射文件
2025-01-01
Spring Boot整合MyBatis-Plus实现CRUD操作的示例代码
本文主要介绍了Spring Boot整合MyBatis-Plus实现CRUD操作,可以快速实现数据库的增删改查操作,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧
2025-04-04
深入了解Java中的反射机制(reflect)
Java的反射机制允许我们对一个类的加载、实例化、调用方法、操作属性的时期改为在运行期进行，这大大提高了代码的灵活度,本文就来简单讲讲反射机制的具体使用方法吧
2023-05-05
mybatis如何返回某列的最大值
这篇文章主要介绍了mybatis如何返回某列的最大值操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07
java发起http请求调用post与get接口的方法实例
在实际开发过程中,我们经常需要调用对方提供的接口或测试自己写的接口是否合适,下面这篇文章主要给大家介绍了关于java发起http请求调用post与get接口的相关资料,需要的朋友可以参考下
2022-08-08
EL表达式简介_动力节点Java学院整理
EL全名为Expression Language，这篇文章主要给大家介绍EL表达式的主要作用及内容简介，感兴趣的朋友一起看看
2017-07-07
图文详解Java线程和线程池
下面小编就为大家带来一篇详谈Java的线程和线程池。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2021-11-11
JAVA annotation入门基础
以下是JAVA annotation入门基础，新手朋友们可以过来参考下。希望对你有所帮助
2013-08-08