SpringBoot统一返回格式怎么做？手把手教你实现前后端规范交互

更新时间：2026年07月13日 09:44:34 作者：点击创客科技

还在为前后端接口返回格式混乱发愁吗？本文分享一套可直接复用的SpringBoot统一返回结果工具类,规范状态码、提示信息、数据体和时间戳,让你的项目接口返回清晰一致,大幅降低前后端联调成本,实用代码示例即拿即用

一、统一返回格式规范

统一包含4个核心字段：状态码、提示信息、数据体、时间戳，结构清晰、前端易解析。

code：自定义业务状态码（200成功、500系统异常、401未授权等）
msg：接口返回提示文案
data：业务返回数据，无数据时返回null
timestamp：接口响应时间戳

二、完整工具代码

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result

// 状态码
private Integer code;
// 提示信息
private String msg;
// 返回数据
private T data;
// 时间戳
private long timestamp = System.currentTimeMillis();
// 成功无返回数据
public static <T> Result<T> success() {
    return new Result<>(200, "操作成功", null);
}
// 成功带返回数据
public static <T> Result<T> success(T data) {
    return new Result<>(200, "操作成功", data);
}
// 失败自定义提示
public static <T> Result<T> error(String msg) {
    return new Result<>(500, msg, null);
}
// 自定义状态码+提示
public static <T> Result<T> error(Integer code, String msg) {
    return new Result<>(code, msg, null);
}

三、Controller

@RestController
@RequestMapping(“/user”)
public class UserController {
@GetMapping("/info")
public Result<User> getUserInfo() {
    User user = new User("张三", 22);
    return Result.success(user);
}
}

四、总结

该工具类简洁轻量、无冗余代码，支持全局统一返回，可结合全局异常处理器使用，

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

关于logback.xml和logback-spring.xml的区别及说明
这篇文章主要介绍了关于logback.xml和logback-spring.xml的区别及说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-06-06
ArrayList和HashMap如何自己实现实例详解
这篇文章主要介绍了 ArrayList和HashMap如何自己实现的相关资料,需要的朋友可以参考下
2016-12-12
Spring如何正确注入集合类型
这篇文章主要介绍了Spring如何正确注入集合类型，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-09-09
spring依赖注入深入理解
这篇文章主要介绍了spring依赖注入深入理解，列举了最常见的注入方式，有感兴趣的同学可以研究下
2021-03-03
Java日常练习题,每天进步一点点(48)
下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧，希望可以帮到你
2021-08-08
Java自带注解、元注解、自定义注解的区别
本文主要介绍了Java自带注解、元注解、自定义注解的区别，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-06-06
Java设计模式之桥接模式实例详解
这篇文章主要介绍了Java设计模式之桥接模式,结合实例形式详细分析了桥接模式的概念、功能、Java实现方法及相关注意事项,需要的朋友可以参考下
2017-09-09
Java实现随机出题，10道10以内加减法计算代码实例
这篇文章主要介绍了Java实现随机出题，10道10以内加减法计算，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-04-04
Java中EnumSet代替位域代码详解
这篇文章主要介绍了Java中EnumSet代替位域代码详解，分享了相关代码示例，小编觉得还是挺不错的，具有一定借鉴价值，需要的朋友可以参考下
2018-02-02
mybatis的插件机制示例详解
这篇文章主要给大家介绍了关于mybatis插件机制的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用mybatis具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2019-06-06