谈论SpringBoot自定义全局异常处理器

2022-12-19 14:48:06

SpringBoot中的异常处理：使用注解和自定义异常类的简洁指南

在日常的SpringBoot项目开发中，不可避免地会出现错误或用户请求报错的情况。这时，我们就需要向用户返回友好的提示，或者给系统反馈一些错误信息。自定义返回错误信息是一项在开发中非常常用的技能，而使用注解和自定义异常类的方法是其中最为简单易懂的方式。

本文将深入讲解SpringBoot中异常处理的细节，帮助你轻松驾驭这一重要机制。

1. 注解的使用

SpringBoot提供了两个注解，帮助我们轻松实现全局异常处理：

@ControllerAdvice ：用于标记一个类为全局异常处理器。
@ExceptionHandler ：用于将指定的异常绑定到处理的函数上。

利用这两个注解，我们可以非常方便地实现全局异常处理。例如，我们定义一个如下所示的类：

@ControllerAdvice
public class GlobalExceptionHandler {

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

在这个类中，@ControllerAdvice注解表明该类是一个全局异常处理器。@ExceptionHandler注解将Exception异常绑定到handleException方法上。这样，当发生Exception异常时，系统就会调用handleException方法。

2. 自定义异常类的定义

有时，为了处理特定类型的错误，我们需要定义自己的异常类。例如，我们可以定义一个BusinessException类，用于处理业务逻辑中的错误：

public class BusinessException extends RuntimeException {

    private String message;

    public BusinessException(String message) {
        super(message);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

然后，我们可以使用@ExceptionHandler注解将BusinessException异常绑定到处理的函数上：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BusinessException.class)
    public ResponseEntity<Object> handleBusinessException(BusinessException e) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
    }
}

这样，当发生BusinessException异常时，系统就会调用handleBusinessException方法。我们可以自定义返回给用户的错误信息。

3. 继承异常类的使用

如果你想处理所有类型的异常，可以定义一个继承Exception类的异常类，如下所示：

public class MyException extends Exception {

    private String message;

    public MyException(String message) {
        super(message);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

然后，可以在全局异常处理器中使用@ExceptionHandler注解将MyException异常绑定到处理的函数上：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MyException.class)
    public ResponseEntity<Object> handleMyException(MyException e) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
    }
}

这样，当发生任何类型的异常时，系统都会调用handleMyException方法。我们可以自定义返回给用户的错误信息。

总结

SpringBoot提供了多种方式帮助我们实现全局异常处理。我们可以根据自己的需要选择合适的方式。使用注解和自定义异常类的方法是最为简单易懂的。希望本文能帮助你轻松驾驭SpringBoot的异常处理机制。

常见问题解答