前后端交互统一的响应结果_测试前后端统一-CSDN博客

本文链接：https://blog.csdn.net/xycxycooo/article/details/140671934

在Java Web项目中，前后端交互统一的响应结果通常通过定义一个通用的响应结构来实现。这种结构可以确保前后端之间的数据交换格式一致，便于管理和维护。以下是一个常见的实现方式，包括定义响应结果类、使用示例以及一些最佳实践。

这里写目录标题

1. 定义响应结果类

首先，我们需要定义一个通用的响应结果类，通常包含以下几个字段：

code：状态码，表示请求的处理结果，如成功、失败、错误等。
message：消息，用于描述请求的处理结果。
data：数据，用于存放请求返回的具体数据。

以下是一个示例：

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

    // 构造方法
    public ResponseResult(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;
    }

    // 静态方法，用于快速创建响应结果对象
    public static <T> ResponseResult<T> success(T data) {
        return new ResponseResult<>(200, "Success", data);
    }

    public static <T> ResponseResult<T> fail(int code, String message) {
        return new ResponseResult<>(code, message, null);
    }
}

2. 使用示例

在控制器（Controller）中使用上述响应结果类，确保所有接口返回统一的响应格式。

import org.springframework.web.bind.annotation.*;

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

    @GetMapping("/user/{id}")
    public ResponseResult<User> getUserById(@PathVariable Long id) {
        // 假设getUserByIdLogic是获取用户信息的逻辑方法
        User user = getUserByIdLogic(id);
        if (user != null) {
            return ResponseResult.success(user);
        } else {
            return ResponseResult.fail(404, "User not found");
        }
    }

    @PostMapping("/user")
    public ResponseResult<User> createUser(@RequestBody User user) {
        // 假设createUserLogic是创建用户的逻辑方法
        User createdUser = createUserLogic(user);
        return ResponseResult.success(createdUser);
    }

    // 模拟的逻辑方法
    private User getUserByIdLogic(Long id) {
        // 查询数据库或其他逻辑
        return new User(id, "John Doe", "john@example.com");
    }

    private User createUserLogic(User user) {
        // 保存到数据库或其他逻辑
        user.setId(1L); // 假设生成了ID
        return user;
    }
}

3. 最佳实践

3.1 定义状态码常量

为了便于管理和维护状态码，可以定义一个常量类来存放常用的状态码和消息。

public class ResponseCode {
    public static final int SUCCESS = 200;
    public static final int NOT_FOUND = 404;
    public static final int SERVER_ERROR = 500;
    // 其他状态码...
}

3.2 全局异常处理

通过全局异常处理机制，可以确保所有未捕获的异常都能返回统一的响应格式。

import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseResult<String> handleException(Exception e) {
        return ResponseResult.fail(ResponseCode.SERVER_ERROR, e.getMessage());
    }
}

3.3 使用枚举类

可以使用枚举类来定义状态码和消息，使代码更加清晰和易于扩展。

public enum ResponseStatus {
    SUCCESS(200, "Success"),
    NOT_FOUND(404, "Not Found"),
    SERVER_ERROR(500, "Server Error");

    private final int code;
    private final String message;

    ResponseStatus(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

然后在响应结果类中使用枚举类：

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

    public ResponseResult(ResponseStatus status, T data) {
        this.code = status.getCode();
        this.message = status.getMessage();
        this.data = data;
    }

    // 静态方法，用于快速创建响应结果对象
    public static <T> ResponseResult<T> success(T data) {
        return new ResponseResult<>(ResponseStatus.SUCCESS, data);
    }

    public static <T> ResponseResult<T> fail(ResponseStatus status) {
        return new ResponseResult<>(status, null);
    }
}