Spring Boot OpenFeign:java。lang.IllegalStateException:方法的主体参数太多

Question

下面的示例演示了使用OpenFeign时遇到的问题。当响应对象的字段太多时，问题就会变得明显，这会引发一个错误：方法的参数太多。示例1工作正常，但示例2失败。

示例1使用HTTP. POST与示例2中使用的响应对象相同，后者使用HTTP. GET。

为什么在HTTP. GET方法中OpenFaigns限制字段，并抛出异常？我不能使用HTTP. POST获取/获取/读取资源。糟糕的REST API设计标准。

使用相同的响应对象，对于两个HTTP. POST（工作），HTTP. GET失败

public interface ClientFeignV2 {

//Example 1 
@Headers("Content-Type: application/json") @RequestLine("POST api/v2/clients") ClientResponse findAllClientsByUid1(@RequestBody ClientRequest request);

//Example 2
@Headers("Content-Type: application/json")
@RequestLine("GET api/v2/clients/{uid}")
ClientResponse findAllClientsByUid(@PathVariable(value = "uid") String uid,
                                         @RequestParam(value = "limit", required = false) Integer limit,
                                         @RequestParam(value = "offset", required = false) Integer offset);
}

StackTrace：

Caused by: java.lang.IllegalStateException: Method has too many Body parameters: public abstract com.services.requestresponse.ClientResponse com.microservice.gateway.feign.v2.ClientFeignV2.findAllClientsByUid(java.lang.String,java.lang.Integer,java.lang.Integer)
at feign.Util.checkState(Util.java:128) ~[feign-core-9.4.0.jar:na]
at feign.Contract$BaseContract.parseAndValidateMetadata(Contract.java:114) ~[feign-core-9.4.0.jar:na]
at feign.Contract$BaseContract.parseAndValidatateMetadata(Contract.java:64) ~[feign-core-9.4.0.jar:na]
at feign.ReflectiveFeign$ParseHandlersByName.apply(ReflectiveFeign.java:146) ~[feign-core-9.4.0.jar:na]
at feign.ReflectiveFeign.newInstance(ReflectiveFeign.java:53) ~[feign-core-9.4.0.jar:na]
at feign.Feign$Builder.target(Feign.java:209) ~[feign-core-9.4.0.jar:na]
at feign.Feign$Builder.target(Feign.java:205) ~[feign-core-9.4.0.jar:na]
at com.microservice.gateway.service.v2.impl.ClientServiceV2Impl.<init>(ClientServiceV2Impl.java:27) ~[classes/:na]
at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method) ~[na:1.8.0_222]
at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62) ~[na:1.8.0_222]
at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45) ~[na:1.8.0_222]
at java.lang.reflect.Constructor.newInstance(Constructor.java:423) ~[na:1.8.0_222]
at org.springframework.beans.BeanUtils.instantiateClass(BeanUtils.java:203) ~[spring-beans-5.2.3.RELEASE.jar:5.2.3.RELEASE]
... 40 common frames omitted

我看了OpenFaigns留档，它支持上面的实现。如果我找不到这个问题的解决方案，我将不得不求助于一个解决方案，并使用HTTP. POST和@刚体，根据REST-API设计标准，这不是一个理想的解决方案。

Answer 1

根据标签，您使用的是Spring Boot，显然是Spring Cloud OpenFeign。问题是你混合了两份不同的合同。

像@ask estLine和@Headers这样的注释来自核心模拟库。您可以将其用作声明性HTTP客户端，而不仅仅是在Spring应用程序中（在这种情况下，它不需要使用Spring注释）。

因此，正确的“示例2”可以是这样的：

@Headers("Content-Type: application/json")
@RequestLine("GET api/v2/clients/{uid}?limit={limit}&offset={offset}")
ClientResponse findAllClientsByUid(@Param("uid") String uid,
                                   @Param("limit") Integer limit,
                                   @Param("offset") Integer offset);

另一方面，像@RequestParam和@PathVariable这样的东西来自SpringWeb。如果您有Spring Cloud OpenFeign库（顺便说一句，核心feign是它的一个组件），就可以使用它们。这个库提供了对SpringMvcContract的支持，在它的例子中，允许您使用常用的SpringWeb注释来定义请求映射，而不是使用特定于外部的注释。

在SpringMvcContract的情况下，“示例2”可能类似于：

@GetMapping(value = "api/v2/clients/{uid}", consumes = MediaType.APPLICATION_JSON_VALUE)
ClientResponse findAllClientsByUid(@PathVariable(value = "uid") String uid,
                @RequestParam(value = "limit", required = false) Integer limit,
                @RequestParam(value = "offset", required = false) Integer offset);

值得一提的是，在Spring Cloud OpenFeign中，默认情况下使用第二种方法。要将其更改回纯假的合同，请定义自定义contractbean（源代码）：

@Bean
public Contract feignContract() {
    return new feign.Contract.Default();
}