【spring boot统一响应结果】

实现Spring Boot中的统一响应结果

在一个Web应用程序中，实现统一的响应结果对于保持一致的API格式和简化开发流程至关重要。Spring Boot框架提供了简单而强大的方法来实现这一目标。

步骤一：定义通用响应类

首先，创建一个通用的响应类，该类将用于封装所有API端点的响应结果。在这个类中，我们可以定义状态码、消息和数据等属性。

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

    // 构造函数、Getter和Setter方法
}

步骤二：统一异常处理

Spring Boot通过@ControllerAdvice和@ExceptionHandler提供全局异常处理的能力。创建一个异常处理类，用来捕获各种异常，并以统一的响应格式返回给前端。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ApiResponse<String>> handleException(Exception e) {
        ApiResponse<String> response = new ApiResponse<>();
        response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
        response.setMessage("An error occurred: " + e.getMessage());
        return new ResponseEntity<>(response, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

步骤三：编写Controller

现在，在编写Controller时，将统一的响应类ApiResponse作为方法的返回类型，确保所有接口都使用统一的格式进行响应。

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

    @GetMapping("/example")
    public ApiResponse<String> getExample() {
        ApiResponse<String> response = new ApiResponse<>();
        response.setStatus(HttpStatus.OK.value());
        response.setMessage("Success");
        response.setData("This is an example response.");
        return response;
    }
}