掘金后端 ( ) • 2024-04-25 11:28

背景

对接一个关联系统，使用SpringBoot中的RestTemplate调用关联方，对方返回的结果是josn格式，如下：

{
  "Code":"0",
  "Result":{
    "Count":297663
  }
}

即他们的json是用大写字母开头的。如果直接使用restTemplate.exchange(url, HttpMethod.POST, requestEntity, RsponseData.class).getBody();，得到的结果(RsponseData)中的字段都是空的，RsponseData中的字段如下：

public class RsponseData<T> {
    private String code;
    private T result;
}

问题分析

在java中，我们定义字段的时候，规范化的做法一般是小写字母开头，驼峰命令。但是对方给出这种json格式，不能说是不规范的，只要能统一就行（每个接口的响应格式规范都不一样，就是坑了）。如果我们想接收这种大写字母开头的json字符串，把RsponseData中的字段改为大写开头，结果还是会接收不到。

解决方案

有多种方式，根据具体情况采取：

字符串接收，再转换

在使用restTemplate.exchange的时候，我们是直接给了RsponseData.class，如果使用String.class，那么就可以得到这个json字符串。拿到json字符串之后，再手动将该字符串转为RsponseData对象。将json字符串转为对象的方法有很多，这里就不赘述了。此种方式，兼容性好，但封装性不强，不够优雅。但隔离性好，不影响其他接口。

使用@JsonProperty

之所以无法转换，无非就是jackson在处理映射的时候，是大小写敏感的，所以，通过@JsonProperty，指定他们映射关系即可：

public class NbBsicResponse<T> {
    @JsonProperty("Code")
    private String code;
    @JsonProperty("Result")
    private T result;
}

如果有很多个字段，那么这个注解就要写很多了，同样，隔离性也很好，不影响其他接口。

修改RestTemplate的配置

在配置resteTemplate的时候，修改它处理json的配置，具体如下：

    @Bean("xxxcRestTemplate")
    public RestTemplate buildRestTemplate() {
        // 创建一个ObjectMapper实例
        ObjectMapper objectMapper = new ObjectMapper();
        // 配置ObjectMapper忽略JSON键名的大写字母开头
        objectMapper.setPropertyNamingStrategy(PropertyNamingStrategies.UPPER_CAMEL_CASE);
        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

        //不要试图自己创建一个converter，因为自动配置中的，会有其他的配置，自己弄，配置不全，还不如遍历已有的，然后修改自己想要修改的
        // 创建一个使用配置好的ObjectMapper的HttpMessageConverter
//        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
//        converter.setObjectMapper(objectMapper);
//        converter.setSupportedMediaTypes(List.of(MediaType.APPLICATION_JSON, MediaType.APPLICATION_OCTET_STREAM, MediaType.TEXT_HTML));

        // 将HttpMessageConverter加入到RestTemplate的消息转换器列表中
        RestTemplate restTemplate = new RestTemplate();
        for (HttpMessageConverter<?> messageConverter : restTemplate.getMessageConverters()) {
            if (messageConverter instanceof MappingJackson2HttpMessageConverter) {
                ((MappingJackson2HttpMessageConverter) messageConverter).setObjectMapper(objectMapper);
            }
        }
        return restTemplate;
    }

这种方式，封装性就很好了。但通常来说，每个对接的系统，都应该单独配置一个RestTemplate，设置一些公共参数以及配置；但如果有些同一个系统，提供的接口规范不一致，那么就得对单独的接口进行配置RestTemplate。如果遇到更奇葩的：同一个接口中，不同节点的规范都不一样，那么就得配合@JsonProperty来处理了。