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

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

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

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

@WebFilter(urlPatterns = "/*")
public class CustomFilter implements Filter {@Overridepublic 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 {@Overrideprotected 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 {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {//在目标资源方法执行前执行，返回true放行，false 不放行return true;}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {//在目标资源方法之后执行HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);}@Overridepublic 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对象中@Resourceprivate CustomInterceptor customInterceptor;@Overridepublic 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框架的核心，负责协调各个组件的工作，实现请求的处理和响应的生成。

执行流程说明：

  1. 浏览器发送请求，先到过滤器（Filter）
  2. 过滤器（Filter）放行之后，HTTP请求经过dispatcherServlet的派发到达拦截器（Interceptor）
  3. 拦截器（Interceptor）放行之后，请求才会真正进入处理程序（Controller）
  4. 处理程序（Controller）生成响应结果，将结果返回到拦截器（Interceptor）
  5. 拦截器（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 注解的方法会被调用来处理该异常，从而提供定制化的异常处理逻辑

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.rhkb.cn/news/269409.html

如若内容造成侵权/违法违规/事实不符，请联系长河编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

这本书太好了！150页就能让你上手大模型应用开发

这本书太好了！150页就能让你上手大模型应用开发

如果问个问题：有哪些产品曾经创造了伟大的奇迹？ChatGPT 应该会当之无愧入选。仅仅发布 5 天，ChatGPT 就吸引了 100 万用户——当然，数据不是关键，关键是其背后的技术开启了新的 AI 狂潮，成为技术变革的点火…
阅读更多...
Ubantu 18.04 配置固定IP

Ubantu 18.04 配置固定IP

1.首先在终端里输入命令,将你的网关和ip，记下来 ifconfig 2. 执行命令： sudo gedit /etc/network/interfaces 3.在弹出来的框里输入 auto后面的就是网关，address是你虚拟机的ip，gateway是你的网关ip，netmask是你的子…
阅读更多...
非阻塞实现高效键盘扫描功能（STM32F4XX）

非阻塞实现高效键盘扫描功能（STM32F4XX）

目录 概述 1 原理分析 1.1 技术背景 1.2 系统硬件 1.3 STM32 IO（输入模式）寄存器分析 1.3.1 输入IO的功能描述 1.3.2 输入配置 1.3.3 GPIO 寄存器（输入模式相关） 1.3.3.1 GPIO 端口模式寄存器 1.3.3.2 GPIO 端口上拉/下拉…
阅读更多...
挑战给女神节送礼物，怎么寄快递才能快速的送到他手中呢？

挑战给女神节送礼物，怎么寄快递才能快速的送到他手中呢？

马上就是三八女神节了，怎么样？你给心爱的她或者敬爱的她准备礼物了吗，如果已经准备好，你该怎么送给她呢？是当面送给她？还是通过快递打包送给她呢？这里推荐使用闪侠惠递寄快递发货给他吧&#xf…
阅读更多...
Zookeeper3：客户端命令

Zookeeper3：客户端命令

文章目录 客户端命令连接服务端Zookeeper客户端内置命令 ls - 节点信息 客户端命令 连接服务端Zookeeper //客户端连接服务端zookeeper 默认连的本机2181端口的zookeeper cd /opt/module/zookeeper-3.9.1/bin && sh zkCli.sh//客户端连接远程服务端zookeeper cd /op…
阅读更多...
MySQL高可用性攻略：快速搭建MySQL主从复制集群 ！

MySQL高可用性攻略：快速搭建MySQL主从复制集群 ！

MySQL高可用性攻略：快速搭建MySQL主从复制集群 ！ MySQL基础知识：介绍MySQL数据库的基本概念和常用命令，如何创建数据库、表、用户和权限管理等。 MySQL安装教程：Centos7 安装MySQL5.7.29详细安装手册 MySQL数据类型&…
阅读更多...
【Docker】Docker：解析容器化技术的利器与在Linux中的关键作用

【Docker】Docker：解析容器化技术的利器与在Linux中的关键作用

🍎个人博客：个人主页 🏆个人专栏：Linux ⛳️ 功不唐捐，玉汝于成 目录 前言 正文 Docker 是什么？ Docker 的作用 Docker 在 Linux 中的重要性 结语 我的其他博客 前言 随着软件开发的不断发展&…
阅读更多...
猴子吃桃问题（python版）

猴子吃桃问题（python版）

文章预览： 题目python解法一：运行结果 python解法二：运行结果 python解法三：运行结果 题目 猴子吃桃问题：猴子第一天摘下若干个桃子，当即吃了一半，还不过瘾，又多吃了一个。 第二天早…
阅读更多...
计算机网络-网络安全（二）

计算机网络-网络安全（二）

1.应用层安全协议： S-HTTP或SHTTP（Sec HTTP），安全超文本传输协议，是HTTP扩展，使用TCP的80端口。HTTPS：HTTPSSL，使用TCP的443端口。和TLS（传输层安全标准）是双…
阅读更多...
安达发|APS自动排程软件的三种模式

安达发|APS自动排程软件的三种模式

APS自动排程软件是一种用于生产计划和调度的工具，它可以帮助制造企业实现生产过程的优化和效率提升。根据不同的需求和应用场景，APS自动排程软件通常有三种模式：基于模拟仿真模式、基于TOC的模式和扩展以及基于数学建模。下面我将详细介绍这三…
阅读更多...
解决在 Mac 上安装 Adobe 软件弹出提示：安装包已经被损坏并且不能被打开。

解决在 Mac 上安装 Adobe 软件弹出提示：安装包已经被损坏并且不能被打开。

问题： “INSTALLER” is damaged and can’t be opened. You should eject the disk image. 解决方法和步骤： 打开安装包；将安装包 “INSTALLER” 拖动复制到某个文件夹，复制后的文件路径例如像这样：/Users/michael…
阅读更多...
Qt绘制动态罗盘

Qt绘制动态罗盘

介绍：罗盘指针以30角旋转巡逻，扫描航海范围内的点位，并绘制点云。字段信息在表格中显示，该数据都存储在数据库中。选择不同的范围，显示该范围内的点位。 #include "mainwindow.h" #include "ui_mainwi…
阅读更多...
element-ui附件上传及在线查看详细总结，后续赋源码

element-ui附件上传及在线查看详细总结，后续赋源码

一、附件上传 1、在element-ui上面复制相应代码 a、accept"image/*,.pdf,.docx,.xlsx,.doc,.xls" 是规定上传文件的类型，若是不限制，可以直接将accept‘all即可； b、:action"action" 这个属性就是你的上传附件的地址&am…
阅读更多...
7款炫酷的前端动画特效分享（三）（附效果图及在线演示）

7款炫酷的前端动画特效分享（三）（附效果图及在线演示）

分享7款好玩的前端动画特效 其中有CSS动画、SVG动画、js小游戏等等 下方效果图可能不是特别的生动 那么你可以点击在线预览进行查看相应的动画特效 同时也是可以下载该资源的 CSS3模仿四季交替动画 基于HTML5CSS3实现的卡通风格一年四季交替动画特效 以下效果图只能体现框架的…
阅读更多...
建立网络防御时需要重点考虑的10个因素

建立网络防御时需要重点考虑的10个因素

互联网安全中心（CIS）建议企业可以从以下10个因素入手：资产管理、数据管理、安全配置、账户和访问控制管理、漏洞管理、日志管理、恶意软件防御、数据恢复、安全培训和事件响应。 1、资产管理 建立网络防御的第一步是制定企业资产和软件资产的…
阅读更多...
MySQL——事务

MySQL——事务

事务 2024 年 1 月字节后端实习面试：说说对 ACID 的理解？ 什么是事务？ 事务（Transaction）是数据库管理系统中一个执行单元（unit of work），它由一系列的操作（例如读取数…
阅读更多...
Gradle学习（一）

Gradle学习（一）

最近在学习Gradle，感觉有些东西没见过，记录一下！ 1.Gradle与Maven的目录框架 2.Gradle的命令行安装 注：学习常用的是使用脚手架生成gradle项目 3.
阅读更多...
改造muduo，不依赖boost，用C++11重构

改造muduo，不依赖boost，用C++11重构

组件的实现 1. 序 1.1. 总述 muduo库是基于多Reactor-多线程模型实现的TCP网络编程库，性能良好。如libev作者：“One loop per thread is usually a good model”，muduo库的作者陈硕在其《Linux多线程服务端编程》中也力荐这种“One loop pe…
阅读更多...
如何使用生成式人工智能探索视频博客的魅力？

如何使用生成式人工智能探索视频博客的魅力？

视频博客，尤其是关于旅游的视频博客，为观众提供了一种全新的探索世界的方式。通过图像和声音的结合，观众可以身临其境地体验到旅行的乐趣和发现的喜悦。而对于内容创作者来说，旅游视频博客不仅能分享他们的旅行故事，还…
阅读更多...
【教程】APP开发后如何上架？

【教程】APP开发后如何上架？

摘要 本文介绍了移动应用程序（APP）开发后如何上架的步骤和注意事项。内容包括选择合适的应用商店、遵循应用商店的规则和政策、准备上架所需材料、创建开发者账号、提交APP并等待审核等环节，以及上架成功后的推广和维护工作。 引言 移动应…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023