springboot怎么返回嵌套json

Spring Boot 实战：轻松搞定嵌套 JSON 数据返回**

在现代 Web 开发中，JSON（JavaScript Object Notation）已成为前后端数据交换的主流格式，Spring Boot 作为当前流行的 Java Web 开发框架，提供了强大的 JSON 数据处理能力，在实际业务场景中，我们经常需要返回结构复杂的嵌套 JSON 数据，例如一个订单信息中包含多个商品详情，或者一个用户信息关联多个地址，本文将详细介绍在 Spring Boot 中如何优雅地返回嵌套 JSON 数据。

核心原理：默认的 JSON 序列化机制

Spring Boot 默认使用 Jackson 库来处理 JSON 序列化和反序列化，当我们在 Controller 中返回一个 Java 对象时，Spring Boot 会自动通过 Jackson 的 ObjectMapper 将该对象转换为 JSON 字符串并写入响应体，Jackson 会递归地遍历对象的所有属性，并将其转换为 JSON 的键值对，对于嵌套对象，Jackson 会自动将其转换为嵌套的 JSON 结构。

实现嵌套 JSON 返回的几种常见方式

实体类嵌套（最常用、最推荐的方式）

这是最直接也是最常用的方式,我们通过在实体类中定义其他实体类类型的属性，来表示 JSON 数据中的嵌套关系。

步骤：

定义嵌套的实体类

我们有一个 Address 类（地址）和一个 User 类（用户），用户类中包含地址信息。

// Address.java
public class Address {
    private String city;
    private String street;
    private String zipCode;
    // 构造方法、getters、setters 省略，建议使用 Lombok 简化代码
}
// User.java
public class User {
    private Long id;
    private String name;
    private Integer age;
    private Address address; // 嵌套 Address 对象
    // 构造方法、getters、setters 省略
}

创建 Controller 并返回嵌套对象

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        // 模拟从数据库或其他服务获取数据
        User user = new User();
        user.setId(idL);
        user.setName("张三");
        user.setAge(30);
        Address address = new Address();
        address.setCity("北京市");
        address.setStreet("朝阳区某某街道");
        address.setZipCode("100000");
        user.setAddress(address);
        return user; // 直接返回 User 对象
    }
}

访问接口并查看返回结果

当我们访问 GET /api/users/1 时，Spring Boot 会自动将 User 对象序列化为如下 JSON：

{
    "id": 1,
    "name": "张三",
    "age": 30,
    "address": {
        "city": "北京市",
        "street": "朝阳区某某街道",
        "zipCode": "100000"
    }
}

这样,嵌套 JSON 就轻松实现了。

使用 List 或 Map 嵌套

当嵌套的部分是多个对象或者键值对不固定时,可以使用 List 或 Map 来实现。

示例：返回用户及其多个订单

// Order.java
public class Order {
    private Long orderId;
    private String orderName;
    private Double amount;
    // 构造方法、getters、setters 省略
}
// UserWithOrders.java (或者直接在 User 类中添加 orders 属性)
public class User {
    // ... 其他属性
    private List<Order> orders; // 嵌套 List<Order>
    private Map<String, Object> extraInfo; // 嵌套 Map
}

Controller 中返回这样的对象，JSON 会自动处理成：

{
    "id": 1,
    "name": "张三",
    "orders": [
        {
            "orderId": 1001,
            "orderName": "商品A",
            "amount": 99.99
        },
        {
            "orderId": 1002,
            "orderName": "商品B",
            "amount": 149.99
        }
    ],
    "extraInfo": {
        "key1": "value1",
        "key2": 123
    }
}

使用 @JsonView 控制序列化视图（高级用法）

我们希望在不同的接口返回同一对象的不同字段组合,或者某些嵌套字段在某些情况下不需要显示，这时可以使用 Jackson 的 @JsonView 注解。

步骤：

定义视图接口

public class Views {
    public static class Public {}
    public static class Internal extends Public {}
}

在实体类属性上指定视图

public class User {
    @JsonView(Views.Public.class)
    private Long id;
    @JsonView(Views.Public.class)
    private String name;
    @JsonView(Views.Internal.class)
    private Integer age;
    @JsonView(Views.Internal.class)
    private Address address;
    // getters, setters
}

在 Controller 方法上指定视图

@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping("/{id}")
    @JsonView(Views.Public.class) // 只返回 Public 视图包含的字段
    public User getUserPublic(@PathVariable Long id) {
        // ... 构造 user 对象
        return user;
    }
    @GetMapping("/{id}/detail")
    @JsonView(Views.Internal.class) // 返回 Internal 视图包含的字段（更多字段）
    public User getUserDetail(@PathVariable Long id) {
        // ... 构造 user 对象
        return user;
    }
}

这样,/api/users/1 可能只返回 id 和 name，而 /api/users/1/detail 会返回所有字段（包括嵌套的 address）。

自定义 JSON 序列化（@JsonSerializer）

如果默认的序列化方式不满足需求,例如某个嵌套对象的格式需要特殊处理，可以自定义 JsonSerializer。

示例：自定义日期格式

public class CustomDateSerializer extends JsonSerializer<Date> {
    @Override
    public void serialize(Date date, JsonGenerator gen, SerializerProvider provider) throws IOException {
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        gen.writeString(dateFormat.format(date));
    }
}
// 在实体类字段上使用
public class Event {
    private String name;
    @JsonSerialize(using = CustomDateSerializer.class)
    private Date eventDate;
    // ...
}

或者对整个嵌套对象进行复杂序列化逻辑。

注意事项与最佳实践

避免循环引用：如果在实体类 A 中包含实体类 B 的引用，而实体类 B 又包含实体类 A 的引用，直接序列化会导致栈溢出（StackOverflowError），解决方法：
- 使用 @JsonManagedReference 和 @JsonBackReference（适用于双向一对一或一对多）。
- 使用 @JsonIgnore 在某一端忽略引用。
- 使用 @JsonIdentityInfo（生成唯一标识符来处理循环引用）。
字段命名：默认情况下，Java 字段名会转换为 JSON 的驼峰命名法，如果需要不同的命名风格（如下划线），可以在 application.properties 或 application.yml 中配置：
```
spring.jackson.property-naming-strategy=SNAKE_CASE
```
或者在实体类字段上使用 @JsonProperty("json_name") 注解指定。
空值处理：默认情况下，null 值的字段会被包含在 JSON 中，可以通过配置来忽略 null 值字段：
```
spring.jackson.default-property-inclusion=NON_NULL # 或者 NON_EMPTY
```
或者在字段上使用 @JsonInclude(Include.NON_NULL)。
使用 Lombok 简化代码：@Data, @Getter, @Setter 等 Lombok 注解可以大大减少样板代码，让实体类更简洁。
单元测试：对于复杂的嵌套 JSON 返回，建议编写单元测试（如使用 MockMvc）来验证返回的 JSON 结构和内容是否符合预期。

Spring Boot 返回嵌套 JSON 主要依赖于 Jackson 库的强大功能，通过合理设计实体类的嵌套结构，并结合 @JsonView、@JsonSerialize 等注解，我们可以灵活地控制 JSON 的输出格式和内容，在实际开发中，需要注意循环引用、字段命名、空值处理等常见问题，并遵循最佳实践，以确保代码