Java Spring-Boot 轻松搞定 HTTP 统一响应

2023-09-22 08:46:46

Spring Boot HTTP 统一响应：提升开发效率与用户体验

在现代 Web 开发中，API 接口数量不断激增。为确保这些 API 响应格式保持一致，以提高开发效率和用户体验至关重要。Spring Boot 提供了强大的支持，使我们能够轻松实现 HTTP 统一响应。

定义统一响应对象

首先，我们需要创建一个 POJO 类作为所有 HTTP 响应的基类。这个类包含一些基本字段，如状态码、消息和数据。

public class ApiResponse {

    private Integer code;

    private String message;

    private Object data;

    //省略 getter 和 setter 方法
}

配置全局异常处理器

接下来，在 Spring Boot 项目中配置一个全局异常处理器。当发生异常时，该处理器会统一处理并返回一个统一响应对象。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ApiResponse handleException(Exception ex) {
        ApiResponse response = new ApiResponse();
        response.setCode(500);
        response.setMessage("服务器内部错误");
        return response;
    }
}

在控制器方法中返回统一响应对象

在控制器方法中，我们可以通过直接返回统一响应对象或使用 ResponseEntity 来返回统一响应对象。

@GetMapping("/hello")
public ApiResponse hello() {
    ApiResponse response = new ApiResponse();
    response.setCode(200);
    response.setMessage("Hello, World!");
    return response;
}

代码示例

将上述步骤结合起来，我们可以获得以下代码示例：

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

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

    @GetMapping("/hello")
    public ApiResponse hello() {
        ApiResponse response = new ApiResponse();
        response.setCode(200);
        response.setMessage("Hello, World!");
        return response;
    }
}

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ApiResponse handleException(Exception ex) {
        ApiResponse response = new ApiResponse();
        response.setCode(500);
        response.setMessage("服务器内部错误");
        return response;
    }
}