欢送来到从零开始学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