SpringBoot统一返回格式：手把手实现前后端规范交互

在前后端分离开发模式下，统一接口返回格式是实现项目规范化的关键步骤，能有效减少前后端联调中的沟通成本与解析错误。

许多初入行的开发者常面临返回格式不一致、状态码混乱、异常信息杂乱等痛点。本文分享一套可直接复用的SpringBoot统一返回结果工具类，适用于绝大多数Web项目，帮助快速实现接口规范化。

一、统一返回格式的字段定义与规范

统一返回结果通常由四个核心字段构成：状态码（code）、提示信息（msg）、数据体（data）和时间戳（timestamp）。清晰的字段设计能让前端解析更加便捷高效。

• code：自定义业务状态码，例如200表示成功、500表示系统异常、401表示未授权等
• msg：接口返回的提示信息，用于描述操作结果
• data：业务返回数据，若无数据则返回null
• timestamp：接口响应的时间戳，便于追踪请求时间

二、完整的SpringBoot统一返回结果工具类代码

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result

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

三、Controller中的使用示例

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

四、总结与最佳实践

该工具类设计简洁轻量，无冗余代码，支持全局统一返回数据格式。建议配合全局异常处理器使用，效果更佳——在异常发生时调用Result.error()方法，即可返回统一格式的错误信息，前端处理逻辑也因此更加一致。