在现代Web开发中，统一API响应结果封装是一种常见的实践，它有助于提高代码的可维护性和一致性。通过统一的响应格式，前端可以更容易地处理和展示数据，后端也可以更清晰地管理错误和状态信息。

下面是一个使用Spring Boot框架实现统一API响应结果封装的示例，包括详细的解释。

1. 创建统一的响应结构

首先，我们需要定义一个统一的响应结构类，这个类将包含所有API响应所需的基本信息，如状态码、消息和数据。

public class ApiResponse<T> {
    private int code;
    private String message;
    private T data;

    // 构造函数
    public ApiResponse(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    // Getter和Setter方法
    public int getCode() {
        return code;
    }

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

    public String getMessage() {
        return message;
    }

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

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

2. 创建全局异常处理器

为了确保所有的异常都能被捕获并返回统一的响应格式，我们可以创建一个全局异常处理器。

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ResponseBody
    public ApiResponse<String> handleException(Exception e) {
        return new ApiResponse<>(500, "Internal Server Error: " + e.getMessage(), null);
    }
}

3. 创建控制器示例

接下来，我们创建一个示例控制器，演示如何使用统一的响应结构。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class ExampleController {

    @GetMapping("/hello")
    public ApiResponse<String> sayHello() {
        return new ApiResponse<>(200, "Success", "Hello, World!");
    }
}

4. 配置Spring Boot应用

最后，我们需要确保Spring Boot应用能够扫描到我们的控制器和异常处理器。通常情况下，这可以通过默认的配置来实现，但在某些情况下，可能需要显式指定包扫描路径。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication(scanBasePackages = "com.example") // 确保扫描到你的包路径
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

5. 测试API响应

启动Spring Boot应用后，访问http://localhost:8080/api/hello，你应该会看到如下的JSON响应：

{
    "code": 200,
    "message": "Success",
    "data": "Hello, World!"
}

如果发生任何未捕获的异常，你将会得到类似以下的响应：

{
    "code": 500,
    "message": "Internal Server Error: [具体的错误信息]",
    "data": null
}

总结

通过以上步骤，我们实现了一个统一API响应结果封装的机制。这种机制不仅提高了代码的可读性和可维护性，还使得前后端之间的通信更加一致和可靠。在实际项目中，你可以根据需要进一步扩展和优化这个基础结构，例如添加更多的状态码、支持国际化的消息等。