API返回Result结构不一致导致Feign反序列化异常的解决方案

当API返回的Result字段时而为对象、时而为字符串时，Feign默认的Jackson反序列化会因类型不匹配报错。以下是几种无需修改API的解决方案：

方案一：自定义Jackson反序列化器（推荐） #

针对Result对应的实体类编写自定义反序列化逻辑，兼容两种类型的输入：

1. 假设你的DTO结构如下：

public class ResponseDto {
    private ResultData result;
    private Integer status;
    // getter、setter、构造方法
}

public class ResultData {
    private String name;
    // getter、setter、构造方法
}

2. 实现自定义反序列化器：

public class ResultDataDeserializer extends StdDeserializer<ResultData> {

    public ResultDataDeserializer() {
        super(ResultData.class);
    }

    @Override
    public ResultData deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        JsonNode node = p.getCodec().readTree(p);
        // 处理字符串类型的Result，返回空实例或设置默认值
        if (node.isTextual()) {
            ResultData emptyData = new ResultData();
            emptyData.setName(node.asText()); // 保留提示文本，或直接返回空实例
            return emptyData;
        }
        // 正常反序列化对象类型的Result
        return p.getCodec().treeToValue(node, ResultData.class);
    }
}

3. 在ResponseDto的result字段上添加反序列化注解：

public class ResponseDto {
    @JsonDeserialize(using = ResultDataDeserializer.class)
    private ResultData result;
    private Integer status;
    // 其他代码
}

方案二：将Result字段定义为Object类型，业务代码中判断处理 #

这种方式无需额外编写序列化器，但需要在业务逻辑中手动处理类型转换：

public class ResponseDto {
    private Object result;
    private Integer status;
    // getter、setter

    // 封装类型转换逻辑
    public ResultData getResultAsData() {
        if (result instanceof ResultData) {
            return (ResultData) result;
        } else if (result instanceof String) {
            ResultData emptyData = new ResultData();
            emptyData.setName((String) result);
            return emptyData;
        }
        return null;
    }
}

方案三：自定义Feign Decoder，修改响应JSON结构 #

在Feign解码阶段，将字符串类型的Result替换为对象格式，再进行反序列化：

1. 实现自定义Decoder：

public class CustomFeignDecoder extends JacksonDecoder {

    public CustomFeignDecoder(ObjectMapper mapper) {
        super(mapper);
    }

    @Override
    public Object decode(Response response, Type type) throws IOException, FeignException {
        String responseBody = Util.toString(response.body().asReader(Util.UTF_8));
        // 匹配并替换字符串类型的Result为对象格式
        responseBody = responseBody.replace("\"Result\":\"Not found\"", "\"Result\":{}");
        // 注意：如果API返回的提示文本是"Not found."（带点），需对应调整匹配规则
        return super.decode(response.toBuilder().body(responseBody).build(), type);
    }
}

2. 配置Feign使用自定义Decoder：

@Configuration
public class FeignConfig {
    @Bean
    public Decoder feignDecoder() {
        ObjectMapper mapper = new ObjectMapper();
        // 可添加Jackson额外配置，如忽略未知字段
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        return new CustomFeignDecoder(mapper);
    }
}

内容的提问来源于stack exchange，提问作者Alvin