ToB企服应用市场:ToB评测及商务社交产业平台

标题: 从零开始学Spring Boot系列-返回json数据 [打印本页]

---

作者: 缠丝猫    时间: 2024-5-12 13:38
标题: 从零开始学Spring Boot系列-返回json数据
接待来到从零开始学Spring Boot的路程！在Spring Boot中，返回JSON数据是很常见的需求，特殊是当我们构建RESTful API时。我们对上一篇的Hello World进行简单的修改。

• 添加依赖
  起首，确保你的build.gradle文件中已经包罗了Spring Web的依赖，由于返回JSON数据通常与Web请求和响应有关。Spring Boot的starter-web已经包罗了所有必要的依赖，以是如果你利用Spring Initializr创建的项目，这一步应该已经完成了。
  
  
  
  
• 创建数据模型
  接下来，我们需要一个数据模型来表示我们要返回的JSON数据。先创建一个model的package来存放java类，创建一个User的Java类来表示这个模型。
  1. package cn.daimajiangxin.springboot.learning.model;
  3. import lombok.AllArgsConstructor;
  4. import lombok.Data;
  5. import lombok.extern.slf4j.Slf4j;
  7. @Data
  8. @Slf4j
  9. @AllArgsConstructor
  10. public class User {
  11.      private String name;
  12.      private int age;
  13. }

  复制代码
• 创建控制器
  创建一个控制器来处理HTTP请求并返回JSON数据。利用@RestController和@RequestMapping注解来标记这个类，这样Spring Boot就会主动将返回的对象转换为JSON格式。@RequestMapping注解对请求处理类中的请求处理方法进行标注，@GetMapping注解用于处理HTTP GET请求，并将请求映射到具体的处理方法中。
  1. package cn.daimajiangxin.springboot.learning.controller;
  3. import cn.daimajiangxin.springboot.learning.model.User;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RequestMapping;
  6. import org.springframework.web.bind.annotation.RestController;
  8. @RestController
  9. @RequestMapping("/user")
  10. public class UserController {
  12.     @GetMapping("/getUser")
  13.     public User getUser() {
  14.         // 创建一个User对象
  15.         User user = new User("Alice", 30);
  16.         return user; // Spring Boot会自动将User对象转换为JSON格式
  17.     }
  18. }

  复制代码
• 运行应用步伐
  启动你的Spring Boot应用步伐。如果一切顺利，当你访问http://localhost:8080/user/getUser时，你应该能看到如下的JSON响应：
  
  
  
  
• 自定义JSON输出
  有时，你可能需要自定义JSON的输出格式大概包罗额外的信息。你可以利用@JsonInclude、@JsonProperty等注解来控制Jackson库（Spring Boot默认的JSON处理库）的序列化行为。比方，你可以利用@JsonInclude(JsonInclude.Include.NON_NULL)来制止输出null值，大概利用@JsonProperty来重命名JSON字段。
  1. import com.fasterxml.jackson.annotation.JsonInclude;
  2. import com.fasterxml.jackson.annotation.JsonProperty;
  3. import lombok.AllArgsConstructor;
  4. import lombok.Data;
  5. import lombok.extern.slf4j.Slf4j;
  7. @Data
  8. @Slf4j
  9. @AllArgsConstructor
  10. @JsonInclude(JsonInclude.Include.NON_NULL)
  11. public class User {
  12.     @JsonProperty("username")
  13.     private String name;
  14.     private int age;
  15. }

  复制代码
  这样，返回的JSON数据就会将name字段重命名为username，并且不会包罗null值。
  
  
  
  
• 总结
  在Spring Boot中返回JSON数据是一个简单而直接的过程。通过利用@RestController注解和创建恰当的数据模型，你可以很轻易地构建RESTful API并返回格式化的JSON响应。记住，你可以利用Jackson库的注解来进一步定制JSON的输出格式。
  

我是代码匠心，和我一起学习更多精彩知识！！！扫描二维码！关注我，实时获取推送。

源文来自：https://daimajiangxin.cn

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

---

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)

Powered by Discuz! X3.4