Java Web Spring Boot中`@RestControllerAdvice`的常见用法

概念解释

@RestControllerAdvice 是Spring框架中的一个注解，用于定义全局异常处理类。它结合了@ControllerAdvice和@ResponseBody的功能，专门用于处理RESTful Web服务的异常。通过使用@RestControllerAdvice，开发者可以集中处理控制器类中抛出的异常，并返回统一的JSON格式错误信息。

常见用法

1. 全局异常处理

使用@RestControllerAdvice可以定义一个全局异常处理类，捕获并处理所有控制器中抛出的异常。

示例代码：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    // 处理自定义异常
    @ExceptionHandler(CustomException.class)
    public ResponseEntity<ErrorResponse> handleCustomException(CustomException ex) {
        ErrorResponse errorResponse = new ErrorResponse(ex.getCode(), ex.getMessage());
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }

    // 处理所有未捕获的异常
    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        ErrorResponse errorResponse = new ErrorResponse("500", "Internal Server Error");
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

// 自定义异常类
class CustomException extends RuntimeException {
    private String code;

    public CustomException(String code, String message) {
        super(message);
        this.code = code;
    }

    public String getCode() {
        return code;
    }
}

// 错误响应类
class ErrorResponse {
    private String code;
    private String message;

    public ErrorResponse(String code, String message) {
        this.code = code;
        this.message = message;
    }

    // getters and setters
    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

2. 特定控制器的异常处理

通过在@RestControllerAdvice注解中指定basePackages或basePackageClasses属性，可以限制异常处理类只处理特定包或特定控制器中的异常。

示例代码：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice(basePackages = "com.example.controller")
public class SpecificControllerExceptionHandler {

    // 处理特定控制器中的自定义异常
    @ExceptionHandler(CustomException.class)
    public ResponseEntity<ErrorResponse> handleCustomException(CustomException ex) {
        ErrorResponse errorResponse = new ErrorResponse(ex.getCode(), ex.getMessage());
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }
}

3. 结合@ExceptionHandler使用

@RestControllerAdvice通常与@ExceptionHandler注解一起使用，用于指定处理特定类型的异常。

示例代码：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    // 处理自定义异常
    @ExceptionHandler(CustomException.class)
    public ResponseEntity<ErrorResponse> handleCustomException(CustomException ex) {
        ErrorResponse errorResponse = new ErrorResponse(ex.getCode(), ex.getMessage());
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }

    // 处理所有未捕获的异常
    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        ErrorResponse errorResponse = new ErrorResponse("500", "Internal Server Error");
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

总结

通过以上示例，我们可以看到@RestControllerAdvice在Spring Boot中的常见用法，包括全局异常处理、特定控制器的异常处理以及结合@ExceptionHandler使用。这些方法可以帮助开发者集中处理控制器中的异常，并返回统一的JSON格式错误信息，提高代码的可维护性和可读性。希望这些示例和解释能帮助你更好地理解和使用@RestControllerAdvice。