首页 > 编程语言 >SpringBoot统一返回格式：手把手教你实现前后端规范交互

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

来源：互联网 2026-07-16 06:58:05

针对前后端分离项目，提出SpringBoot统一返回结果工具类，包含状态码、提示信息、数据体、时间戳四个核心字段。提供静态方法支持成功与异常响应，简化接口规范，降低联调成本，适配多数Web项目。

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

长期稳定更新的攒劲资源： >>>点此立即查看<<<

许多新手开发常遇到返回格式混乱、状态码不统一、异常返回杂乱等问题。下面分享一套可直接复用的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);
    }
}