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虚拟机管理的内存运行时数据区域
这篇文章主要介绍了详解Java虚拟机管理的内存运行时数据区域的相关资料,需要的朋友可以参考下
2017-03-03
Java通过卖票理解多线程
本文主要介绍了一个多线程卖票的例子，通过卖票这个实例来介绍多线程的方式，加深理解,需要的朋友可以参考下
2017-09-09
浅谈两个jar包中包含完全相同的包名和类名的加载问题
下面小编就为大家带来一篇浅谈两个jar包中包含完全相同的包名和类名的加载问题。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-09-09
IDEA安装详细步骤（多图预警）
这篇文章主要介绍了IDEA安装详细步骤（多图预警）,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-04-04
Java 8 中 Map 骚操作之 merge() 的使用方法
本文简单介绍了一下Map.merge()的方法，除此之外，Java 8 中的HashMap实现方法使用了TreeNode和红黑树，原理很相似，今天通过本文给大家介绍Java 8 中 Map 骚操作之 merge() 的用法，需要的朋友参考下吧
2021-07-07
深入理解Java设计模式之抽象工厂模式
这篇文章主要介绍了JAVA设计模式之抽象工厂模式的的相关资料，文中示例代码非常详细，供大家参考和学习，感兴趣的朋友可以了解下
2021-11-11
一篇文章带你深入了解Java异常
本篇文章主要介绍了java异常处理机制及应用，异常处理机制是Java语言的一大特色。从异常处理的机制、异常处理的方法、异常处理的原则等方面介绍Java语言的异常处理技术,有兴趣的可以了解一下
2021-08-08
JavaWeb dbutils执行sql命令并遍历结果集时不能查到内容的原因分析
这篇文章主要介绍了JavaWeb dbutils执行sql命令并遍历结果集时不能查到内容的原因分析及简单处理方法，文中给大家介绍了javaweb中dbutils的使用,需要的朋友可以参考下
2017-12-12
logback和log4j日志框架堆栈信息添加TraceId方式
这篇文章主要介绍了logback和log4j日志框架堆栈信息添加TraceId方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-09-09
java 多态性详解及常见面试题
这篇文章主要介绍了java 多态性详解及常见面试题的相关资料,这里对java 的多态性做了资料整理，并列举常见的关于多态性的面试题，需要的朋友可以参考下
2016-11-11