Feign的日志配置
有時(shí)候我們遇到Bug，比如接口調(diào)用失敗、參數(shù)沒(méi)收到等問(wèn)題，或者想看看調(diào)用性能，就需要配置Feign的日志了，以此讓Feign把請(qǐng)求信息輸出來(lái)。
全局配置
定義一個(gè)配置類，指定日志級(jí)別：
package com.morris.user.config;
import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
// 注意： 此處配置@Configuration注解就會(huì)全局生效，如果想指定對(duì)應(yīng)微服務(wù)生效，就不能配置@Configuration
@Configuration
public class FeignConfig {
@Bean
public Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
}
通過(guò)源碼可以看到日志等級(jí)有4種，分別是：
- NONE：不記錄任何日志（默認(rèn)值），性能最佳，適用于生產(chǎn)
- BASIC：僅記錄請(qǐng)求方法、URL、響應(yīng)狀態(tài)代碼以及執(zhí)行時(shí)間，適用于生產(chǎn)環(huán)境追蹤問(wèn)題
- HEADERS：在BASIC級(jí)別的基礎(chǔ)上，記錄請(qǐng)求和響應(yīng)的header
- FULL：記錄請(qǐng)求和響應(yīng)的header、body和元數(shù)據(jù)，比較適用于開(kāi)發(fā)及測(cè)試環(huán)境定位問(wèn)題
上面只是指定日志的內(nèi)容，還需要在配置文件中配置Client的日志級(jí)別才能正常輸出日志，格式是"logging.level.feign接口包路徑=debug"：
logging:
level:
com.morris.user.client.OrderClient: debug
會(huì)看到如下的打印日志：
2023-08-14 13:53:42.948 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] ---> GET http://order-service/order/findOrderByUserId?userId=1 HTTP/1.1
2023-08-14 13:53:42.948 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] ---> END HTTP (0-byte body)
2023-08-14 13:53:43.169 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] <--- HTTP/1.1 200 (213ms)
2023-08-14 13:53:43.170 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] connection: keep-alive
2023-08-14 13:53:43.170 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] content-type: application/json
2023-08-14 13:53:43.170 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] date: Mon, 14 Aug 2023 05:53:43 GMT
2023-08-14 13:53:43.170 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] keep-alive: timeout=60
2023-08-14 13:53:43.170 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] transfer-encoding: chunked
2023-08-14 13:53:43.171 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId]
2023-08-14 13:53:43.171 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] [{"id":1,"userId":1,"goodName":"Iphone 13","price":9999}]
2023-08-14 13:53:43.171 DEBUG 22948 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#findOrderByUserId] <--- END HTTP (57-byte body)
局部配置
局部配置可以讓指定調(diào)用的微服務(wù)生效，在@FeignClient注解中指定使用的配置類
package com.morris.user.client;
import com.morris.user.config.FeignConfig;
import com.morris.user.entity.Order;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import java.util.List;
@FeignClient(value = "order-service", path = "/order", configuration = FeignConfig.class)
public interface OrderClient {
@GetMapping("findOrderByUserId")
List<Order> findOrderByUserId(@RequestParam("userId") Long userId);
}
注意FeignConfig類不要加@Configuration注解，否則就會(huì)被Spring掃描到，變成了一個(gè)全局的配置。
同樣需要在配置文件中指定日志的級(jí)別才會(huì)打?。?/p>
logging:
level:
com.morris.user.client.OrderClient: debug
局部配置可以在yml中配置，對(duì)應(yīng)屬性配置類： org.springframework.cloud.openfeign.FeignClientProperties.FeignClientConfiguration
feign:
client:
config:
order-service: #對(duì)應(yīng)微服務(wù)
loggerLevel: FULL
攔截器
每次Feign發(fā)起http調(diào)用之前，會(huì)去執(zhí)行攔截器中的邏輯，攔截器可以修改請(qǐng)求的參數(shù)或者頭部信息。
例如我們可以在攔截器中對(duì)請(qǐng)求頭增加認(rèn)證信息，增加鏈路追蹤信息。
下面通過(guò)攔截器在請(qǐng)求頭中增加一個(gè)參數(shù)實(shí)現(xiàn)分布式系統(tǒng)中請(qǐng)求的鏈路追蹤，自定義攔截器需要實(shí)現(xiàn)RequestInterceptor接口：
package com.morris.user.config;
import feign.RequestInterceptor;
import feign.RequestTemplate;
import java.util.UUID;
public class FeignTraceRequestInterceptor implements RequestInterceptor {
@Override
public void apply(RequestTemplate template) {
// 業(yè)務(wù)邏輯
String traceId = UUID.randomUUID().toString();
template.header("TID", traceId);
}
}
全局配置
與日志的全局配置一樣，放入到一個(gè)配置文件中。
package com.morris.user.config;
import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
// 注意： 此處配置@Configuration注解就會(huì)全局生效，如果想指定對(duì)應(yīng)微服務(wù)生效，就不能配置@Configuration
@Configuration
public class FeignConfig {
@Bean
public FeignTraceRequestInterceptor feignTraceRequestInterceptor() {
return new FeignTraceRequestInterceptor();
}
}
局部配置
在@FeignClient注解中指定配置文件，注意FeignConfig類不要加@Configuration注解，否則就會(huì)被Spring掃描到，變成了一個(gè)全局的配置。
@FeignClient(value = "order-service", path = "/order", configuration = FeignConfig.class)
也可以在yml中配置：
feign:
client:
config:
order-service: #對(duì)應(yīng)微服務(wù)
requestInterceptors[0]: #配置攔截器
com.morris.user.config.FeignTraceRequestInterceptor
order-service端可以通過(guò)@RequestHeader獲取請(qǐng)求參數(shù)，建議在Filter，Interceptor中統(tǒng)一處理。
超時(shí)時(shí)間配置
通過(guò)Options可以配置連接超時(shí)時(shí)間和讀取超時(shí)時(shí)間，Options的第一個(gè)參數(shù)是連接的超時(shí)時(shí)間（ms），默認(rèn)值是 2s；第二個(gè)是請(qǐng)求處理的超時(shí)時(shí)間（ms），默認(rèn)值是5s。
全局配置
與日志、攔截器的全局配置一樣，放入到一個(gè)配置文件中。
package com.morris.user.config;
import feign.Logger;
import feign.Request;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
// 注意： 此處配置@Configuration注解就會(huì)全局生效，如果想指定對(duì)應(yīng)微服務(wù)生效，就不能配置@Configuration
@Configuration
public class FeignConfig {
@Bean
public Request.Options options() {
return new Request.Options(5000, 10000);
}
}
超時(shí)了會(huì)拋出SocketTimeoutException異常：
2023-08-15 09:45:53.595 ERROR 11104 --- [nio-8030-exec-1] o.a.c.c.C.[.[.[/].[dispatcherServlet] : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is feign.RetryableException: Read timed out executing GET http://order-service/order/findOrderByUserId] with root cause
java.net.SocketTimeoutException: Read timed out
at java.net.SocketInputStream.socketRead0(Native Method) ~[na:1.8.0_281]
at java.net.SocketInputStream.socketRead(SocketInputStream.java:116) ~[na:1.8.0_281]
局部配置
在@FeignClient注解中指定配置文件，注意FeignConfig類不要加@Configuration注解，否則就會(huì)被Spring掃描到，變成了一個(gè)全局的配置。
@FeignClient(value = "order-service", path = "/order", configuration = FeignConfig.class)
也可以在yml中配置：
feign:
client:
config:
order-service: #對(duì)應(yīng)微服務(wù)
# 連接超時(shí)時(shí)間，默認(rèn)2s
connectTimeout: 5000
# 請(qǐng)求處理超時(shí)時(shí)間，默認(rèn)5s
readTimeout: 10000
Feign的底層用的是Ribbon，但超時(shí)時(shí)間以Feign配置為準(zhǔn)。
客戶端組件配置
Feign中默認(rèn)使用JDK原生的URLConnection發(fā)送HTTP請(qǐng)求，我們可以集成別的組件來(lái)替換掉URLConnection，比如Apache HttpClient，OkHttp。
Feign發(fā)起調(diào)用真正執(zhí)行邏輯：feign.Client#execute（擴(kuò)展點(diǎn)）
配置Apache HttpClient
引入HttpClient依賴：
<!-- Apache HttpClient -->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.7</version>
</dependency>
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
<version>10.1.0</version>
</dependency>
然后修改yml配置，將Feign的Apache HttpClient啟用：
feign:
#feign 使用 Apache HttpClient 可以忽略，默認(rèn)開(kāi)啟
httpclient:
enabled: true
關(guān)于配置可參考源碼：org.springframework.cloud.openfeign.FeignAutoConfiguration
測(cè)試：調(diào)用會(huì)進(jìn)入feign.httpclient.ApacheHttpClient#execute
配置OkHttp
引入OkHttp的依賴：
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
</dependency>
然后修改yml配置，將Feign的HttpClient禁用，啟用OkHttp，配置如下：
feign:
#feign 使用 okhttp
httpclient:
enabled: false
okhttp:
enabled: true
關(guān)于配置可參考源碼：org.springframework.cloud.openfeign.FeignAutoConfiguration
測(cè)試：調(diào)用會(huì)進(jìn)入feign.okhttp.OkHttpClient#execute
GZIP壓縮配置
開(kāi)啟壓縮可以有效節(jié)約網(wǎng)絡(luò)資源，提升接口性能，我們可以配置GZIP來(lái)壓縮數(shù)據(jù)：
feign:
# 配置 GZIP 來(lái)壓縮數(shù)據(jù)
compression:
request:
enabled: true
# 配置壓縮的類型
mime-types: text/xml,application/xml,application/json
# 最小壓縮值
min-request-size: 2048
response:
enabled: true
開(kāi)啟后在日志中會(huì)看到請(qǐng)求頭中有g(shù)zip：
2023-08-15 14:38:38.482 DEBUG 23664 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#bigJson] ---> POST http://order-service/order/bigJson HTTP/1.1
2023-08-15 14:38:38.482 DEBUG 23664 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#bigJson] Accept-Encoding: gzip
2023-08-15 14:38:38.483 DEBUG 23664 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#bigJson] Accept-Encoding: deflate
2023-08-15 14:38:38.483 DEBUG 23664 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#bigJson] Content-Encoding: gzip
2023-08-15 14:38:38.483 DEBUG 23664 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#bigJson] Content-Encoding: deflate
2023-08-15 14:38:38.483 DEBUG 23664 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#bigJson] Content-Length: 289891
2023-08-15 14:38:38.483 DEBUG 23664 --- [nio-8030-exec-1] com.morris.user.client.OrderClient : [OrderClient#bigJson] Content-Type: application/json
注意：只有當(dāng)Feign的Http組件不是okhttp3的時(shí)候，壓縮才會(huì)生效，配置源碼在FeignAcceptGzipEncodingAutoConfiguration
@Configuration(
proxyBeanMethods = false
)
@EnableConfigurationProperties({FeignClientEncodingProperties.class})
@ConditionalOnClass({Feign.class})
@ConditionalOnBean({Client.class})
@ConditionalOnProperty(
value = {"feign.compression.response.enabled"},
matchIfMissing = false
)
@ConditionalOnMissingBean(
type = {"okhttp3.OkHttpClient"}
)
@AutoConfigureAfter({FeignAutoConfiguration.class})
public class FeignAcceptGzipEncodingAutoConfiguration {
public FeignAcceptGzipEncodingAutoConfiguration() {
}
@Bean
public FeignAcceptGzipEncodingInterceptor feignAcceptGzipEncodingInterceptor(FeignClientEncodingProperties properties) {
return new FeignAcceptGzipEncodingInterceptor(properties);
}
}
核心代碼就是@ConditionalOnMissingBean（type=“okhttp3.OkHttpClient”），表示Spring BeanFactory中不包含指定的bean時(shí)條件匹配，也就是沒(méi)有啟用okhttp3時(shí)才會(huì)進(jìn)行壓縮配置。
編碼器解碼器配置
Feign中提供了自定義的編碼解碼器設(shè)置，同時(shí)也提供了多種編碼器的實(shí)現(xiàn)，比如Gson、Jaxb、Jackson。我們可以用不同的編碼解碼器來(lái)處理數(shù)據(jù)的傳輸。如果你想傳輸XML格式的數(shù)據(jù)，可以自定義XML編碼解碼器來(lái)實(shí)現(xiàn)獲取使用官方提供的Jaxb。
擴(kuò)展點(diǎn)：Encoder & Decoder文章來(lái)源：http://www.zghlxwxcb.cn/news/detail-662864.html
public interface Encoder {
void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException;
}
public interface Decoder {
Object decode(Response response, Type type) throws IOException, DecodeException, FeignException;
}
Java配置方式
配置編碼解碼器只需要在Feign的配置類中注冊(cè)Decoder和Encoder這兩個(gè)類即可:文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-662864.html
@Bean
public Decoder decoder() {
return new JacksonDecoder();
}
@Bean
public Encoder encoder() {
return new JacksonEncoder();
}
yml配置方式
feign:
client:
config:
order-service: #對(duì)應(yīng)微服務(wù)
# 配置編解碼器
encoder: feign.jackson.JacksonEncoder
decoder: feign.jackson.JacksonDecoder
到了這里，關(guān)于【openfeign】OpenFeign的擴(kuò)展、日志、超時(shí)時(shí)間、攔截器、客戶端組件、壓縮的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
