Springboot 过滤器、拦截器、全局异常处理的方案处理小结

Springboot 过滤器、拦截器、全局异常处理

一 过滤器（Filter）

过滤器是JavaWeb三大组件（Servlet，Filter，Listener）之一。

Filter可以把对资源的请求拦截下来，从而实现一些功能。

注意：过滤器一般用于一些通用的操作，比如登录校验，统一编码处理，敏感字符处理等。

1.定义过滤器

1.创建一个类，实现 javax.servlet.Filter接口，并且实现其方法。

2.配置过滤器

在类上增加 @WebFilter 注解，配置拦截资源的路径，并且在引导类上增加@ServletComponentScan开启Servlet的组件支持。

注意：Filter 是JavaWeb的组件，并非Spring组件，所以还需要在引导类上使用@ServletComponentScan开启对Filter组件的支持

@WebFilter
public class CustomFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 初始化方法，Web服务启动创建Filter时调用一次。可以不用重写
        Filter.super.init(filterConfig);
    }
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws ServletException, IOException {
        // 拦截到请求时，调用该方法。是拦截器的核心
        filterChain.doFilter(servletRequest,servletResponse);
    }
    @Override
    public void destroy() {
        // 销毁方法，服务器关闭时调用一次，可以不重写
        Filter.super.destroy();
    }
}

拦截器Filter的核心方法是 doFilter(),处理相关逻辑的代码几乎都写在此处。

可以通过@WebFilter注解的属性urlPatterns，来配置需要进行过滤的资源信息。

示例：使用 urlPatterns = "/*"配置过滤所有请求

@WebFilter(urlPatterns = "/*")
public class CustomFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws ServletException, IOException {
        //放行对资源的请求
        filterChain.doFilter(servletRequest,servletResponse);
    }
}

3.OncePerRequestFilter

在实际使用中推荐使用OncePerRequestFilter ，它是Spring框架提供的一个抽象类，用于确保过滤器只在每个请求中被调用一次。它继承自

GenericFilterBean类，并在 doFilter 方法中添加了对请求是否已被过滤的判断逻辑。

OncePerRequestFilter 和 Filter 的根本区别在于 OncePerRequestFilter 提供了一个确保过滤器只在每个请求中被调用一次的机制，而 Filter 接

口本身并没有提供这样的机制。

@Configuration
public class JwtAuthenticationFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException {
            filterChain.doFilter(httpServletRequest, httpServletResponse);
        }
    }
}

而且使用OncePerRequestFilter的实现类，并不需要在项目的启动类上增加@ServletComponentScan注解。

二 拦截器（Interceptor）

1.拦截器概述

拦截器是一种动态拦截方法调用的机制，与过滤器类似。是Spring框架中提供的，用来动态拦截控制器方法的执行。

它的主要作用是拦截请求，在指定的方法前后调用，根据业务需要执行预先设定的代码。

2.定义拦截器（Interceptor）

定义一个拦截器，继承HandlerInterceper,并实现其方法。

HandlerInterceptor中的方法都提供了默认实现，可根据业务需求来决定重写哪些方法。

注意要为拦截器添加@Component注解，将其交给IOC容器管理。

@Component
public class CustomInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //在目标资源方法执行前执行，返回true放行，false 不放行
         return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        //在目标资源方法之后执行
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        //在整体请求完成之后调用
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

• @Component注解是Spring框架中用于表示一个类为Spring组件的通用注解，通过添加@Component注解，可以告诉Spring容器在项目初始化时将该类实例化为一个Bean,并由Spring容器管理。
• HandlerInterceptor是SpringMVC框架中的拦截器接口，用于拦截请求的处理过程并进行响应的处理。可以通过实现HandlerInterceptor类来自定义拦截器，实现更灵活的业务控制。

3.注册拦截器

自定义的拦截器，需要进行注册。可实现WebMvcConfigurer 接口，实现 addInterceptors方法，为其添加新的拦截器。

@Configuration
public class SpringWebConfigurer implements WebMvcConfigurer {
    //方式1：如果在定义拦截器的时候已经添加了@Component注解，则直接使用注入的方式，将拦截器对象注册到InterceptorRegistry对象中
    @Resource
    private CustomInterceptor customInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 使用 addPathPatterns 添加拦截路径，支持数组
        // /**表示拦截所有资源，属于 AntPathMatcher（蚂蚁路径匹配器）语法
        //方式1：使用注入的对象
        registry.addInterceptor(customInterceptor).addPathPatterns("/**");
        //方式2：也可以直接创建对象，添加到InterceptorRegistry对象中
        registry.addInterceptor(new CustomInterceptor()).addPathPatterns("/**");
    }
}

• InterceptorRegistry是Spring框架中专门用来管理拦截器的集合类。通过InterceptorRegistry对象，可以添加拦截器。并且指定它们的执行顺序。
• WebMvcConfigurer是Spring框架中用于配置Mvc特性的接口，通过实现WebMvcConfigurer接口，可以对SpringMVC进行自定义配置，包括添加拦截器，资源处理器，视图解析器等。
• @Configuration注解是Spring框架中用于表示配置类的注解，通过添加@Configuration注解，可以告诉Spring容器，该类是一个配置类，其中包含了一些配置信息，例如 Bean的定义，Bean之间的依赖关系，组件扫描等。
• addPathPatterns方法用来配置需要拦截的资源路径。
• excludePathPatterns方法用来配置不需要拦截的资源路径。

4.AntPathMatcher

Ant风格的路径模式匹配，AntPathMatcher支持以下通配符：

• ? 匹配一个字符
• * 匹配0个或多个字符
• ** 匹配0个或多个目录

5.拦截路径

拦截路径的简单示意：

6.过滤器和拦截器的执行流程

当过滤器与拦截器同时存在时，它们的执行流程如下：

dispatcherServlet的说明：

• dispatcherServlet是SpringMVC框架中的一个关键组件，用于所有进入应用程序的请求并将其分派到相应的处理程序（Controller）进行处理.
• dispatcherServlet是一个Servlet,负责接收HTTP请求并根据请求的URL，将请求分发给合适的Controller。
• dispatcherServlet可以通过配置来定制各种行为，包括URL映射，视图解析，异常处理等。是整个SpringMVC框架的核心，负责协调各个组件的工作，实现请求的处理和响应的生成。

执行流程说明：

• 浏览器发送请求，先到过滤器（Filter）
• 过滤器（Filter）放行之后，HTTP请求经过dispatcherServlet的派发到达拦截器（Interceptor）
• 拦截器（Interceptor）放行之后，请求才会真正进入处理程序（Controller）
• 处理程序（Controller）生成响应结果，将结果返回到拦截器（Interceptor）
• 拦截器（Interceptor）最后再将结果返回过滤器（Filter），最后响应给浏览器

7.过滤器和拦截器的区别

• 接口规范不同：过滤器需要实现Filter接口；而拦截器需要实现HandlerInterceptor接口，并且需要注册到InterceptorRegistry集合中。
• 拦截范围不同：过滤器会拦截所有的请求资源；而拦截器只会拦截Spring环境中的资源。

三 全局异常处理

定义一个类并且使用 @RestControllerAdvice 注解，则表明我们定义了一个全局异常处理类。

然后创建方法来捕获异常，并且通过@ExceptionHandler注解来表明要捕获的异常类型。并且将该异常的对象作为形参传入方法中。

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(RuntimeException.class)
    public Result runtimeException(RuntimeException runtimeException) {
        return Result.err(runtimeException.getMessage());
    }
}

注意：Result是一个自定义的统一响应格式类，其中包含了响应代码，响应消息，和响应数据。并且定义了几个常用的静态方法。

以上示例中，为保证返回格式统一，所以使用了Result作为返回类型。

• @RestControllerAdvice：@RestControllerAdvice 用于定义一个全局的异常处理类，它结合了 @ControllerAdvice 和 @ResponseBody 两个注解的功能。在 Spring Boot 应用中，我们可以使用 @RestControllerAdvice 注解来统一处理异常，返回统一的错误信息给前端。
• @ExceptionHandler：@ExceptionHandler 用于在 Spring MVC 控制器类中定义方法来处理特定类型的异常。当控制器中的方法抛出指定类型的异常时，@ExceptionHandler 注解的方法会被调用来处理该异常，从而提供定制化的异常处理逻辑

到此这篇关于Springboot 过滤器、拦截器、全局异常处理的文章就介绍到这了,更多相关Springboot 过滤器、拦截器、全局异常内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论