Spring Boot 统一数据返回格式

在Spring Boot中,为了统一数据的返回格式,你可以创建一个自定义的ResponseEntity封装类。以下是一个简单的例子:




import org.springframework.http.ResponseEntity;
 
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;
    }
 
    // Getters and Setters
    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> ResponseEntity<ResponseResult<T>> ok(T data) {
        return ResponseEntity.ok(new ResponseResult<>(200, "OK", data));
    }
 
    public static <T> ResponseEntity<ResponseResult<T>> error(int code, String message) {
        return ResponseEntity.status(code).body(new ResponseResult<>(code, message, null));
    }
}

使用ResponseResult类,你可以在你的Controller方法中这样返回数据:




@GetMapping("/some-endpoint")
public ResponseEntity<ResponseResult<SomeData>> getSomeData() {
    SomeData data = ...; // 获取数据的逻辑
    return ResponseResult.ok(data);
}

如果有错误发生,你可以这样返回错误信息:




@GetMapping("/some-endpoint")
public ResponseEntity<ResponseResult<Void>> handleError() {
    int errorCode = ...; // 错误代码
    String errorMessage = ...; // 错误信息
    return ResponseResult.error(errorCode, errorMessage);
}

这样,你的所有响应都将具有统一的格式,方便客户端处理。

最后修改于:2024年09月02日 16:42

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日