通过 RestTemplate 调用第三方接口时参数首字母大写问题的解决方案

观点阐述

在使用 RestTemplate 调用第三方接口时，如果传递的参数中包含首字母大写的字段名，可能会遇到参数无法正确传递的问题。这通常是由于 Jackson 序列化过程中将字段名的首字母自动转换为小写所致。本文将详细分析这一问题的原因，并提供使用 @JsonProperty 注解解决该问题的方案。

问题分析

在 Java 中，默认情况下，使用 Jackson 序列化对象时会将字段名的首字母转换为小写。这是因为 JavaBean 规范要求 getter 和 setter 方法的命名方式。如果你的字段名是首字母大写，Jackson 会自动将其转换为小写。以下是问题的具体表现：

public class MyRequest {
    private String FieldName;

    public String getFieldName() {
        return FieldName;
    }

    public void setFieldName(String fieldName) {
        FieldName = fieldName;
    }
}

当你使用 RestTemplate 调用第三方接口时：

RestTemplate restTemplate = new RestTemplate();
MyRequest request = new MyRequest();
request.setFieldName("value");
ResponseEntity<String> response = restTemplate.postForEntity("http://example.com/api", request, String.class);

在这个例子中，发送的 JSON 可能是：

{
    "fieldName": "value"
}

而第三方接口期望接收到的是：

{
    "FieldName": "value"
}

源码分析
Jackson 在序列化时会使用 PropertyNamingStrategy，默认情况下，它会将属性名的首字母小写。以下是 PropertyNamingStrategy 的相关实现：

public class PropertyNamingStrategy {
    public static class LowerCaseStrategy extends PropertyNamingStrategyBase {
        @Override
        public String translate(String propertyName) {
            if (propertyName == null || propertyName.length() == 0) {
                return propertyName;
            }
            char c = propertyName.charAt(0);
            char lower = Character.toLowerCase(c);
            if (c == lower) {
                return propertyName;
            }
            StringBuilder sb = new StringBuilder(propertyName);
            sb.setCharAt(0, lower);
            return sb.toString();
        }
    }
}

Jackson 在序列化时会使用 PropertyNamingStrategy，默认情况下，它会将属性名的首字母小写。为了解决这一问题，可以使用 @JsonProperty 注解来显式指定字段在 JSON 中的名称。
以下是如何使用 @JsonProperty 注解来解决这个问题的示例代码：

import com.fasterxml.jackson.annotation.JsonProperty;

public class MyRequest {
    @JsonProperty("FieldName")
    private String fieldName;

    public String getFieldName() {
        return fieldName;
    }

    public void setFieldName(String fieldName) {
        this.fieldName = fieldName;
    }
}

在你的服务代码中使用这个带有 @JsonProperty 注解的 MyRequest 类：

import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;

public class MyService {

    private final RestTemplate restTemplate;

    public MyService(RestTemplate restTemplate) {
        this.restTemplate = restTemplate;
    }

    public void callThirdPartyApi() {
        MyRequest request = new MyRequest();
        request.setFieldName("value");
        ResponseEntity<String> response = restTemplate.postForEntity("http://example.com/api", request, String.class);
        System.out.println(response.getBody());
    }
}

这样，在序列化 MyRequest 对象时，Jackson 会使用 @JsonProperty 注解指定的名称，将 JSON 字段名保持为 FieldName。

总结
在使用 RestTemplate 调用第三方接口时，遇到字段名首字母大写的问题是由于 Jackson 的默认序列化策略导致的。通过使用 @JsonProperty 注解，可以显式指定字段在 JSON 中的名称，从而避免字段名在序列化过程中被修改。这种方法简单有效，适用于任何需要自定义 JSON 字段名的场景。