解決Feign切換client到okhttp無法生效的坑(出現(xiàn)原因說明)

更新時(shí)間：2021年02月25日 11:05:40 作者：沐風(fēng)之境

這篇文章主要介紹了解決Feign切換client到okhttp無法生效的坑(出現(xiàn)原因說明)，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧

提示：如果只看如何解決問題，請看文章的末尾如何解決這個(gè)問題

1. 場景描述

最近項(xiàng)目中使用了feign當(dāng)做http請求工具來使用、相對于httpclient、resttemplate來說，fegin用起來方便很多。

然后項(xiàng)目有httptrace的需求，需要輸出請求日志。

所以就開啟了feign自己的日志，發(fā)現(xiàn)它自帶的日志是debug級別才能打印。而且是逐行打印的，看日志非常的不方便。所以需要輸出json格式的日志最好。

2.解決步驟

2.1 引入feign依賴

<dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependencyManagement>
 <dependencies>
 <dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-dependencies</artifactId>
 <version>${自行選擇適合項(xiàng)目的版本}</version>
 <type>pom</type>
 <scope>import</scope>
 </dependency>
 </dependencies>
</dependencyManagement>

這里使用了spring-cloud-openfeing來避免自己手工實(shí)現(xiàn)feign的注入，用法上和feign一樣

2.2 配置feign

在入口類上添加 @EnableFeignClients 注解

@SpringBootApplication
@EnableFeignClients
public class Application {
 public static void main(String[] args) {
 SpringApplication.run(Application.class, args);
 }
}

使用feing自己的Contract，方便使用feign自己的注解來聲明http接口。這里使用了一個(gè)配置類

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

2.3 聲明接口

只需要聲明一個(gè)帶有@FeignClient注解的接口，就聲明好了一個(gè)Feign的http請求接口

@FeignClient(name = "accessPlatform", url = "${url.access-platform}")
public interface AccessPlatformFeignClient {
 @RequestLine("GET /access-platform/resource")
 List<AccessResource> queryResourceList(@QueryMap Map<String, Object> query);
}

3.切換Feign的客戶端為OkHttp

由于feign自帶的http客戶端實(shí)現(xiàn)是HttpURLConnection，沒有連接池功能，可配置能力也比較差，因此我們使用okhttp作為底層的http客戶端的具體實(shí)現(xiàn)。

3.1 引入okhttp的依賴

 <dependency>
 <groupId>io.github.openfeign</groupId>
 <artifactId>feign-okhttp</artifactId>
 <version>${feign-okhttp.version}</version>
</dependency>

3.2 修改之前的FeignConfig配置類

問題就出在這里、不過先不急，我們繼續(xù)

@Configuration
@ConditionalOnClass(Feign.class)
@AutoConfigureBefore(FeignAutoConfiguration.class)
public class FeignConfig {
 // 注入feignContract
 @Bean
 public Contract feignContract() {
 return new feign.Contract.Default();
 }
 
 // 注入自定義的okHttpClient
 @Bean
 public okhttp3.OkHttpClient okHttpClient(){
 return new okhttp3.OkHttpClient.Builder()
  .readTimeout(60, TimeUnit.SECONDS)
  .connectTimeout(60, TimeUnit.SECONDS) 
  .writeTimeout(120, TimeUnit.SECONDS) 
  .connectionPool(new ConnectionPool())
  .build();
 }
}

開啟okhttp作為feign的客戶端

# application.yml
feign:
 okhttp:
 enabled: true

一切完美、網(wǎng)上的許多博客也都是這么寫的。然后它們告訴你已經(jīng)配置完了？呵呵，你們到底自己試過沒有？？

3.3 試著請求一下

當(dāng)然這里出問題了，發(fā)出的請求并非來自okhttp，還是默認(rèn)的JDK的HttpURLConnection，問題出在哪里呢？接著看

4.找出問題所在

我懷疑是feing在注入配置的時(shí)候，根本就沒有運(yùn)行關(guān)于okhttp的配置

4.1 查看服務(wù)啟動時(shí)feign配置過程

1.將服務(wù)根日志級別調(diào)整為debug級別

logging:
 level:
 root: debug

2.啟動服務(wù)、查看控制臺輸出

看到?jīng)]，okhttp的配置不符合配置運(yùn)行條件。

3.查詢 FeignAutoConfiguration 這個(gè)配置類的細(xì)節(jié)

@Configuration
@ConditionalOnClass({Feign.class})
@EnableConfigurationProperties({FeignClientProperties.class, FeignHttpClientProperties.class})
public class FeignAutoConfiguration {
 // .....其他的配置
 @Configuration
 @ConditionalOnClass({OkHttpClient.class})
 @ConditionalOnMissingClass({"com.netflix.loadbalancer.ILoadBalancer"})
 @ConditionalOnMissingBean({okhttp3.OkHttpClient.class})
 @ConditionalOnProperty({"feign.okhttp.enabled"})
 protected static class OkHttpFeignConfiguration {
 // ...okhttp的配置
 }
 
 // .....其他的配置
}

就是這個(gè)自動配置類搞的鬼、當(dāng)我看到 @ConditionalOnMissingBean({okhttp3.OkHttpClient.class}) 這個(gè)注解時(shí)，我就明白了。

翻成白話就是，只有當(dāng)容器中沒有OkHttpClient的實(shí)例時(shí)。他才會運(yùn)行。

如果在 FeignAutoConfiguration之前注入了我們自己定義的OkHttpClient實(shí)例，那不好意思，我不干了？無不注入。

5.解決問題

既然自動配置不干，那我們自己動手干?？截?FeignAutoConfiguration 配置類中的配置過程，粘貼在FeignConfig配置類中手動注入feign的client。Ok！完美解決。

@Configuration
@ConditionalOnClass(Feign.class)
@AutoConfigureAfter(FeignAutoConfiguration.class)
public class FeignConfig {
// private okhttp3.OkHttpClient okHttpClient;
 @Bean
 public Contract feignContract() {
 return new feign.Contract.Default();
 }
 @Bean
 @ConditionalOnMissingBean({Client.class})
 public Client feignClient(okhttp3.OkHttpClient client) {
 return new feign.okhttp.OkHttpClient(client);
 }
 @Bean
 @ConditionalOnMissingBean({ConnectionPool.class})
 public ConnectionPool httpClientConnectionPool(FeignHttpClientProperties httpClientProperties, OkHttpClientConnectionPoolFactory connectionPoolFactory) {
 Integer maxTotalConnections = httpClientProperties.getMaxConnections();
 Long timeToLive = httpClientProperties.getTimeToLive();
 TimeUnit ttlUnit = httpClientProperties.getTimeToLiveUnit();
 return connectionPoolFactory.create(maxTotalConnections, timeToLive, ttlUnit);
 }
 @Bean
 public OkHttpClient client(OkHttpClientFactory httpClientFactory, ConnectionPool connectionPool, FeignHttpClientProperties httpClientProperties) {
 Boolean followRedirects = httpClientProperties.isFollowRedirects();
 Integer connectTimeout = httpClientProperties.getConnectionTimeout();
 Boolean disableSslValidation = httpClientProperties.isDisableSslValidation();
 return httpClientFactory.createBuilder(disableSslValidation)
  .connectTimeout((long)connectTimeout, TimeUnit.MILLISECONDS)
  .followRedirects(followRedirects)
  .connectionPool(connectionPool)
  .addInterceptor(new OkHttpLogInterceptor()) // 自定義請求日志攔截器
  .build();
 }
}