當前位置：首頁 > 科技 > 軟件

全網最詳細的OpenFeign講解，肯定有你不知道的

來源：責編：時間：2023-11-30 09:26:35 262觀看

導讀環境：SpringCloud3.1.51. 簡介Spring Cloud OpenFeign是一種聲明式、模板化的HTTP客戶端，它簡化了遠程調用的編程體驗。在Spring Cloud中使用OpenFeign，開發者可以像調用本地方法一樣使用HTTP請求訪問遠程服務，而無需感知

環境：SpringCloud3.1.5

1. 簡介

Spring Cloud OpenFeign是一種聲明式、模板化的HTTP客戶端，它簡化了遠程調用的編程體驗。在Spring Cloud中使用OpenFeign，開發者可以像調用本地方法一樣使用HTTP請求訪問遠程服務，而無需感知這是在調用遠程方法。

OpenFeign會根據帶有注解的函數信息構建出網絡請求的模板，在發送網絡請求之前，OpenFeign會將函數的參數值設置到這些請求模板中。

在項目啟動階段，OpenFeign框架會自動的掃包流程，從指定的目錄下掃描并加載所有被@FeignClient注解修飾的接口。OpenFeign會針對每一個FeignClient接口生成一個動態代理(JDK)對象，這個動態代理對象會被添加到Spring上下文中，并注入到對應的服務里。

總的來說，Spring Cloud OpenFeign是一種強大的工具，它可以幫助開發者更輕松地實現微服務的遠程調用。

2. OpenFeign配置

2.1 開啟功能

引入依賴

groupId: org.springframework.cloudartifactId: spring-cloud-starter-openfeign

開啟

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

示例

@FeignClient(name = "demoService")public interface DemoFeign {  @GetMapping("/info/{id}")  public Object info(@PathVariable("id") Integer id) ;}

在 @FeignClient 注解中，name="demoService"是一個客戶端名稱，用于創建 Spring Cloud LoadBalancer 客戶端。你也可以設置 url 屬性（絕對值或主機名）指定一個 URL。

2.2 自定義配置

通過指定@FeignClient configuration屬性實現自定義配置

@FeignClient(name = "demoService", configuration=DemoConfiguration.class)public interface DemoFeign {}

默認情況下Spring Cloud OpenFeign會提供如下的默認Bean：

Decoder feignDecoder：ResponseEntityDecoder 響應內容解碼

Encoder feignEncoder: SpringEncoder

Logger feignLogger: Slf4jLogger

MicrometerCapability micrometerCapability: 如果 feign-micrometer 位于類路徑上，且 MeterRegistry 可用

CachingCapability cachingCapability: 如果使用 @EnableCaching 注解。可通過 feign.cache.enabled 關閉。

Contract feignContract: SpringMvcContract這個的作用就是用來接下@FeignClient注解類中的相應MVC注解

Feign.Builder feignBuilder: FeignCircuitBreaker.Builder構建Feign客戶端的，比如環境中使用了CircuitBreaker，那么就會在調用接口時應用斷路器功能

Client feignClient: 如果 Spring Cloud LoadBalancer 位于類路徑上，則使用 FeignBlockingLoadBalancerClient。如果它們都不在類路徑上，則使用默認的 Feign Client。默認的Client使用jdk自定的網絡請求 URLConnection。

我們可以在自定義的DemoConfiguration中自定義自己的實現，在DemoConfiguration中你可以自定義如下的Bean：注意：這些bean是 OpenFeign沒有提供的，除了上面介紹的你可以覆蓋自定義實現，你還可以定義下面的bean

Logger.LevelRetryerErrorDecoderRequest.OptionsCollection<RequestInterceptor>SetterFactoryQueryMapEncoderCapability (MicrometerCapability and CachingCapability are provided by default)

接下來會介紹常用的一些自定義配置

動態配置name & url

@FeignClient(name = "${pack.demo.name}", url="${pack.demo.url}")public interface DemoFeign {}

配置文件

pack:  demo:    name: demoService    url: http://localhost:8088/demos

超時配置

feign:  client:    config:      default:        connectTimeout: 5000        readTimeout: 5000

默認所有的接口請求超時都是5s。

動態設置超時時間

如果啟用了 Feign 客戶端刷新，則每個 Feign 客戶端都會以 feign.Request.Options 作為 refresh-scoped Bean 來創建。這意味著 connectTimeout 和 readTimeout 等屬性可以通過 POST /actuator/refresh 針對任何 Feign 客戶端實例進行刷新。值需要進行如下配置接口

feign:  client:    refresh-enabled: true

自定義日志級別

配置文件中設置

logging:  level:    '[com.pack.feign.test.DemoFeign]': debug

配置日志基本，兩種方式：1 配置文件；2 定義Bean

feign:  client:    config:      demoService:        logger-level: full

在自定義配置類中定義為bean

@Beanpublic Logger.Level loggerLevel() {  return Logger.Level.FULL ;}

自定義重試機制

默認情況下，當請求的接口出現異常不會進行重試，可以通過定義下面bean進行重試

@Beanpublic Retryer feignRetryer() {  Retryer.Default retryer = new Retryer.Default(100, SECONDS.toMillis(1), 2);  return retryer ;}

自定義攔截器

默認OpenFeign不提供任何攔截器，如果你需要在請求前進行處理，比如添加請求header，那么你可以自定義攔截器實現

@Beanpublic RequestInterceptor headerRequestInterceptor() {  return template -> {    template.header("X-API-TOKEN", "666666") ;  } ;}

也可以通過配置文件配置

feign:  client:    config:      demoService:        request-interceptors:        - com.pack.feign.HeaderRequestInterceptor

手動創建Feign客戶端

在某些情況下，可能需要自定義 Feign 客戶端，你可以使用 Feign Builder API 創建客戶端。下面的示例創建了兩個具有相同接口的 Feign Client，但每個客戶端都配置了單獨的請求攔截器。

public class DemoController {  private DemoFeign demoFeign ;  @Autowired  public DemoController(Client client, Encoder encoder, Decoder decoder) {    this.fooClient = Feign.builder().client(client)        .encoder(encoder)        .decoder(decoder)        .requestInterceptor(new HeaderRequestInterceptor("X-API-TOKEN", "666666"))        .target(FooClient.class, "http://localhost:8088/demos");  }}

服務降級

當你的類路徑下有了Spring Cloud CircuitBreaker后服務降級fallback才會生效。

@FeignClient(    url = "http://localhost:8088/demos",     name = "demoService",     configuration = DemoFeignConfiguration.class,    fallback = DemoFeignFallback.class)public interface DemoFeign {  @GetMapping("/info/{id}")  public Object info(@PathVariable("id") Integer id) ;}

服務降級類必須實現對應FeignClient的接口

public class DemoFeignFallback implements DemoFeign {  public Object info(Integer id) {    return "default - " + id;  }}

服務降級工廠

如果需要訪問觸發回退的原因，可以使用 @FeignClient 內的 fallbackFactory 屬性。

@FeignClient(    url = "http://localhost:8088/demos",     name = "demoService",     configuration = DemoFeignConfiguration.class,    fallbackFactory = DemoFeignFallbackFactory.class,)public interface DemoFeign {  @GetMapping("/info/{id}")  public Object info(@PathVariable("id") Integer id) ;}

工廠類

public class DemoFeignFallbackFactory implements FallbackFactory<DemoFeignFallback> {  static class DemoFeignFallback implements DemoFeign {    private Throwable cause ;    public DemoFeignFallback(Throwable cause) {      this.cause = cause ;    }    @Override    public Object info(Integer id) {      return "接口調用異常 - " + this.cause.getMessage() ;    }  }  @Override  public DemoFeignFallback create(Throwable cause) {    return new DemoFeignFallback(cause) ;  }}

緩存支持

如果使用 @EnableCaching 注解，則會創建并注冊一個 CachingCapability Bean，以便 Feign 客戶端識別其接口上的 @Cache* 相關注解：

@FeignClient(    url = "http://localhost:8088/demos",     name = "demoService",     configuration = DemoFeignConfiguration.class,    fallbackFactory = DemoFeignFallbackFactory.class,)public interface DemoFeign {  @GetMapping("/info/{id}")  @Cacheable(cacheNames = "demo-cache", key = "#id")  public Object info(@PathVariable("id") Integer id) ;}

Feign繼承支持

Feign 通過單繼承接口支持模板應用程序。這樣就可以將常用操作歸類到方便的基礎接口中。

@FeignClient(    url = "http://localhost:8088/users",     name = "userService")public interface UserService {  @GetMapping("/{id}")  User getUser(@PathVariable("id") Long id) ;}@FeignClient("users")public interface UserClient extends UserService {}

注意：@FeignClient 接口不應在服務器和客戶端之間共享，并且不再支持在類級使用 @RequestMapping 對 @FeignClient 接口進行注解。

請求相應壓縮

你可以考慮為你的 Feign 請求啟用請求或響應 GZIP 壓縮。你可以啟用其中一個屬性：

feign:   compression:     request      enabled: true    response:      enabled: true

控制壓縮MeidaType類型和最小請求閾值長度

feign:  compression:     request:      mime-types: text/xml,application/xml,application/json      min-request-size: 2048

3. 關于響應式客戶端

由于 OpenFeign 項目目前不支持 Spring WebClient 等反應式客戶端，因此 Spring Cloud OpenFeign 也不支持反應式客戶端。

目前官方推薦的響應式庫：feign-reactive

<dependency>  <groupId>com.playtika.reactivefeign</groupId>  <artifactId>feign-reactor-webclient</artifactId>  <version>3.3.0</version></dependency>

我目前使用的是3.3.0版本，除了注解適當調整，其它使用基本一致，非常爽。

@ReactiveFeignClient(    url = "http://localhost:8088/demos",     name = "demoReactorFeign",     fallback = DemoReactorFeignFallback.class,    configuration = {DemoReactorFeignConfig.class})public interface DemoReactorFeign {  @GetMapping("/info/{id}")  public Mono<Object> info(@PathVariable("id") Integer id) ;}

總結：

OpenFeign是一個非常有用的工具，它為開發者提供了一種簡單而強大的方式來處理遠程服務調用。通過使用OpenFeign，開發者可以專注于業務邏輯，而無需花費太多精力在復雜的網絡編程細節上。

OpenFeign的聲明式編程風格使得我們能夠以一種高度抽象和簡潔的方式與遠程服務進行交互，它簡化了網絡請求的構建和發送過程，降低了開發的復雜度。

總的來說，Spring Cloud OpenFeign是一個強大而靈活的工具，它可以幫助開發者更高效地構建和維護微服務應用。通過使用OpenFeign，我們可以更好地專注于業務邏輯，而無需擔心網絡調用的實現細節。

完畢！！！

本文鏈接：http://www.tebozhan.com/showinfo-26-35260-0.html全網最詳細的OpenFeign講解，肯定有你不知道的

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。郵件：2376512515@qq.com

上一篇：消息隊列批量收發消息，請避開這五個坑！

下一篇： Python的三元表達式，你知道嗎？

標簽：

熱門焦點

小米降噪藍牙耳機Necklace分享：聽一首歌讀懂一個故事

在今天下午的小米Civi 2新品發布會上，小米還帶來了一款新的降噪藍牙耳機Necklace，我們也在發布結束的第一時間給大家帶來這款耳機的簡單分享。現在大家能見到最多的藍牙耳機
消息稱迪士尼要拍真人版《魔發奇緣》：女主可能也找黑人演員

8月5日消息，迪士尼確實有點忙，忙著將不少動畫改成真人版，繼《美人魚》后，真人版《白雪公主》、《魔發奇緣》也在路上了。據外媒消息稱，迪士尼將打造真人版
微信語音大揭秘：為什么禁止轉發？

大家好，我是你們的小米。今天，我要和大家聊一個有趣的話題：為什么微信語音不可以轉發？這是一個我們經常在日常使用中遇到的問題，也是一個讓很多人好奇的問題。讓我們一起來揭開這
一條抖音4億人圍觀 ! 這家MCN比無憂傳媒還野

作者：Hiu 來源：互聯網品牌官01 擦邊少女空降熱搜，幕后推手曝光被網友譽為“純欲天花板”的女網紅井川里予，近期因為一組哥特風照片登上熱搜，引發了一場互聯網世界關于
國行版三星Galaxy Z Fold5/Z Flip5發布售價7499元起

2023年8月3日，三星電子舉行Galaxy新品中國發布會，正式在國內推出了新一代折疊屏智能手機三星Galaxy Z Fold5與Galaxy Z Flip5，以及三星Galaxy Tab S9
iQOO 11S評測：行業唯一的200W標準版旗艦

【Techweb評測】去年底，iQOO推出了“電競旗艦”iQOO 11系列，作為一款性能強機，該機不僅全球首發2K 144Hz E6全感屏，搭載了第二代驍龍8平臺及144Hz電競
OPPO K11采用全方位護眼屏：三大護眼能力減輕視覺疲勞

日前OPPO官方宣布，全新的OPPO K11將于7月25日正式發布，將主打旗艦影像，和同檔位競品相比，其最大的賣點就是將配備索尼IMX890主攝，堪稱是2000檔位影像表
外交部：美方應停止在網絡安全問題上不負責任地指責他國

　中國外交部今天（16日）舉行例行記者會。會上，有記者問，美國情報官員稱，他們正在阻攔來自中國以及其他國家的黑客獲取相關科研成果。中方對此有何評論？對此
北京：科技教育體驗基地開始登記

　　北京“科技館之城”科技教育體驗基地登記和認證工作日前啟動。首批北京科技教育體驗基地擬于2023年全國科普日期間掛牌，后續還將開展常態化登記。　　北京科技教育體驗基

AVt天堂网手机版,亚洲va久久久噜噜噜久久4399,天天综合亚洲色在线精品,亚洲一级Av无码毛片久久精品

全網最詳細的OpenFeign講解，肯定有你不知道的

1. 簡介

2. OpenFeign配置

2.1 開啟功能

2.2 自定義配置

3. 關于響應式客戶端

總結：

小米降噪藍牙耳機Necklace分享：聽一首歌讀懂一個故事

消息稱迪士尼要拍真人版《魔發奇緣》：女主可能也找黑人演員

微信語音大揭秘：為什么禁止轉發？

一條抖音4億人圍觀 ! 這家MCN比無憂傳媒還野

國行版三星Galaxy Z Fold5/Z Flip5發布售價7499元起

iQOO 11S評測：行業唯一的200W標準版旗艦

OPPO K11采用全方位護眼屏：三大護眼能力減輕視覺疲勞

外交部：美方應停止在網絡安全問題上不負責任地指責他國

北京：科技教育體驗基地開始登記

最新推薦

猜你喜歡

熱門推薦

相關資訊