深入理解 JSON 数据传递方式：数组格式与对象包装格式的对比与选择

本文链接：https://blog.youkuaiyun.com/weixin_46146718/article/details/145010159

深入理解 JSON 数据传递方式：数组格式与对象包装格式的对比与选择

深入理解 JSON 数据传递方式：数组格式与对象包装格式的对比与选择

深入理解 JSON 数据传递方式：数组格式与对象包装格式的对比与选择

在 Web 开发中，前后端通信常常通过 JSON 格式的数据来进行交互。JSON 是一种轻量级的数据交换格式，结构简单，易于人类阅读和编写，同时也易于机器解析和生成。在实际开发中，我们通常会遇到不同的 JSON 数据结构，特别是 数组格式 和 对象包装格式 两种常见的方式。理解这两种格式的区别及应用场景，对于提高前后端协作的效率至关重要。

本文将深入探讨这两种格式的区别，并分析它们的实际应用场景，以帮助开发者在实际工作中做出更合适的选择。

一、JSON 数组格式与对象包装格式的概述

1. JSON 数组格式

JSON 数组格式是指数据以数组的形式传递，每个数组元素都是一个对象。每个对象包含若干个字段。通常，当我们需要传递一组相同结构的数据时，数组格式显得非常简洁明了。

示例：

[
  {
    "functionalBusinessId": "abc",
    "anotherField": "value"
  },
  {
    "functionalBusinessId": "def",
    "anotherField": "value"
  }
]

在这个示例中，整个数据结构是一个数组，数组内有两个对象，每个对象有 functionalBusinessId 和 anotherField 两个字段。

2. JSON 对象包装格式

JSON 对象包装格式则是将数据包含在一个对象中，数组是该对象的一个属性。通常在我们需要传递多个相关数据字段时，使用对象包装格式能够清晰地组织数据结构。

示例：

{
  "functionalBusinessFieldDTO": [
    {
      "functionalBusinessId": "abc",
      "anotherField": "value"
    },
    {
      "functionalBusinessId": "def",
      "anotherField": "value"
    }
  ]
}

在这个示例中，数据被包含在一个对象中，该对象的键是 functionalBusinessFieldDTO，值是一个包含多个元素的数组。

二、数组格式与对象包装格式的主要区别

1. 数据结构的不同

数组格式：数据直接以数组的形式传递，每个元素是一个对象。适用于数据内容相对简单、字段较少的场景，通常是一个列表。

例如，前端要提交一组类似的订单数据时，可以直接使用数组格式。
对象包装格式：数据包含在一个对象内，数组是对象的一个属性。这种方式可以组织更复杂的数据结构，特别适合数据字段较多或者需要传递多种数据类型时。

例如，前端要提交包含多个数据集合（如订单数据、用户信息等）的复杂请求时，使用对象包装格式能够清晰地标明每一类数据。

2. 后端处理的差异

数组格式：后端接收的通常是一个数组类型的数据。以 Java 为例，后端方法可以直接接收一个 List<T> 类型的参数，并对其进行处理。

@PostMapping("/addFunctionalBusinessFieldList")
public Result addFunctionalBusinessField(@RequestBody List<FunctionalBusinessFieldDTO> functionalBusinessFieldDTOList) {
    // 处理 functionalBusinessFieldDTOList
}

对象包装格式：后端通常需要一个对应的对象类来接收请求数据，该对象类会包含一个字段来存储数组数据。以 Java 为例，后端方法可能需要一个包装类，如 FunctionalBusinessFieldRequest 来接收请求体。

public class FunctionalBusinessFieldRequest {
    private List<FunctionalBusinessFieldDTO> functionalBusinessFieldDTO;

    // getter 和 setter
}

@PostMapping("/addFunctionalBusinessFieldList")
public Result addFunctionalBusinessField(@RequestBody FunctionalBusinessFieldRequest request) {
    List<FunctionalBusinessFieldDTO> functionalBusinessFieldDTOList = request.getFunctionalBusinessFieldDTO();
    // 处理 functionalBusinessFieldDTOList
}

3. 使用场景的不同

数组格式：
- 当请求的数据本身是一个简单的列表时，数组格式更加直观。例如：一组订单项、一批用户信息等。
- 数据内容相对简单，字段少且一致。
对象包装格式：
- 当请求的数据包含多个不同类型的字段时，使用对象包装格式更为合理。例如：一个包含多个数据集合的请求体，或者某些数据字段之间需要逻辑分隔的情况。
- 数据较为复杂，需要更好的结构化来进行传递。

三、何时选择数组格式，何时选择对象包装格式？

1. 选择数组格式

当你需要传递的数据是同类型、同结构的多个元素时，使用数组格式非常直观。例如，你需要提交一组商品订单，每个订单的数据结构相同：

[
  {
    "orderId": "001",
    "productName": "Item A",
    "quantity": 2
  },
  {
    "orderId": "002",
    "productName": "Item B",
    "quantity": 3
  }
]

这种情况下，数组格式既简洁又清晰，后端接收时也可以直接用列表处理。

2. 选择对象包装格式

当你需要传递的数据是多层次、结构化的，或者需要组织多个相关字段时，使用对象包装格式会更适合。例如，当请求体中包含不同的数据字段时，你可能希望将它们组织在同一个对象内：

{
  "userInfo": {
    "userId": "12345",
    "userName": "JohnDoe"
  },
  "orders": [
    {
      "orderId": "001",
      "productName": "Item A",
      "quantity": 2
    },
    {
      "orderId": "002",
      "productName": "Item B",
      "quantity": 3
    }
  ]
}