SpringBoot 如何使用 @ControllerAdvice 注解进行全局异常处理

这篇具有很好参考价值的文章主要介绍了SpringBoot 如何使用 @ControllerAdvice 注解进行全局异常处理。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

SpringBoot 如何使用 @ControllerAdvice 注解进行全局异常处理

在 Web 开发中,异常处理是非常重要的一环。在 SpringBoot 框架中,我们通常使用 @ExceptionHandler 注解来处理 Controller 层的异常。但是,如果想要处理全局异常,我们需要使用 @ControllerAdvice 注解。本文将介绍如何在 SpringBoot 中使用 @ControllerAdvice 注解进行全局异常处理。

SpringBoot 如何使用 @ControllerAdvice 注解进行全局异常处理

什么是 @ControllerAdvice

@ControllerAdvice 注解是 Spring Framework 3.2 引入的一个新特性,它用于定义全局异常处理器。使用 @ControllerAdvice 注解,我们可以集中处理所有 Controller 层抛出的异常,而不必在每个 Controller 中单独处理。

@ControllerAdvice 注解通常与 @ExceptionHandler 注解一起使用,@ExceptionHandler 注解用于定义具体的异常处理方法,@ControllerAdvice 注解用于定义全局异常处理器。

如何使用 @ControllerAdvice 进行全局异常处理

使用 @ControllerAdvice 进行全局异常处理的步骤如下:

  1. 创建一个全局异常处理类

我们可以创建一个类并使用 @ControllerAdvice 注解进行标注,例如:

@ControllerAdvice
public class GlobalExceptionHandler {
    // 异常处理方法
}

在上述代码中,我们使用 @ControllerAdvice 注解标注了一个类,并命名为 GlobalExceptionHandler。接下来,我们可以在 GlobalExceptionHandler 类中定义具体的异常处理方法。

  1. 定义异常处理方法

在 GlobalExceptionHandler 类中定义具体的异常处理方法,例如:

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
    }
}

在上述代码中,我们使用 @ExceptionHandler 注解定义了一个处理 Exception 类型异常的方法,并返回一个 ResponseEntity 对象。在处理方法中,我们可以根据具体的业务需求对异常进行相应的处理,并返回相应的结果。

  1. 处理其他类型的异常

除了处理 Exception 类型的异常外,我们还可以根据具体的业务需求,处理其他类型的异常。例如,如果我们想要处理参数校验失败的异常,可以在 GlobalExceptionHandler 类中定义一个处理 MethodArgumentNotValidException 类型异常的方法。

@ControllerAdvice
public class GlobalExceptionHandler {
    // 处理 Exception 类型异常的方法

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<String> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        List<String> errorMessages = new ArrayList<>();
        for (ObjectError error : allErrors) {
            errorMessages.add(error.getDefaultMessage());
        }
        String errorMessage = String.join(",", errorMessages);
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorMessage);
    }
}

在上述代码中,我们使用 @ExceptionHandler 注解定义了一个处理 MethodArgumentNotValidException 类型异常的方法。在处理方法中,我们首先获取 BindingResult 对象,并遍历其中的所有错误信息,将它们合并为一个错误消息,并返回一个 ResponseEntity 对象。

完整代码示例

下面是一个完整的使用 @ControllerAdvice 进行全局异常处理的示例代码:

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
    }

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<String> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        List<String> errorMessages = new ArrayList<>();
        for (ObjectError error : allErrors) {
            errorMessages.add(error.getDefaultMessage());
        }
        String errorMessage = String.join(",", errorMessages);
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorMessage);
    }
}

@RestController
@RequestMapping("/user")
public class UserController {
    @PostMapping("/add")
    public Result addUser(@Validated @RequestBody User user) {
        // 处理添加用户的逻辑
    }
}

@Data
public class User {
    @NotNull(message = "用户名不能为空")
    private String username;

    @NotNull(message = "密码不能为空")
    @Size(min = 6, message ="密码长度不能小于6")
    private String password;
}

在上述代码中,我们定义了一个 GlobalExceptionHandler 类,使用 @ControllerAdvice 注解标注,并在其中定义了处理 Exception 和 MethodArgumentNotValidException 类型异常的方法。

我们还定义了一个 UserController 类,并在其中定义了一个添加用户的接口。在添加用户接口中,我们使用 @Validated 注解对 User 对象进行参数校验,并在 User 类中使用了 javax.validation.constraints 包中的注解对 username 和 password 属性进行了校验。如果参数校验失败,会触发 MethodArgumentNotValidException 异常,在 GlobalExceptionHandler 类中的 handleMethodArgumentNotValidException 方法中进行处理。

总结

在本文中,我们介绍了如何在 SpringBoot 中使用 @ControllerAdvice 注解进行全局异常处理。通过使用 @ControllerAdvice 注解,我们可以集中处理所有 Controller 层抛出的异常,而不必在每个 Controller 中单独处理。在 GlobalExceptionHandler 类中定义异常处理方法,并根据具体的业务需求对异常进行相应的处理,可以大大提高代码的可维护性和可读性。文章来源地址https://www.toymoban.com/news/detail-498319.html

到了这里,关于SpringBoot 如何使用 @ControllerAdvice 注解进行全局异常处理的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • @ControllerAdvice注解使用及原理探究 | 京东物流技术团队

    最近在新项目的开发过程中,遇到了个问题,需要将一些异常的业务流程返回给前端,需要提供给前端不同的响应码,前端再在次基础上做提示语言的国际化适配。这些异常流程涉及业务层和控制层的各个地方,如果每个地方都写一些重复代码显得很冗余。 然后查询解决方案

    2024年02月14日
    浏览(48)
  • springboot使用@Valid 和 @Validated 注解校验详解以及编写一个自定义全局异常类

    全局异常处理类 验证: ============================================== 导入所需要的包: 如果你是 springboot 项目,那么可以不用引入了,已经引入了,他就存在于最核心的 web 开发包里面。 如果你不是 springboot 项目,那么引入下面依赖即可: 新建三个实体类 实现一: 使用@Valid注解修

    2024年02月10日
    浏览(40)
  • SpringBoot中@ControllerAdvice的三种使用场景

    一、全局异常处理 代码示例如下: 全局异常处理类: 二、全局数据绑定 全局数据绑定可以用来做一些初始化数据的操作,我们可以将一些公共的数据定义到添加了@ControllerAdvice注解的类中,这样我们就可以在每一个Controller中可以访问这些数据。 1.定义全局数据绑定类 使用@M

    2024年02月09日
    浏览(45)
  • SpringBoot 使用lombok的@RequiredArgsConstructor注解进行Bean注入

    参考资料: lombok 使用 @RequiredArgsConstructor 注解完成 spring 注入问题 ⏹当我们使用 @Autowired 进行Bean注入的时候,IDEA会提示警告,不建议使用此方式进行注入。Spring官方更推荐使用构造方法进行注入。 ⏹随之而来的问题就是如果一个类中要注入多个对象的话,构造方法进行注入

    2024年02月11日
    浏览(40)
  • 关于在 springboot 中使用 @Autowired 注解来对 TemplateEngine 进行自动装配时,无法注入的问题。

    本文是基于江南一点雨的 Spring Boot+Vue 系列视频教程第 三 章的第三节,详情参考Spring Boot+Vue系列视频教程 在观看学习这一节时,发现当进行手动渲染 Thymeleaf 模板时,通过 @Autowired 注解来对 TemplateEngine 进行自动装配时,发现 idea 对其显示 No beans of \\\'TemplateEngine \\\' type of found。

    2024年02月02日
    浏览(44)
  • 如何在SpringBoot中使用@Value注解来设置默认值

    👽👽👽在Spring Boot中,使用@Value注解可以为属性设置默认值。 @Value注解可以用于注入以下类型的属性: 1、基本数据类型(如字符串、整数、浮点数等) 2、基本数据类型的数组 3、集合类型(如List、Set等) 4、自定义数据类型,包括自定义对象和自定义对象的集合 5、Spri

    2024年02月11日
    浏览(35)
  • 快速教你如何使用postman工具进行接口测试?(配置全局token、JWT可用)

    现在很多人都在使用前后端分离进行项目开发,那在后端开发过程中使用postman测试工具可快速便捷完成接口测试。但是在测试过程中,很多人发现因为JWT的鉴权,导致半个小时就需要更新一下token,让我们的测试变得复杂。 若是将token作为全局变量,每次都能够自动获取tok

    2024年02月15日
    浏览(48)
  • SpringBoot 如何使用 TestEntityManager 进行 JPA 集成测试, 如何使用

    Spring Boot 是一个非常流行的 Java Web 开发框架,它简化了开发过程,提高了开发效率。在开发过程中,我们通常需要使用 JPA 操作数据库,为了保证代码的质量和正确性,我们需要进行集成测试。TestEntityManager 是 Spring Boot 提供的用于 JPA 集成测试的工具,它可以模拟 EntityManag

    2024年02月13日
    浏览(67)
  • SpringBoot 如何使用 @RequestBody 进行数据校验

    在 Web 开发中,前台向后台发送数据是非常常见的场景。而在 SpringBoot 框架中,我们通常使用 @RequestBody 注解来接收前台发送的 JSON 数据,并将其转化为 Java 对象。但是,接收到的数据并不一定是符合要求的,因此我们需要对其进行数据校验。本文将介绍如何在 SpringBoot 中使用

    2024年02月10日
    浏览(35)
  • SpringBoot 如何使用 Spring Test 进行集成测试

    在开发过程中,单元测试是不可或缺的,它可以帮助我们及时发现代码的问题并进行修复,从而提高代码的质量和可维护性。但是,单元测试只能测试单个方法或类的功能,无法测试多个模块之间的交互和整个应用程序的功能。因此,为了确保应用程序的正确性和健壮性,我

    2024年02月10日
    浏览(46)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包