关于java:从零开始学Spring-Boot系列返回json数据

60次阅读

共计 2072 个字符，预计需要花费 6 分钟才能阅读完成。

欢送来到从零开始学 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 类来示意这个模型。

 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;
 }

创立控制器
创立一个控制器来解决 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 格局
    }
}

运行应用程序
启动你的 Spring Boot 应用程序。如果一切顺利，当你拜访 http://localhost:8080/user/getUser 时，你应该能看到如下的 JSON 响应：
自定义 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 值。
总结
在 Spring Boot 中返回 JSON 数据是一个简略而间接的过程。通过应用 @RestController 注解和创立适当的数据模型，你能够很容易地构建 RESTful API 并返回格式化的 JSON 响应。记住，你能够应用 Jackson 库的注解来进一步定制 JSON 的输入格局。