在构建RESTful API时，保持一致的响应格式和有效的异常处理对于提高API的可维护性和用户体验至关重要。Spring Boot作为一款强大的微服务框架，提供了丰富的工具来实现这一目标。本文将详细介绍如何在Spring Boot项目中实现统一结果返回和统一异常处理。

一、引言

在API开发过程中，每个接口可能返回不同类型的数据，同时，也可能遇到各种异常情况。如果没有统一的处理机制，客户端将难以处理这些响应。因此，我们需要设计一套机制来统一API的响应格式，并对异常进行集中处理。

二、统一结果返回

2.1 定义响应结构

首先，我们需要定义一个通用的响应结构。这个结构通常包含状态码、消息提示和返回数据。

public class ApiResponse<T> {
    private int code;    // HTTP状态码
    private String message;  // 响应消息
    private T data;      // 响应数据

    // 构造函数、getter和setter方法
    public ApiResponse(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    // 成功响应的快捷方法
    public static <T> ApiResponse<T> success(T data) {
        return new ApiResponse<>(200, "请求成功", data);
    }

    // 错误响应的快捷方法
    public static <T> ApiResponse<T> error(int code, String message) {
        return new ApiResponse<>(code, message, null);
    }

    // getter和setter方法略...
}

2.2 使用@RestControllerAdvice统一包装响应

我们可以通过@RestControllerAdvice和ResponseBodyAdvice接口来拦截所有的Controller方法响应，并进行统一包装。

@RestControllerAdvice(basePackages = "com.example.yourpackage")
public class ApiResponseAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        // 只包装那些需要进行统一包装的返回类型
        return !returnType.getMethod().isAnnotationPresent(NoApiResponseWrap.class);
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
                                  Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof ApiResponse) {
            return body; // 已经是ApiResponse类型，无需再包装
        }
        return ApiResponse.success(body);
    }
}

这里我们还定义了一个@NoApiResponseWrap注解，用于标记那些不需要统一包装的返回类型。

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface NoApiResponseWrap {
}

三、统一异常处理

3.1 定义全局异常处理器

使用@ControllerAdvice注解可以定义一个全局异常处理器，捕获并处理所有的异常。

@ControllerAdvice(basePackages = "com.example.yourpackage")
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ApiResponse<Void> handleException(Exception e) {
        // 这里可以根据不同的异常类型返回不同的状态码和消息
        return ApiResponse.error(500, "服务器内部错误：" + e.getMessage());
    }

    // 可以添加更多的异常处理方法，处理特定类型的异常
    @ExceptionHandler(NullPointerException.class)
    public ApiResponse<Void> handleNullPointerException(NullPointerException e) {
        return ApiResponse.error(400, "空指针异常：" + e.getMessage());
    }

    // 其他异常处理...
}

3.2 自定义异常

为了更好地管理异常，我们可以定义一些自定义异常，并在全局异常处理器中处理它们。

public class BusinessException extends RuntimeException {
    private int code;

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

    public int getCode() {
        return code;
    }
}

在全局异常处理器中处理自定义异常：

@ExceptionHandler(BusinessException.class)
public ApiResponse<Void> handleBusinessException(BusinessException e) {
    return ApiResponse.error(e.getCode(), e.getMessage());
}

四、总结

通过定义通用的响应结构和全局异常处理器，我们能够在Spring Boot项目中实现统一的结果返回和异常处理。这不仅提高了API的一致性和可维护性，也使得客户端能够更容易地处理这些响应。希望本文能够帮助你在实际项目中更好地应用Spring Boot，构建高质量的RESTful API。