Spring Cloud Feign Client无法接收多态DTO子类数据问题

问题背景 #

刚接触FeignClient配置，遇到Feign响应反序列化的问题。核心依赖如下：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

现有正常运行的服务A和服务B，服务A通过FeignClient调用服务B：

• 服务B的接口会根据details参数返回父类ResponseBDTO或子类ResponseBDetailedDTO，直接调用服务B时结果正常。
• 服务A通过Feign调用该接口时，无论details参数是true还是false，始终只能得到父类ResponseBDTO的实例，子类特有的字段丢失。

服务B核心代码 #

@Data
@NoArgsConstructor
@SuperBuilder
@AllArgsConstructor
public class ResponseBDTO{
    private String field1;
}

@Data
@NoArgsConstructor
@SuperBuilder
@AllArgsConstructor
public class ResponseBDetailedDTO extends ResponseBDTO{
    private String field2;
    private MetadataDTO metadataDTO;
}

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class MetadataDTO {
    private String field3;
}

@AllArgsConstructor
@RestController
public class ServiceBController {

    @GetMapping("api/serviceB/{details}")
    public ResponseBDTO getResponseB(@PathVariable boolean details){
        if(details){
            return ResponseBDetailedDTO.builder().build();
        }
        return ResponseBDTO.builder().build();
    }
}

服务A核心代码 #

@AllArgsConstructor
@RestController
public class ServiceAController {

    @GetMapping("/api")
    public ResponseBDTO getResponseB(@RequestParam boolean details){
        return serviceBClient.getResponseB(details);
    }
}

@FeignClient("serviceB")
public interface ServiceBClient {

    @GetMapping("api/serviceB/{details}")
    ResponseBDTO getResponseB(@PathVariable("details") boolean details);
}

解决建议 #

1. 给父类添加Jackson多态序列化注解 #

Feign默认使用Jackson进行反序列化，Jackson无法自动识别子类类型，需要在父类上配置多态注解指定子类映射：

@Data
@NoArgsConstructor
@SuperBuilder
@AllArgsConstructor
@JsonTypeInfo(
        use = JsonTypeInfo.Id.NAME,
        include = JsonTypeInfo.As.PROPERTY,
        property = "type" // 自定义类型标识字段
)
@JsonSubTypes({
        @JsonSubTypes.Type(value = ResponseBDTO.class, name = "base"),
        @JsonSubTypes.Type(value = ResponseBDetailedDTO.class, name = "detailed")
})
public class ResponseBDTO{
    private String field1;
    private String type; // 新增类型标识字段
}

服务B构建返回对象时，给type字段赋值：

@GetMapping("api/serviceB/{details}")
public ResponseBDTO getResponseB(@PathVariable boolean details){
    if(details){
        return ResponseBDetailedDTO.builder()
                .type("detailed")
                .field1("test1")
                .field2("test2")
                .metadataDTO(MetadataDTO.builder().field3("test3").build())
                .build();
    }
    return ResponseBDTO.builder()
            .type("base")
            .field1("test1")
            .build();
}

这样Jackson会根据type字段的值，自动将JSON反序列化为对应的父类或子类实例。

2. 手动转换返回对象 #

如果不想修改DTO结构，可以在服务A中拿到父类实例后，手动转换为子类：

@GetMapping("/api")
public Object getResponseB(@RequestParam boolean details){
    ResponseBDTO response = serviceBClient.getResponseB(details);
    if(details){
        ObjectMapper mapper = new ObjectMapper();
        return mapper.convertValue(response, ResponseBDetailedDTO.class);
    }
    return response;
}

这种方式无需修改服务B，但需要额外的类型转换逻辑，适合临时场景。

3. 拆分服务B接口 #

直接为不同返回类型单独定义接口，服务A根据参数调用对应Feign方法：

服务B新增接口

@GetMapping("api/serviceB/base")
public ResponseBDTO getBaseResponse(){
    return ResponseBDTO.builder().field1("test1").build();
}

@GetMapping("api/serviceB/detailed")
public ResponseBDetailedDTO getDetailedResponse(){
    return ResponseBDetailedDTO.builder()
            .field1("test1")
            .field2("test2")
            .metadataDTO(MetadataDTO.builder().field3("test3").build())
            .build();
}

服务A修改Feign接口和Controller

@FeignClient("serviceB")
public interface ServiceBClient {
    @GetMapping("api/serviceB/base")
    ResponseBDTO getBaseResponse();

    @GetMapping("api/serviceB/detailed")
    ResponseBDetailedDTO getDetailedResponse();
}

@AllArgsConstructor
@RestController
public class ServiceAController {

    @GetMapping("/api")
    public Object getResponseB(@RequestParam boolean details){
        return details ? serviceBClient.getDetailedResponse() : serviceBClient.getBaseResponse();
    }
}

这种方式逻辑最清晰，避免了多态反序列化的问题，适合接口逻辑简单的场景。

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