从零开始学Spring Boot系列-返回json数据

欢迎来到从零开始学Spring Boot的旅程！在Spring Boot中，返回JSON数据是很常见的需求，特别是当我们构建RESTful API时。我们对上一篇的Hello World进行简单的修改。

1. 添加依赖
   首先，确保你的build.gradle文件中已经包含了Spring Web的依赖，因为返回JSON数据通常与Web请求和响应有关。Spring Boot的starter-web已经包含了所有必要的依赖，所以如果你使用Spring Initializr创建的项目，这一步应该已经完成了。
   

2. 创建数据模型
   接下来，我们需要一个数据模型来表示我们要返回的JSON数据。先创建一个model的package来存放java类，创建一个User的Java类来表示这个模型。

    package cn.daimajiangxin.springboot.learning.model;
   
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.extern.slf4j.Slf4j;
   
    @Data
    @Slf4j
    @AllArgsConstructor
    public class User {
        private String name;
        private int age;
    }
   

3. 创建控制器
   创建一个控制器来处理HTTP请求并返回JSON数据。使用@RestController和@RequestMapping注解来标记这个类，这样Spring Boot就会自动将返回的对象转换为JSON格式。@RequestMapping注解对请求处理类中的请求处理方法进行标注，@GetMapping注解用于处理HTTP GET请求，并将请求映射到具体的处理方法中。

   package cn.daimajiangxin.springboot.learning.controller;
   
   import cn.daimajiangxin.springboot.learning.model.User;
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.RequestMapping;
   import org.springframework.web.bind.annotation.RestController;
   
   @RestController
   @RequestMapping("/user")
   public class UserController {
   
       @GetMapping("/getUser")
       public User getUser() {
           // 创建一个User对象
           User user = new User("Alice", 30);
           return user; // Spring Boot会自动将User对象转换为JSON格式
       }
   }
   

4. 运行应用程序
   启动你的Spring Boot应用程序。如果一切顺利，当你访问http://localhost:8080/user/getUser时，你应该能看到如下的JSON响应：
   

5. 自定义JSON输出
   有时，你可能需要自定义JSON的输出格式或者包含额外的信息。你可以使用@JsonInclude、@JsonProperty等注解来控制Jackson库（Spring Boot默认的JSON处理库）的序列化行为。例如，你可以使用@JsonInclude(JsonInclude.Include.NON_NULL)来避免输出null值，或者使用@JsonProperty来重命名JSON字段。

   import com.fasterxml.jackson.annotation.JsonInclude;
   import com.fasterxml.jackson.annotation.JsonProperty;
   import lombok.AllArgsConstructor;
   import lombok.Data;
   import lombok.extern.slf4j.Slf4j;
   
   @Data
   @Slf4j
   @AllArgsConstructor
   @JsonInclude(JsonInclude.Include.NON_NULL)
   public class User {
       @JsonProperty("username")
       private String name;
       private int age;
   }

   这样，返回的JSON数据就会将name字段重命名为username，并且不会包含null值。

   

6. 总结
   在Spring Boot中返回JSON数据是一个简单而直接的过程。通过使用@RestController注解和创建适当的数据模型，你可以很容易地构建RESTful API并返回格式化的JSON响应。记住，你可以使用Jackson库的注解来进一步定制JSON的输出格式。

---

源文来自：https://daimajiangxin.cn
源码地址：https://gitee.com/daimajiangxin/springboot-learning