SpringBoot - 注解使用场景

@ControllerAdvice

1、 自定义异常处理

1.创建一个自定义异常类，继承自Exception或RuntimeException，例如：

public class CustomException extends RuntimeException {
    // 添加自定义异常信息或处理逻辑
}

2.创建一个全局异常处理器类，实现@ControllerAdvice注解和@ExceptionHandler注解，例如：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<ResponseData> handleCustomException(CustomException ex) {
        // 处理自定义异常
        // 可以根据需要返回不同的响应数据或状态码
        ResponseData responseData = new ResponseData();
        responseData.setCode(HttpStatus.INTERNAL_SERVER_ERROR.value());
        responseData.setMessage(ex.getMessage());
        return new ResponseEntity<>(responseData, HttpStatus.INTERNAL_SERVER_ERROR);
    }

    // 可以添加其他异常处理方法，处理其他类型的异常

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ResponseData> handleException(Exception ex) {
        // 处理其他异常
        ResponseData responseData = new ResponseData();
        responseData.setCode(HttpStatus.INTERNAL_SERVER_ERROR.value());
        responseData.setMessage("Internal server error");
        return new ResponseEntity<>(responseData, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

2、封装处理接口返回值

@ControllerAdvice
public class CustomResponseBodyAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        // 可以在这里判断是否需要对返回值进行处理，返回true表示需要处理，返回false表示不处理
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        // 在这里对返回值进行处理，可以修改返回值的内容或格式
        // 返回处理后的结果
        return modifiedBody;
    }
}