Spring Boot Web服务接口处理JSON入参时首字母大写问题的解决方案

项目场景：

• 在开发Spring Boot项目时，我们经常需要通过RESTful API接收来自客户端的JSON格式请求参数。然而，在某些情况下，您可能会遇到一个问题：当客户端发送的JSON字段名以大写字母开头时，Spring Boot默认的Jackson序列化/反序列化机制无法正确映射这些字段到Java对象中，导致接收不到参数。

• 本文将介绍如何通过添加一个注解来解决这个问题，并确保Spring Boot能够正确解析首字母大写的JSON字段。

问题描述

• 假设我们有一个简单的Java类 User，用于接收来自客户端的JSON请求：

public class User {
    private String name;
    private int age;

    // Getters and Setters
}

• 对应的Controller方法如下：

@RestController
@RequestMapping("/api")
public class UserController {

    @PostMapping("/user")
    public ResponseEntity<String> createUser(@RequestBody User user) {
        return ResponseEntity.ok("Received user: " + user.getName() + ", " + user.getAge());
    }
}

• 如果客户端发送的JSON请求如下：

{
  "Name": "Alice",
  "Age": 25
}

原因分析：

• 由于JSON字段名 Name 和 Age 首字母大写，而Java类中的字段名 name 和 age 是小写的，Spring Boot 默认使用 Jackson 进行反序列化时，会忽略这些字段，导致 user.getName() 和 user.getAge() 返回 null 或默认值。

解决方案一 使用 @JsonAlias 注解：

• @JsonAlias 是 Jackson 提供的一个注解，允许为Java字段指定多个别名。这样，即使JSON字段名与Java字段名不完全匹配，Jackson也能正确映射它们。

步骤：

1、修改 User 类：为每个字段添加 @JsonAlias 注解，指定可能的JSON字段名。

import com.fasterxml.jackson.annotation.JsonAlias;

public class User {
    
    @JsonAlias({"name", "Name"})
    private String name;

    @JsonAlias({"age", "Age"})
    private int age;

    // Getters and Setters
}

2、测试：现在，无论客户端发送的JSON字段名是 name、Name、age 还是 Age，Spring Boot 都能正确解析并映射到 User 对象中。

方案二：使用 @JsonProperty 注解

• 除了 @JsonAlias，您还可以使用 @JsonProperty 注解来显式指定JSON字段名。这对于特定字段的映射非常有用。

• 示例：

import com.fasterxml.jackson.annotation.JsonProperty;

public class User {
    
    @JsonProperty("Name")
    private String name;

    @JsonProperty("Age")
    private int age;

    // Getters and Setters
}

• 这种方式适用于单个字段的映射，但如果需要处理多个字段或多种命名方式，@JsonAlias 可能更为灵活。