化繁为简：一键解决 Post 请求 JSON 列表参数格式报错

2023-11-27 06:46:44

破解 Post 请求 JSON 列表参数格式报错的奥秘

直面问题，共寻解决方案

在处理 Post 请求时，JSON 格式是数据传输的常见选择。然而，当涉及到使用 Java 的 ArrayList 作为参数时，我们可能会遇到一个恼人的错误提示："JSON 解析错误：无法反序列化类型 java.util.ArrayList＜x＞ 的值"。

一招制敌，轻松搞定报错

问题的根源在于 JSON 数据结构的不正确。具体来说，当我们在 JSON 中使用 ArrayList 数据时，必须用数组来包裹它们。

示例代码：

// 错误的 JSON 格式
{
    "id": 1,
    "list": [1, 2, 3]
}

// 正确的 JSON 格式
{
    "id": 1,
    "list": [
        1,
        2,
        3
    ]
}

简单几步，告别烦恼

为了更轻松地解决这个问题，让我们借助 Spring Boot 的力量：

定义 ArrayList 属性： 在你的实体类中，定义一个 ArrayList 属性，并使用 @JsonProperty 注解指定 JSON 字段名称。
接收 JSON 请求体： 在控制器方法中，使用 @RequestBody 注解接收 JSON 请求体。
解析 JSON 数据： 使用 Jackson 库解析 JSON 数据，将其转换为 Java 对象。

附上示例代码，方便查阅

// 实体类
public class MyEntity {

    private Long id;

    @JsonProperty("list")
    private List<String> myList;

    // 省略 getter 和 setter 方法
}

// 控制器
@RestController
public class MyController {

    @PostMapping("/api/my-endpoint")
    public ResponseEntity<Void> myEndpoint(@RequestBody MyEntity myEntity) {
        // 处理 myEntity
        return ResponseEntity.ok().build();
    }
}