转载

Spring Boot教程(12) – 编写JSON API

目前很多公司开发项目，都选择了前后端分离的方式，不仅仅因为前端现在有丰富的生态和活跃的社区，更是因为分离让前端和后端的耦合度大大降低。前后端开发人员各司其职，各自做擅长的事情，提高了团队效率。而现在在电脑前学Spring Boot的你，很可能在将来的工作中扮演后端API开发的角色。

前端和后端的数据交换格式，现在用的最广泛的是 JSON ，Spring Boot的Web Starter也自带了JSON的支持，而且选用了 Jackson 库，我之前也写过它如何使用，阅读本文之前最好看一看。另外，还有个JSON库叫 Gson ，使用也比较广泛，加入了Gson的依赖之后，可以通过配置将其作为默认的JSON库。

对于前后端一体的应用，请求处理处理方法会返回模板的名字用来生成页面。而写接口的话，就需要在方法上添加 @ResponseBody 注解。你返回一个字符串，请求接口就会得到一个字符串。

接下来看看如何返回JSON（不要告诉我你是通过手动拼接字符串来完成的）。Spring Boot的自动配置会给你自动生成一个 ObjectMapper 对象，你可以通过自动配置引入它。同时它可以用来创建 ObjectNode ，方便操作JSON，我们看个例子：

图中我们创建了一个 ObjectNode 对象，加点数据，并将其直接返回。通过请求这个API，就得到了JSON对象。你一定想问，我返回了个对象，Spring怎么就知道该怎么转换呢？

这样的转换工作是通过 HttpMessageConverter 来完成的，程序运行的时候，会有个 HttpMessageConverter 列表，得到方法返回的对象之后，框架会逐个询问谁能完成转换。对于Spring Boot来说，自动配置会给你生成很多 HttpMessageConverter 对象的。相关逻辑在源码 HttpMessageConvertersAutoConfiguration 中，如果你引入了Jackson，那么会得到一个 MappingJackson2HttpMessageConverter ，把 ObjectNode 转化为响应中的JSON字符串的工作就是他做的。 HttpMessageConvertersAutoConfiguration 里还配置了个 StringHttpMessageConverter ，如果请求处理方法返回的是字符串，会交由它来处理，本文的第一个例子就是这种情况。 HttpMessageConverter 相关的东西还是挺多的，我就不展开讲了。

直接返回ObjectNode的做法还不是很直观。现在通行的做法是把JSON映射成Java对象，这样理解起来更清晰，重构起来更容易。