【SpringBoot Web框架实战教程】04 SpringBoot 规范统一输出 json

不积跬步，无以至千里；不积小流，无以成江海。大家好，我是闲鹤，微信：xxh_1459，十多年开发、架构经验，先后在华为、迅雷服役过，也在高校从事教学3年；目前已创业了7年多，主要从事物联网/车联网相关领域和业务。喜欢交友、骑行、写毛笔字、弹吉他、折腾硬件和写代码。

---

导读

这是一系列关于 SpringBoot Web框架实战 的教程，从项目的创建，到一个完整的 web 框架（包括异常处理、拦截器、context 上下文等）；从0开始，到一个可以直接运用在生产环境中的web框架，所有源码均开源。

---

正文

我们写的 Spring Boot 这一系列文章，是以最终开发一个web api项目为目标，根据开发所需，逐步来学习和撰写的。比如：

• 第一篇 使用 pom 方式创建 SpringBoot 第一个项目，这篇介绍了如何以最简单的方式运行了一个 Spring Boot 项目；

• 第二篇 Spring Boot 返回 JSON，描述了如何返回 json 格式数据；

• 第三篇 Sping Boot 获取 http 请求参数，介绍了如何使用 Spring Boot 获取 api 请求接口的参数；

由于我们的目标是开发一个提供 api json 接口访问的 web server，一般情况下，对于统一对外的 api json 接口，都有一定的格式规范，比如类似以下格式：

{
    code: 200,
    msg: "success",
    data: {}
}

所以，这篇，我们先把一个基本的 Rest api 框架的统一规范输出给设计好。

创建返回的数据结构

我们以上面的格式为我们所需要的返回数据格式，可以看出，这里基本有3个字段：

<

字段	类型	含义
code	Int