@RestControllerAdvice注解

news/2024/4/19 20:31:20/

目录

1. @RestControllerAdvice注解 详解:

1.1 概述

1.2 用途:

1.3 基本使用:

1.4 属性:

annotations:

basePackages:

basePackageClasses:

assignableTypes:

1.5 与@ExceptionHandler的结合:

1.6 总结

2. @RestControllerAdvice注解 与 @ControllerAdvice注解的区别?

参考文献:


1. @RestControllerAdvice注解 详解:

1.1 概述

@RestControllerAdvice注解是Spring MVC和Spring Boot应用程序中用于定义全局异常处理类的注解,它是@ControllerAdvice注解的特殊版本,用于RESTful风格的应用程序。@RestControllerAdvice可以捕获整个应用程序中抛出的异常,并对它们进行处理。这样可以实现在整个应用程序范围内统一处理异常的目标

@RestControllerAdvice注解实际上是@ControllerAdvice和@ResponseBody注解的组合。这意味着,当你使用@RestControllerAdvice注解时,异常处理方法的返回值将自动转换为HTTP响应的主体;

1.2 用途:

@RestControllerAdvice注解用于创建全局异常处理类,用于捕获和处理整个应用程序中的异常。它适用于RESTful风格的应用程序,因为它自动将异常处理方法的返回值转换为HTTP响应的主体。

1.3 基本使用:

要使用@RestControllerAdvice注解,只需在类上添加该注解。这个类应包含一个或多个带有@ExceptionHandler注解的方法,用于处理不同类型的异常。

例如:

@RestControllerAdvicepublic class GlobalRestExceptionHandler {@ExceptionHandler(UserNotFoundException.class)public ResponseEntity<String> handleUserNotFoundException(UserNotFoundException ex) {return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());}@ExceptionHandler(IllegalArgumentException.class)public ResponseEntity<String> handleIllegalArgumentException(IllegalArgumentException ex) {return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(ex.getMessage());}}

1.4 属性:

@RestControllerAdvice注解继承了@ControllerAdvice注解的属性:

annotations:

用于指定需要扫描的其他注解。只有带有这些注解的类中的异常处理方法才会被全局异常处理类处理。

basePackages:

别名:value

用于指定需要扫描的包名。只有这些包下的类中的异常处理方法才会被全局异常处理类处理。

value:

是默认的属性;

用于指定要处理的异常类型。如果没有指定value属性,则默认处理所有的异常类型;

basePackageClasses:

用于指定需要扫描的类。只有这些类中的异常处理方法才会被全局异常处理类处理。

assignableTypes:

用于指定需要扫描的类或接口。只有这些类或接口的实现类中的异常处理方法才会被全局异常处理类处理。

这些属性可以帮助你限制全局异常处理类的作用范围,使其只处理特定包、类或接口下的异常。

1.5 与@ExceptionHandler的结合:

@RestControllerAdvice通常与@ExceptionHandler注解一起使用。在全局异常处理类中,你可以定义多个带有@ExceptionHandler注解的方法,用于处理不同类型的异常。当指定类型的异常在整个应用程序中抛出时,相应的`@ExceptionHandler方法将被调用以处理该异常。由于@RestControllerAdvice注解自动将异常处理方法的返回值转换为HTTP响应的主体,因此,你无需使用@ResponseBody`注解。

例如:

@RestControllerAdvicepublic class GlobalRestExceptionHandler {@ExceptionHandler(UserNotFoundException.class)public ResponseEntity<String> handleUserNotFoundException(UserNotFoundException ex) {return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());}@ExceptionHandler(IllegalArgumentException.class)public ResponseEntity<String> handleIllegalArgumentException(IllegalArgumentException ex) {return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(ex.getMessage());}@ExceptionHandler(Exception.class)public ResponseEntity<String> handleException(Exception ex) {return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("An unexpected error occurred: " + ex.getMessage());}}

在上面的代码中,我们定义了一个全局RESTful异常处理类,并处理了三种类型的异常:UserNotFoundException、IllegalArgumentException和Exception。对于每种异常,我们分别返回一个带有HTTP状态码和错误消息的ResponseEntity对象。由于我们使用了@RestControllerAdvice注解,异常处理方法的返回值将自动转换为HTTP响应的主体。

1.6 总结

@RestControllerAdvice注解是一个用于定义全局RESTful异常处理类的类级别注解。通过使用@RestControllerAdvice和@ExceptionHandler注解,你可以实现在整个应用程序范围内统一处理RESTful风格的异常。它自动将异常处理方法的返回值转换为HTTP响应的主体,使得代码更加简洁、可读和可维护。

2. @RestControllerAdvice注解 与 @ControllerAdvice注解的区别?

特性

@ControllerAdvice注解

@RestControllerAdvice注解【实】

类型

Class<?extends Throwable>[]

String

适用场景

适用于传统的Web应用程序,需要进行视图解析和渲染的场景

适用于构建RESTful风格的Web服务,需要直接返回JSON格式响应体的场景

返回值

返回视图名称或包装后的ModelAndView对象,用于视图解析和渲染

返回JSON格式的响应体,用于直接返回给客户端

作用

处理控制器中的异常、绑定和预处理等操作,并在多个控制器中共享

处理控制器中的异常、绑定和预处理等操作,并直接返回JSON格式的响应体,用于构建RESTful风格的Web服务

使用的注解

@ExceptionHandler、@InitBinder和@ModelAttribute等注解

@ExceptionHandler、@InitBinder和@ModelAttribute等注解

返回值转换方式

通过视图解析器和模板引擎将返回值转换为HTML或其他格式的响应体

直接将返回值转换为JSON格式的响应体

返回值的处理方式

需要进行视图解析和渲染,将结果包装成HTTP响应体,再返回给客户端

直接将结果包装成HTTP响应体,并返回给客户端

参考文献:

  • ChatGPT-4;
  • 文心一言;
  • SpringBoot源码;

http://www.ppmy.cn/news/58001.html

相关文章

S3C6410 中的 cascaded irqdomain 之 gpio

文章目录 VIC 中断 与 gpio 中断 的硬件拓扑图描述linux cascaded irq domainirq domain 初始化时获取 IRQ number(软件中断号) 时中断发生时如何调试linux irq domain 实例 VIC domain 与 gpio domain 的硬件拓扑语言描述VIC 与 INT_EINTx 的关系INT_EINTx 与 GPIO的关系INT_E…

回炉重造十一------ansible批量安装服务

1.playbook的核心组件 Hosts 执行的远程主机列表Tasks 任务集,由多个task的元素组成的列表实现,每个task是一个字典,一个完整的代码块功能需最 少元素需包括 name 和 task,一个name只能包括一个taskVariables 内置变量或自定义变量在playbook中调用Templates 模板&#xff0c;…

springboot第15集:MyBatis分页

我们在测试SQL的时候&#xff0c;要是能够在控制台输出 SQL 的话&#xff0c;是不是就能够有更快的排错效率&#xff1f; 是的&#xff0c;输出 SQL 可以帮助我们更好地理解代码的执行流程和结果。在控制台输出 SQL 可以让我们看到实际执行的 SQL 语句&#xff0c;这样就能够更…

Scalable Vector Graphics (SVG)中的svg、clipPath、mask元素

Scalable Vector Graphics (SVG)是一种用于描述二维向量图形的XML基础标记语言。使用SVG可以实现丰富的图形效果&#xff0c;而不需要像使用位图那样考虑分辨率和像素密度的问题&#xff0c;可以在不同设备上展示出相同的高质量图像。 在SVG中&#xff0c;除了基本形状如circl…

【人工智能】— 不确定性、先验概率/后验概率、概率密度、贝叶斯法则、朴素贝叶斯 、最大似然估计

【人工智能】— 不确定性 不确定性不确定性与理性决策基本概率符号先验概率(无条件概率)/后验概率(条件概率)随机变量概率密度联合概率分布公理完全联合分布概率演算独立性 贝叶斯法则例1例2 使用贝叶斯规则&#xff1a;合并证据朴素贝叶斯最大似然估计小结 不确定性 不确定性与…

码出高效:Java开发手册笔记(线程池及其源码)

码出高效&#xff1a;Java开发手册笔记&#xff08;线程池及其源码&#xff09; 码出高效&#xff1a;Java开发手册笔记&#xff08;线程池及其源码&#xff09; 码出高效&#xff1a;Java开发手册笔记&#xff08;线程池及其源码&#xff09;前言一、线程池的作用线程的生命周…

Sentinel源码分析学习

文章目录 前言Sentinel源码分析1.Sentinel的基本概念1.1.ProcessorSlotChain1.2.Node1.3.Entry1.3.1.自定义资源1.3.2.基于注解标记资源 1.4.Context1.4.1.什么是Context1.4.2.Context的初始化1.4.2.1.自动装配1.4.2.2.AbstractSentinelInterceptor1.4.2.3.ContextUtil 2.Proce…

【网络进阶】服务器模型Reactor与Proactor

文章目录 1. Reactor模型2. Proactor模型3. 同步IO模拟Proactor模型 在高并发编程和网络连接的消息处理中&#xff0c;通常可分为两个阶段&#xff1a;等待消息就绪和消息处理。当使用默认的阻塞套接字时&#xff08;例如每个线程专门处理一个连接&#xff09;&#xff0c;这两…

clion--cmake内置常量---打算一锅端了

# cmakelists.txt文件讲解&#xff0c;以下语意不是都在同一个cmakelists.txt message("${CMAKE_SOURCE_DIR} 是工程终极父级目录") message("${CMAKE_BINARY_DIR} 是CMAKE_SOURCE_DIR下的一个cmake_build_<buildtype>目录") message("${PROJEC…

检查替换后的词是否有效

题目描述 给你一个字符串 s &#xff0c;请你判断它是否 有效 。 字符串 s 有效 需要满足&#xff1a;假设开始有一个空字符串 t “” &#xff0c;你可以执行 任意次 下述操作将 t 转换为 s &#xff1a; 将字符串 “abc” 插入到 t 中的任意位置。形式上&#xff0c;t 变为…

西门子PLC沿脉冲类指令汇总

S7-1200CPU提供了四种沿脉冲指令供用户使用&#xff0c;分别为&#xff1a;扫描操作数信号边沿指令、在信号边沿置位操作数的指令、扫描RLO的信号边沿指令以及检测信号边沿指令。 信号从0--1的时刻称为上升沿&#xff0c;信号从1--0的时刻称为下降沿&#xff0c;不管是上升沿还…

使用 ESP32 设计智能手表 – 第 1 部分制作表盘

相关设计资料下载ESP32 智能手表带心率、指南针设计资料(包含Arduino源码+原理图+Gerber+3D文件).zip 人们可以使用智能手表轻松快速地访问消息、警报、健康信息和其他高级信息。虽然智能手表作为独立设备在形式上是革命性的,但当与人们携带的其他设备(例如智能手机或平板…

Bridge模式如何配置

Bridge模式案例&#xff08;一&#xff09; 基于Docker引擎启动Nginx WEB容器&#xff0c;默认以Bridge方式启动Docker容器&#xff0c;会动态DHCP给Docker容器分配IP、网关等信息&#xff0c;操作指令如下&#xff1a; 查看镜像列表 docker images#运行新的Nginx容器 dock…

工作流框架研究

工作流框架研究 主流开源框架介绍OsWorkFlowJBPMActivitiFlowableCamundaCamunda 和Flowable对比功能上对比性能上对比 总结 主流开源框架介绍 OsWorkFlow 对于比较简单的流程&#xff0c;OsWorkFlow会是一个比较好的选择&#xff0c;对于复杂的流程就不推荐了&#xff0c;Os…

2023年软件测试常见面试题100%问必背全套教程

随着数字化时代的到来&#xff0c;软件测试越来越受到重视。在未来的几年里&#xff0c;软件测试将继续成为信息技术领域中的热门职业之一。如果你是一名正在寻找或准备进入软件测试行业的人&#xff0c;那么这套常见面试题全套教程对你来说会非常有用。 这套教程旨在帮助你了…

GO Select 使用

Go select case 用法 case 1 func Test_Select_Case_1(t *testing.T) {chan1 := make(chan int)chan2 := make(chan int)go

EventBus(事件总线)的使用和源码的简单解析

Google Guava EventBus(事件总线)的使用和源码的简单解析 什么是EventBus&#xff1f; 事件总线&#xff08;EventBus&#xff09;是一种广泛用于软件架构中的设计模式&#xff0c;用于实现解耦和松散耦合的通信机制。它可以帮助组织和管理应用程序中不同组件之间的通信&…

JdbcTemplate常用语句代码示例

目录 JdbcTemplate 需求 官方文档 JdbcTemplate-基本介绍 JdbcTemplate 使用实例 需求说明 创建数据库 spring 和表 monster 创建配置文件 src/jdbc.properties 创建配置文件 src/JdbcTemplate_ioc.xml 创建类JdbcTemplateTest测试是否可以正确得到数据源 配置 J…

Python环境设置

对应B站视频讲解地址&#xff1a;https://www.bilibili.com/video/BV1Ds4y1w7pJ/?vd_source515e6808c21c69114a4fae34589dfb0e 在了解Python语言的历史和介绍之后&#xff0c;要想开始学习Python语言&#xff0c;还需要在计算机中安装Python编译环境&#xff0c;本期就来聊聊…

Python程序员如何写简历容易找到好工作?分享4个制作简历的细节

在写简历时&#xff0c;你需要注意很多细节&#xff0c;因为简历是展示你个人能力和经验的关键。在本次前端简历写作法文章中&#xff0c;我们分享了一些写简历的技巧和要点&#xff0c;以帮助你写出一份优秀的简历。我们将进一步探讨一些你不应该在简历中写的东西&#xff0c;…