您当前的位置:首页 > 电脑百科 > 程序开发 > 架构

六个Spring Boot处理异常的小技巧

时间:2023-09-25 15:35:10  来源:微信公众号  作者:Java学研大本营

在Spring框架中,@ControllerAdvice是全局异常处理机制,用于集中处理应用程序中发生的异常。

当任何控制器方法(例如REST端点)抛出异常时,该异常会被@ControllerAdvice注解的类捕获。

@ControllerAdvice类中的@ExceptionHandler方法用于处理特定类型的异常,并返回适当的响应。

本文我们通过一个实际场景的例子来详细说明,在Spring Boot应用程序中处理产品相关的自定义异常并进行全局处理的情况。

步骤:

1. 创建自定义的ProductNotFoundException:

在这一步中,我们创建一个自定义异常类ProductNotFoundException,它继承自RuntimeException。这个自定义异常用于表示系统中找不到产品的情况。通过创建自定义异常,我们可以提供更具体的错误信息。

public class ProductNotFoundException extends RuntimeException {
 public ProductNotFoundException(Long productId) {
 super(“Product not found with ID: “ + productId);
 }
}

解释:

  • 自定义异常用于捕获应用程序特定的错误场景。
  • 在这种情况下,我们在异常消息中包含了productId,以提供有关缺失产品的详细信息。

2. 创建产品服务(Product Service):

在这步,我们创建一个ProductService类,负责获取产品信息。如果找不到产品,会抛出ProductNotFoundException。

@Service
public class ProductService {

    public Product getProductById(Long productId) {
        // 模拟获取产品的逻辑
        Product product = getProductFromDatabase(productId);
        
        if (product == null) {
            throw new ProductNotFoundException(productId);
        }
        
        return product;
    }

    // 模拟从数据库获取产品的方法
    private Product getProductFromDatabase(Long productId) {
        // 在这里实现您的数据库逻辑
        // 如果找不到产品,则返回null
        return null;
    }
}

解释:

  • ProductService封装了与产品相关的业务逻辑。
  • getProductById方法模拟从数据库或其他数据源获取产品。
  • 如果找不到产品(基于模拟),会抛出ProductNotFoundException。

3. 创建全局异常处理器(Global Exception Handler):

这一步涉及使用@ControllerAdvice创建一个全局异常处理器。该处理器负责全局捕获ProductNotFoundException,并返回自定义错误响应。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ProductNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleProductNotFoundException(ProductNotFoundException ex) {
        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.NOT_FOUND.value(), ex.getMessage());
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(errorResponse);
    }
}

解释:

  • @ControllerAdvice将该类标记为全局异常处理器,使其能够处理来自多个控制器的异常。
  • 处理器内的@ExceptionHandler方法捕获ProductNotFoundException。
  • 它使用异常中的自定义错误消息构建一个包含404 Not Found状态码的ErrorResponse对象。
  • 处理器返回包含错误详细信息的JSON响应。

4. 创建自定义错误响应类(Custom Error Response Class):

我们定义一个自定义的错误响应类ErrorResponse,以便在应用程序中统一结构化错误消息。

public class ErrorResponse {
    private int statusCode;
    private String message;

    public ErrorResponse(int statusCode, String message) {
        this.statusCode = statusCode;
        this.message = message;
    }
    // Getter方法
}

解释:

  • ErrorResponse类提供了一个标准化的错误响应格式。
  • 它包含HTTP状态码和描述错误的消息字段。

5. 产品控制器(Controller):

在这一步中,我们创建一个控制器ProductController,负责处理根据产品ID获取产品的请求。

@RestController
@RequestMApping("/api/products")
public class ProductController {

    @Autowired
    private ProductService productService;

    @GetMapping("/{productId}")
    public ResponseEntity<Product> getProduct(@PathVariable Long productId) {
        Product product = productService.getProductById(productId);
        return ResponseEntity.ok(product);
    }
}

解释:

  • ProductController定义了一个端点,用于根据产品ID获取产品详细信息。
  • 它使用ProductService来获取产品。
  • 如果找到产品,它将返回包含产品数据的成功响应。

6. 测试异常处理:

为了测试异常处理,发送GET请求来获取在系统中不存在的产品信息。这将触发ProductNotFoundException,并由全局异常处理器返回一个JSON格式的错误消息。

curl -X GET http://localhost:8080/api/products/123

响应:

{
    "statusCode": 404,
    "message": "Product not found with ID: 123"
}

解释:

  • 测试请求尝试获取一个在系统中不存在的产品的信息,例如ID为123的产品。
  • 结果导致服务层抛出ProductNotFoundException异常。
  • 标记为@ControllerAdvice的全局异常处理器捕获该异常,并构建一个包含404状态码和自定义错误消息的JSON格式错误响应。

顺序流程图

从控制器到使用@ControllerAdvice进行错误处理的Spring应用程序的流程顺序图:

(1) 控制器层:

客户端(例如Web浏览器或REST客户端)向Spring应用程序发出请求,通常是向公开的HTTP端点发送请求。

(2) 控制器方法执行:

Spring MVC框架根据请求映射注解(如@GetMapping或@PostMapping)将传入的请求路由到适当的控制器方法。

控制器方法执行并执行其业务逻辑。

(3) 异常发生:

在执行控制器方法的过程中,由于各种原因可能会抛出异常。这可能是由于业务逻辑错误、验证失败或任何其他意外问题。

4 异常传播:

一旦在控制器方法内部抛出异常,它就会开始沿着调用堆栈向上传播。

(55) @ControllerAdvice类:

异常向上传播,直到达到使用@ControllerAdvice注解的全局异常处理器类为止。

(6) @ExceptionHandler方法:

在@ControllerAdvice类中,定义了一个或多个@ExceptionHandler方法来处理特定类型的异常。

(7) 匹配异常处理器:

Spring框架根据方法的参数类型识别出适当的@ExceptionHandler方法来处理特定的异常类型。

(8) 异常处理:

匹配的@ExceptionHandler方法执行以处理异常。

此方法可以执行诸如记录错误、构建错误响应或执行任何其他自定义操作的任务。

(9) 生成响应:

@ExceptionHandler方法通常生成一个错误响应,可以是JSON响应、html页面或任何其他响应格式。

(10) 响应发送给客户端:

由@ExceptionHandler方法生成的错误响应发送回原始请求的客户端。

(11) 客户端接收错误响应:

客户端接收错误响应,并根据需要处理错误信息。例如,它可以向用户显示错误消息或以编程方式处理错误。



Tags:Spring Boot   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,不构成投资建议。投资者据此操作,风险自担。如有任何标注错误或版权侵犯请与我们联系,我们将及时更正、删除。
▌相关推荐
Spring Boot2.0深度实践 核心原理拆解+源码分析
Spring Boot2.0深度实践:核心原理拆解与源码分析一、引言Spring Boot是一个基于Java的轻量级框架,它简化了Spring应用程序的创建过程,使得开发者能够快速搭建一个可运行的应用...【详细内容】
2024-01-15  Search: Spring Boot  点击:(93)  评论:(0)  加入收藏
Spring Boot 3.0是什么?
Spring Boot 3.0是一款基于Java的开源框架,用于简化Spring应用程序的构建和开发过程。与之前的版本相比,Spring Boot 3.0在多个方面进行了改进和增强,使其更加易用、高效和灵活...【详细内容】
2024-01-11  Search: Spring Boot  点击:(132)  评论:(0)  加入收藏
GraalVM与Spring Boot 3.0:加速应用性能的完美融合
在2023年,SpringBoot3.0的发布标志着Spring框架对GraalVM的全面支持,这一支持是对Spring技术栈的重要补充。GraalVM是一个高性能的多语言虚拟机,它提供了Ahead-of-Time(AOT)编...【详细内容】
2024-01-11  Search: Spring Boot  点击:(124)  评论:(0)  加入收藏
Spring Boot虚拟线程的性能还不如Webflux?
早上看到一篇关于Spring Boot虚拟线程和Webflux性能对比的文章,觉得还不错。内容较长,抓重点给大家介绍一下这篇文章的核心内容,方便大家快速阅读。测试场景作者采用了一个尽可...【详细内容】
2024-01-10  Search: Spring Boot  点击:(115)  评论:(0)  加入收藏
Spring Boot Starter的原理
Spring Boot Starter 是 Spring Boot 框架的特性之一,用于简化应用程序的依赖管理和配置。1. 概述: - Spring Boot Starter 是一种包含了一组特定功能和依赖关系的依赖项,旨在...【详细内容】
2024-01-05  Search: Spring Boot  点击:(93)  评论:(0)  加入收藏
Spring Boot 统一响应体处理器详解
在Spring Boot应用中,统一处理响应体是一项非常重要的任务,它可以让我们更方便地统一规范API的返回格式。今天,我们将深入探讨一个优雅的解决方案&mdash;&mdash;使用ResultHand...【详细内容】
2023-11-30  Search: Spring Boot  点击:(149)  评论:(0)  加入收藏
Spring Boot 调优内嵌 Tomcat 的三种方法
在 Spring Boot 中优化 Apache Tomcat 有三种方式,以便实现更好的性能和资源利用率。 线程池(连接器和执行器)设置 使用 NIO 或 APR 连接器 JVM优化线程池设置在 Spring Boot...【详细内容】
2023-11-23  Search: Spring Boot  点击:(227)  评论:(0)  加入收藏
一文搞懂Spring Boot控制器的关键要点
Spring Boot 应用程序中的控制器扮演着重要角色,负责处理传入的 HTTP 请求并确定应发送的适当响应。本文深入介绍 Spring Boot 中的控制器,包括如何创建控制器、处理各种类型...【详细内容】
2023-11-20  Search: Spring Boot  点击:(151)  评论:(0)  加入收藏
Spring Boot中实现订单30分钟自动取消的策略思路及源代码
方式一:使用定时任务 首先,创建一个定时任务,比如每30分钟执行一次检查订单是否需要取消的逻辑。 在订单生成的时候,保存一条记录到数据库,标记订单的状态为"待处理"。 在定时任...【详细内容】
2023-11-20  Search: Spring Boot  点击:(217)  评论:(0)  加入收藏
Spring Boot + Vue3 前后端分离 实战wiki知识库系统
下栽の地止:https://www.itwangzi.cn/2508.html Spring Boot + Vue3 前后端分离 实战wiki知识库系统在当今的Web应用开发中,前后端分离已经成为了一种主流的开发模式。Spring...【详细内容】
2023-11-18  Search: Spring Boot  点击:(143)  评论:(0)  加入收藏
▌简易百科推荐
对于微服务架构监控应该遵守的原则
随着软件交付方式的变革,微服务架构的兴起使得软件开发变得更加快速和灵活。在这种情况下,监控系统成为了微服务控制系统的核心组成部分。随着软件的复杂性不断增加,了解系统的...【详细内容】
2024-04-03  步步运维步步坑    Tags:架构   点击:(5)  评论:(0)  加入收藏
大模型应用的 10 种架构模式
作者 | 曹洪伟在塑造新领域的过程中,我们往往依赖于一些经过实践验证的策略、方法和模式。这种观念对于软件工程领域的专业人士来说,已经司空见惯,设计模式已成为程序员们的重...【详细内容】
2024-03-27    InfoQ  Tags:架构模式   点击:(13)  评论:(0)  加入收藏
哈啰云原生架构落地实践
一、弹性伸缩技术实践1.全网容器化后一线研发的使用问题全网容器化后一线研发会面临一系列使用问题,包括时机、容量、效率和成本问题,弹性伸缩是云原生容器化后的必然技术选择...【详细内容】
2024-03-27  哈啰技术  微信公众号  Tags:架构   点击:(10)  评论:(0)  加入收藏
DDD 与 CQRS 才是黄金组合
在日常工作中,你是否也遇到过下面几种情况: 使用一个已有接口进行业务开发,上线后出现严重的性能问题,被老板当众质疑:“你为什么不使用缓存接口,这个接口全部走数据库,这怎么能扛...【详细内容】
2024-03-27  dbaplus社群    Tags:DDD   点击:(11)  评论:(0)  加入收藏
高并发架构设计(三大利器:缓存、限流和降级)
软件系统有三个追求:高性能、高并发、高可用,俗称三高。本篇讨论高并发,从高并发是什么到高并发应对的策略、缓存、限流、降级等。引言1.高并发背景互联网行业迅速发展,用户量剧...【详细内容】
2024-03-13    阿里云开发者  Tags:高并发   点击:(6)  评论:(0)  加入收藏
如何判断架构设计的优劣?
架构设计的基本准则是非常重要的,它们指导着我们如何构建可靠、可维护、可测试的系统。下面是这些准则的转换表达方式:简单即美(KISS):KISS原则的核心思想是保持简单。在设计系统...【详细内容】
2024-02-20  二进制跳动  微信公众号  Tags:架构设计   点击:(36)  评论:(0)  加入收藏
详解基于SpringBoot的WebSocket应用开发
在现代Web应用中,实时交互和数据推送的需求日益增长。WebSocket协议作为一种全双工通信协议,允许服务端与客户端之间建立持久性的连接,实现实时、双向的数据传输,极大地提升了用...【详细内容】
2024-01-30  ijunfu  今日头条  Tags:SpringBoot   点击:(9)  评论:(0)  加入收藏
PHP+Go 开发仿简书,实战高并发高可用微服务架构
来百度APP畅享高清图片//下栽のke:chaoxingit.com/2105/PHP和Go语言结合,可以开发出高效且稳定的仿简书应用。在实现高并发和高可用微服务架构时,我们可以采用一些关键技术。首...【详细内容】
2024-01-14  547蓝色星球    Tags:架构   点击:(115)  评论:(0)  加入收藏
GraalVM与Spring Boot 3.0:加速应用性能的完美融合
在2023年,SpringBoot3.0的发布标志着Spring框架对GraalVM的全面支持,这一支持是对Spring技术栈的重要补充。GraalVM是一个高性能的多语言虚拟机,它提供了Ahead-of-Time(AOT)编...【详细内容】
2024-01-11    王建立  Tags:Spring Boot   点击:(124)  评论:(0)  加入收藏
Spring Boot虚拟线程的性能还不如Webflux?
早上看到一篇关于Spring Boot虚拟线程和Webflux性能对比的文章,觉得还不错。内容较长,抓重点给大家介绍一下这篇文章的核心内容,方便大家快速阅读。测试场景作者采用了一个尽可...【详细内容】
2024-01-10  互联网架构小马哥    Tags:Spring Boot   点击:(115)  评论:(0)  加入收藏
站内最新
站内热门
站内头条