Spring Cloud超詳細(xì)i講解Feign自定義配置與使用
日志配置
有時(shí)候我們遇到 Bug,比如接口調(diào)用失敗、參數(shù)沒收到等
問題,或者想看看調(diào)用性能,就需要配置 Feign 的日志了,
以此讓 Feign 把請求信息輸出來。
首先定義一個(gè)配置類,代碼如下所示。
package com.by.config; import feign.Logger; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configu ration; @Configuration public class FeignConfig { @Bean Logger.Level feignLogLevel(){ return Logger.Level.FULL; } }
通過源碼可以看到日志等級有 4 種,分別是:
- NONE:不輸出日志。
- BASIC:只輸出請求方法的 URL 和響應(yīng)的狀態(tài)碼以及接 口執(zhí)行的時(shí)間。
- HEADERS:將 BASIC 信息和請求頭信息輸出。
- FULL:輸出完整的請求信息。
在 Feign Client 中的 @FeignClient 注解中指定使用的配置類,代碼如下所示。
@FeignClient(value = "ws-user- server",configuration = {FeignConfig.class}) public interface UserRemoteClient { @GetMapping("/user/{id}") Map getuser(@PathVariable(name = "id") String id); }
在配置文件中執(zhí)行 Client 的日志級別才能正常輸出日志,
格式是“logging.level.client 類地址=級別”。
logging:
level:
com.by.remote.UserRemoteClient: debug
Basic 認(rèn)證配置
通常我們調(diào)用的接口都是有權(quán)限控制的,很多時(shí)候可能認(rèn)證
的值是通過參數(shù)去傳遞的,還有就是通過請求頭去傳遞認(rèn)證
信息,比如 Basic 認(rèn)證方式。在 Feign 中我們可以直接配置
Basic 認(rèn)證,代碼如下所示。
@Configuration public class FeignConfig { public BasicAuthRequestInterceptor basicAuthRequestInterceptor(){ return new BasicAuthRequestInterceptor("admin","1357"); } }
或者你可以自定義屬于自己的認(rèn)證方式,其實(shí)就是自定義一
個(gè)請求攔截器。在請求之前做認(rèn)證操作,然后往請求頭中設(shè)
置認(rèn)證之后的信息。通過實(shí)現(xiàn) RequestInterceptor 接口來
自定義認(rèn)證方式,代碼如下所示。
import feign.RequestInterceptor; import feign.RequestTemplate; public class FeignAuthInteceptor implements RequestInterceptor { @Override public void apply(RequestTemplate requestTemplate) { requestTemplate.header("token",""); } }
然后將配置改成我們自定義的就可以了,這樣當(dāng) Feign 去請
求接口的時(shí)候,每次請求之前都會(huì)進(jìn)入
FeignAuthInteceptor的 apply 方法中,在里面就可以做屬
于你的邏輯了,代碼如下所示。
@Configuration public class FeignConfig { @Bean public RequestInterceptor basicAuthRequestInterceptor(){ return new FeignAuthInteceptor(); } }
超時(shí)時(shí)間配置
通過 Options 可以配置連接超時(shí)時(shí)間和讀取超時(shí)時(shí)間(代
碼如下所示),Options 的第一個(gè)參數(shù)是連接超時(shí)時(shí)間
(ms),默認(rèn)值是 10×1000;第二個(gè)是取超時(shí)時(shí)間
(ms),默認(rèn)值是 60×1000。
@Configuration public class FeignConfig { @Bean public Request.Options options() { return new Request.Options(5, TimeUnit.SECONDS,6,TimeUnit.SECONDS,true); } }
客戶端組件配置
Feign 中默認(rèn)使用apache httpclient 發(fā)送 HTTP 請求,我
們可以集成別的組件來替換掉,比如,OkHttp。
配置 OkHttp 只需要加入 OkHttp 的依賴,代碼如下所示。
<dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-okhttp</artifactId> </dependency>
然后修改配置,將 Feign 的 HttpClient 禁用,啟用
OkHttp,配置如下:
feign:
httpclient:
enabled: false #禁用
okhttp:
enabled: true # 啟用
關(guān)于配置可參考源碼
org.springframework.cloud.openfeign.FeignAutoCon
figuration
GZIP壓縮配置
開啟壓縮可以有效節(jié)約網(wǎng)絡(luò)資源,提升接口性能,我們可以
配置 GZIP 來壓縮數(shù)據(jù):
feign:
compression:
request:
enabled: true
response:
enabled: true
還可以配置壓縮的類型、最小壓縮值的標(biāo)準(zhǔn):
feign:
compression:
request:
enabled: true
mime-types: text/xml,application/xml,application/json min-request-size: 2048
只有當(dāng) Feign 的 Http Client 不是 okhttp3 的時(shí)候,壓縮才
會(huì)生效,配置源碼在 org.springframework.cloud.openfeign.encoding.FeignAcceptGzipE
ncodingAutoConfiguration,代碼如下所示。
@Configuration( proxyBeanMethods = false ) @EnableConfigurationProperties({FeignClientEnc odingProperties.class}) @ConditionalOnClass({Feign.class}) @ConditionalOnBean({Client.class}) @ConditionalOnProperty( value = {"feign.compression.response.enabled"}, matchIfMissing = false ) @ConditionalOnMissingBean( type = {"okhttp3.OkHttpClient"} ) @AutoConfigureAfter({FeignAutoConfiguration.cl ass}) public class FeignAcceptGzipEncodingAutoConfiguration { public FeignAcceptGzipEncodingAutoConfiguration() { } @Beanpublic FeignAcceptGzipEncodingInterceptor feignAcceptGzipEncodingInterceptor(FeignClient EncodingProperties properties) { return new FeignAcceptGzipEncodingInterceptor(properties) ; } }
核心代碼就是 @ConditionalOnMissingBean
(type=“okhttp3.OkHttpClient”),表示 Spring
BeanFactory 中不包含指定的 bean 時(shí)條件匹配,也就是沒
有啟用 okhttp3 時(shí)才會(huì)進(jìn)行壓縮配置。
繼承特性
Feign 的繼承特性可以讓服務(wù)的接口定義單獨(dú)抽出來,作為
公共的依賴,以方便使用。
創(chuàng)建一個(gè)module,用于存放 API 接口的定義,增加 Feign
的依賴,定義接口,指定服務(wù)名稱,代碼如下所示
package com.by.client; import org.springframework.cloud.openfeign.FeignClien t; import org.springframework.web.bind.annotation.GetMap ping; import java.util.Map; @FeignClient(value = "ws-user-server") public interface UserRemoteClient { @GetMapping("/user/{id}") public Map getuser(@PathVariable(name = "id") String id); }
打包安裝到倉庫
修改用戶中心實(shí)現(xiàn),先引入依賴
<dependency> <groupId>com.by</groupId> <artifactId>ws-api</artifactId> <version>0.0.1-SNAPSHOT</version> </dependency>
實(shí)現(xiàn) UserRemoteClient 接口,代碼如下所示。
@RestController public class UserController implements UserRemoteClient { @Override public Map getuser(@PathVariable(name="id") String id) { Map map=new HashMap(); map.put("id",id); map.put("name","管理員"); return map; } }
修改訂單服務(wù),同樣引入api,調(diào)用代碼
@RestController public class OrderController { @Autowired UserRemoteClient userRemoteClient; @GetMapping("/order/query") public Map query(){ Map map=userRemoteClient.getuser("40"); Map rs=new HashMap(); rs.put("orderNum","dd002"); rs.put("user",map); return rs; } }
多參數(shù)請求構(gòu)造
多參數(shù)請求構(gòu)造分為 GET 請求和 POST 請求兩種方式,首
先來看 GET 請求的多參數(shù)請求構(gòu)造方式,代碼如下所示。
@GetMapping("/user/info") String getUserInfo(@RequestParam("name")String name,@RequestParam("age")int age);
另一種是通過 Map 來傳遞多個(gè)參數(shù),參數(shù)數(shù)量可以動(dòng)態(tài)改
變,筆者在這里還是推薦大家用固定的參數(shù)方式,不要用
Map 來傳遞參數(shù),Map 傳遞參數(shù)最大的問題是可以隨意傳
參。代碼如下所示。
@GetMapping("/user/detail") String getUserDetail(@RequestParam Map<String, Object> param);
POST 請求多參數(shù)就定義一個(gè)參數(shù)類,通過
@RequestBody 注解的方式來實(shí)現(xiàn),代碼如下所示。
@PostMapping("/user/add") String addUser(@RequestBody User user);
注意: @RequestBody @PathVariable 在實(shí)現(xiàn)類上也要
加上注解
@RestController public class UserController implements UserRemoteClient { @Override public Map getuser(@PathVariable(name="id") String id) { Map map=new HashMap(); map.put("id",id); map.put("name","管理員"); return map; } }
到此這篇關(guān)于Spring Cloud超詳細(xì)i講解Feign自定義配置與使用的文章就介紹到這了,更多相關(guān)Spring Cloud Feign內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- SpringCloud超詳細(xì)講解Feign聲明式服務(wù)調(diào)用
- SpringCloud使用Feign實(shí)現(xiàn)動(dòng)態(tài)路由操作
- 解決SpringCloud?Feign異步調(diào)用傳參問題
- 分享Spring?Cloud?OpenFeign?的五個(gè)優(yōu)化技巧
- SpringCloud基于Feign的可編程式接口調(diào)用實(shí)現(xiàn)
- springcloud使用feign調(diào)用服務(wù)時(shí)參數(shù)內(nèi)容過大問題
- SpringCloud?Feign請求頭刪除修改的操作代碼
- SpringCloud中分析講解Feign組件添加請求頭有哪些坑梳理
相關(guān)文章
Java BufferedReader相關(guān)源碼實(shí)例分析
這篇文章主要介紹了Java BufferedReader相關(guān)源碼實(shí)例分析,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-10-10Java客戶端通過HTTPS連接到Easysearch實(shí)現(xiàn)過程
這篇文章主要為大家介紹了Java客戶端通過HTTPS連接到Easysearch實(shí)現(xiàn)過程詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11Flask接口如何返回JSON格式數(shù)據(jù)自動(dòng)解析
這篇文章主要介紹了Flask接口如何返回JSON格式數(shù)據(jù)自動(dòng)解析,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-11-11Java數(shù)據(jù)結(jié)構(gòu)之圖的原理與實(shí)現(xiàn)
圖(Graph)是由頂點(diǎn)的有窮非空集合和頂點(diǎn)之間邊的集合組成,通常表示為:G(V,E),其中,G表示一個(gè)圖,V是圖G中頂點(diǎn)的集合,E是圖G中邊的集合。本文將詳細(xì)介紹圖的原理及其代碼實(shí)現(xiàn),需要的可以參考一下2022-01-01