使用feign遇到的问题解决汇总

一些参考网址：
https://github.com/OpenFeign/feign
https://www.cnblogs.com/LQBlog/p/13722529.htmls
https://zhuanlan.zhihu.com/p/388036104
https://blog.csdn.net/goldenfish1919/article/details/108592738

了解feign使用

maven中添加依赖

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

<dependency>
    <groupId>javax.xml.ws</groupId>
    <artifactId>jaxws-api</artifactId>
    <version>2.3.1</version>
</dependency>  

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-jaxb</artifactId>
    <version>9.7.0</version>
</dependency>

创建接口，在接口上加上@Produces和@Consumes，代表请求和接收都是JSON格式，加上@FeignClient写明微服务名称

@Produces(APPLICATION_JSON)
@Consumes(APPLICATION_JSON)
@FeignClient("TestApiClient")
public interface TestApiClient {

    @GET
    UserInfoResponseDto getUserInfo(@HeaderParam("Authorization") String auth,
                                    @QueryParam("user_id") String userId);
}

在包装类中自定义代理类，来访问这些接口，使用builder来自定义feign的代理类。包装类加FeignClientsConfiguration。

contract：改变协议，传入new JAXRSContract()，代表接口使用JAXRS的注解，也就是包javax.ws.rs的注解
encoder和decoder：是编码器和解码器，传入JacksonEncoder和JacksonDecoder，用于JSON格式的api
logger和logLevel：日志相关，使用log4j
target：feign可以提供多种API接口，这些接口都被定义为Target (默认的实现是 HardCodedTarget), 它允许在执行请求前动态发现和装饰该请求。

@Component
@Import(FeignClientsConfiguration.class)
public class TestApiClientWrapper {
    private TestApiClient testApiClient;

    @PostConstruct
    public void init() {
        testApiClient = Feign.builder()
                .contract(new JAXRSContract())
                .encoder(new JacksonEncoder())
                .decoder(new JacksonDecoder())
                .logger(new Slf4jLogger(TestApiClient.class))
                .logLevel(Logger.Level.FULL)
                .target(TestApiClient.class, "http://XXXX.com.cn/api/test");
    }
}

此外还有很多其他的可以自定义，图片来自git：

spring-cloud-starter-openfeign默认配置：

Decoder: ResponseEntityDecoder （解码器）
Encoder: SpringEncoder （编码器）
Logger: Slf4jLogger （日志）
Contract: SpringMvcContract （协议）
Feign.Builder: HystrixFeign.Builder （断路器）
Client feignClient: 如果有Ribbon那么就是LoadBalancerFeignClient，否则如果有FeignBlockingLoadBalancerClient那么就是用这个，否则使用默认的feign client。

spring-cloud-starter-openfeign默认没有配置:

Logger.Level （日志级别）
Retryer （重试）
ErrorDecoder （错误解析器）
Request.Options （请求选项，比如设置建立连接http超时时间，请求处理超时时间）
Collection （拦截器器）
SetterFactory
QueryMapEncoder （构造键值对参数，使用@QueryMap，会自动映射为url?name={name}&number={number},如希望使用getter/setter方法构建查询字符串，使用自定义QueryMapEncoder）

遇到的feign相关问题的解决

解决有些post请求必须传空body才不报411长度错误

项目中遇到调对方接口，请求是post请求，但是又没有body，如果不传body，接口会报错411，所以为了不报错，只能传一个空的body{}
以getUserInfo接口为例，现在改为post请求

@Produces(APPLICATION_JSON)
@Consumes(APPLICATION_JSON)
@FeignClient("TestApiClient")
public interface TestApiClient {

    @POST
    UserInfoResponseDto getUserInfo(@HeaderParam("Authorization") String auth,
                                    @QueryParam("user_id") String userId);
}

第一次想解决问题的方法是增加一个Object对象，new一个Object对象放进去，但是会报序列化错误。改为传空字符串可以解决。

    //这样在wrapper中new一个Object对象传入会报错
    @POST
    UserInfoResponseDto getUserInfo(@HeaderParam("Authorization") String auth,
                                    @RequestBody Object empty,
                                    @QueryParam("user_id") String userId);

    //在wrapper中传""
    @POST
    UserInfoResponseDto getUserInfo(@HeaderParam("Authorization") String auth,
                                    @RequestBody String empty,
                                    @QueryParam("user_id") String userId);

还有一种优雅解决方式，就是在build feign时，传入拦截器

testApiClient = Feign.builder()
            .contract(new JAXRSContract())
            .logger(new Slf4jLogger(TestApiClient.class))
            .logLevel(Logger.Level.FULL)
            .requestInterceptor(s -> {
                if (StringUtils.isBlank(s.body().toString())) {
                    s.body("");
                }
            })
            .target(TestApiClient.class, "http://XXXX.com.cn/api");

解决feign中get请求末尾自动加斜杠问题

使用包javax.ws.rs的注解，feign远程调用时，单独使用@GET接口，不使用@Path接口，在请求时会在url末尾自动加上斜杠，很可能导致路径错误。

调用feign接口时，先新建接口，再建一个对应的wrapper类，在调用feign接口的地方注入wrapper类，调用wrapper类对应的方法

接口，get请求，未加path，具体的url在wrapper类中构造client时传入了

@Produces(APPLICATION_JSON)
@Consumes(APPLICATION_JSON)
@FeignClient("TestApiClient")
public interface TestApiClient {

    @GET
    UserInfoResponseDto getUserInfo(@HeaderParam("Authorization") String auth,
                                    @QueryParam("user_id") String userId);
}

wrapper类，传入url，包装client中接口

@Component
@Import(FeignClientsConfiguration.class)
public class TestApiClientWrapper {
    private TestApiClient testApiClient;

    @PostConstruct
    public void init() {
        testApiClient = Feign.builder()
                .contract(new JAXRSContract())
                .logger(new Slf4jLogger(TestApiClient.class))
                .logLevel(Logger.Level.FULL)
                .target(TestApiClient.class, "http://XXXX.com.cn/api/test");
    }

    public UserInfoResponseDto getUserInfo(String userId) {
        if (StringUtils.isBlank(userId)) {
            throw new IllegalArgumentException("userId empty!");
        }
        return testApiClient.getUserInfo(
                "计算好的认证信息",
                userId);
    }
}

这样请求会导致发送的get的http请求是http://XXXX.com.cn/api/test/?user_id=123，而不是预期的http://XXXX.com.cn/api/test?user_id=123，相差最后的斜杠，对方服务器很可能就报错，加斜杠和不加斜杠是两个路径。
解决这个问题需要结合使用@Path注解：在接口的请求中使用@Path，在wrapper中传入的url不是完整的，这样调用时会自动组合，并且不带斜杠，比如改成如下：

//接口中加@Path
@GET
@Path("/test")
UserInfoResponseDto getUserInfo(@HeaderParam("Authorization") String auth,
                                @QueryParam("user_id") String userId);


//包装类中url去掉与注解中重复的部分
@PostConstruct
public void init() {
    testApiClient = Feign.builder()
            .contract(new JAXRSContract())
            .logger(new Slf4jLogger(TestApiClient.class))
            .logLevel(Logger.Level.FULL)
            .target(TestApiClient.class, "http://XXXX.com.cn/api");
}

即可解决末尾加斜杠问题。

或者同上一个问题，使用拦截器去除末尾的斜杠。

解决feign使用时报http method错误

不同包的注解混用会报http method错误 Method not annotated with HTTP method type (ex. GET, POST)，找出混用的注解，不混用。
构造Feign时已经传了contract，此时协议已经覆盖成JAXRSContract的了。

另再记录一点，使用javax.ws.rs中的注解，增加header使用@HeaderParam

feign的post请求只能有一个body

feign的post方法中，只能使用一个@RequestBody或者不带该注解，不能使用多个@RequestBody，否则会报错nested exception is java.lang.IllegalStateException: Method has too many Body parameters。