在 Spring Boot 项目开发中前端对接接口时最头疼的就是响应格式不统一有的返回 JSON 对象有的返回字符串成功和失败结构完全不同。这不仅增加前端调试成本还让后端代码冗余杂乱。今天教你用 10 分钟实现通用统一返回值封装让接口规范又优雅。一、为什么需要统一返回值标准化响应结构前后端协作零沟通成本统一状态码、提示信息、数据格式便于日志监控简化业务代码无需每个接口手动封装返回结果。二、核心代码实现1. 定义统一返回实体类import lombok.Data; Data public class ResultT { // 响应状态码200成功500失败 private Integer code; // 提示信息 private String msg; // 响应数据 private T data; // 成功响应 public static T ResultT success(T data) { ResultT result new Result(); result.setCode(200); result.setMsg(操作成功); result.setData(data); return result; } // 失败响应 public static T ResultT fail(String msg) { ResultT result new Result(); result.setCode(500); result.setMsg(msg); result.setData(null); return result; } }2. 控制器使用示例import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; RestController RequestMapping(/user) public class UserController { // 查询用户 GetMapping(/{id}) public ResultString getUser(PathVariable Integer id) { if (id 1) { return Result.success(张三25岁Java开发); } return Result.fail(用户不存在); } }三、效果演示成功响应{code:200,msg:操作成功,data:张三25岁Java开发}失败响应{code:500,msg:用户不存在,data:null}四、总结统一返回值是 Spring Boot 项目的基础标配几行代码就能解决协作痛点。配合全局异常处理能让整个项目的接口规范度直接拉满无论是团队开发还是个人项目都强烈建议使用。
Spring Boot 接口统一返回值封装,告别杂乱响应格式
在 Spring Boot 项目开发中前端对接接口时最头疼的就是响应格式不统一有的返回 JSON 对象有的返回字符串成功和失败结构完全不同。这不仅增加前端调试成本还让后端代码冗余杂乱。今天教你用 10 分钟实现通用统一返回值封装让接口规范又优雅。一、为什么需要统一返回值标准化响应结构前后端协作零沟通成本统一状态码、提示信息、数据格式便于日志监控简化业务代码无需每个接口手动封装返回结果。二、核心代码实现1. 定义统一返回实体类import lombok.Data; Data public class ResultT { // 响应状态码200成功500失败 private Integer code; // 提示信息 private String msg; // 响应数据 private T data; // 成功响应 public static T ResultT success(T data) { ResultT result new Result(); result.setCode(200); result.setMsg(操作成功); result.setData(data); return result; } // 失败响应 public static T ResultT fail(String msg) { ResultT result new Result(); result.setCode(500); result.setMsg(msg); result.setData(null); return result; } }2. 控制器使用示例import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; RestController RequestMapping(/user) public class UserController { // 查询用户 GetMapping(/{id}) public ResultString getUser(PathVariable Integer id) { if (id 1) { return Result.success(张三25岁Java开发); } return Result.fail(用户不存在); } }三、效果演示成功响应{code:200,msg:操作成功,data:张三25岁Java开发}失败响应{code:500,msg:用户不存在,data:null}四、总结统一返回值是 Spring Boot 项目的基础标配几行代码就能解决协作痛点。配合全局异常处理能让整个项目的接口规范度直接拉满无论是团队开发还是个人项目都强烈建议使用。