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

在前后端分离的项目中，统一接口返回格式是项目规范化的基础，能极大降低前后端联调成本。

很多新手开发会遇到返回格式混乱、状态码不统一、异常返回杂乱等问题。这里分享一套可直接复用的SpringBoot统一返回结果工具类，适配绝大多数Web项目。

一、统一返回格式规范

统一返回结果通常包含四个核心字段：状态码、提示信息、数据体、时间戳。字段设计清晰，前端解析起来也方便。

• 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  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()即可，前端处理逻辑也随之统一。