Spring?Cloud中Feign怎么自定義配置與使用

這篇文章主要介紹了Spring Cloud中Feign怎么自定義配置與使用的相關知識，內容詳細易懂，操作簡單快捷，具有一定借鑒價值，相信大家閱讀完這篇Spring Cloud中Feign怎么自定義配置與使用文章都會有所收獲，下面我們一起來看看吧。

日志配置

有時候我們遇到 Bug，比如接口調用失敗、參數沒收到等

問題，或者想看看調用性能，就需要配置 Feign 的日志了，

以此讓 Feign 把請求信息輸出來。

首先定義一個配置類，代碼如下所示。

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 和響應的狀態碼以及接 口執行的時間。

• 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); }

在配置文件中執行 Client 的日志級別才能正常輸出日志，

格式是“logging.level.client 類地址=級別”。

logging: 
  level: 
    com.by.remote.UserRemoteClient: debug

Basic 認證配置

通常我們調用的接口都是有權限控制的，很多時候可能認證

的值是通過參數去傳遞的，還有就是通過請求頭去傳遞認證

信息，比如 Basic 認證方式。在 Feign 中我們可以直接配置

Basic 認證，代碼如下所示。

@Configuration 
public class FeignConfig { 
public BasicAuthRequestInterceptor basicAuthRequestInterceptor(){ 
return new BasicAuthRequestInterceptor("admin","1357"); 
} }

或者你可以自定義屬于自己的認證方式，其實就是自定義一

個請求攔截器。在請求之前做認證操作，然后往請求頭中設

置認證之后的信息。通過實現 RequestInterceptor 接口來

自定義認證方式，代碼如下所示。

import feign.RequestInterceptor; 
import feign.RequestTemplate; 
public class FeignAuthInteceptor implements RequestInterceptor { 
@Override public void apply(RequestTemplate requestTemplate) { 
requestTemplate.header("token","");
 } 
 }

然后將配置改成我們自定義的就可以了，這樣當 Feign 去請

求接口的時候，每次請求之前都會進入

FeignAuthInteceptor的 apply 方法中，在里面就可以做屬

于你的邏輯了，代碼如下所示。

@Configuration public class FeignConfig { 
@Bean public RequestInterceptor basicAuthRequestInterceptor(){ 
return new FeignAuthInteceptor(); } }

超時時間配置

通過 Options 可以配置連接超時時間和讀取超時時間（代

碼如下所示），Options 的第一個參數是連接超時時間

（ms），默認值是 10×1000；第二個是取超時時間

（ms），默認值是 60×1000。

@Configuration public class FeignConfig { 
@Bean public Request.Options options() { 
return new Request.Options(5, TimeUnit.SECONDS,6,TimeUnit.SECONDS,true);
 }
  }

客戶端組件配置

Feign 中默認使用apache httpclient 發送 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 # 啟用

關于配置可參考源碼

org.springframework.cloud.openfeign.FeignAutoCon

figuration

GZIP壓縮配置

開啟壓縮可以有效節約網絡資源，提升接口性能，我們可以

配置 GZIP 來壓縮數據：

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

還可以配置壓縮的類型、最小壓縮值的標準：

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

只有當 Feign 的 Http Client 不是 okhttp3 的時候，壓縮才

會生效，配置源碼在 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 時條件匹配，也就是沒

有啟用 okhttp3 時才會進行壓縮配置。

繼承特性

Feign 的繼承特性可以讓服務的接口定義單獨抽出來，作為

公共的依賴，以方便使用。

創建一個module，用于存放 API 接口的定義，增加 Feign

的依賴，定義接口，指定服務名稱，代碼如下所示

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);
    }

打包安裝到倉庫

修改用戶中心實現，先引入依賴

<dependency>
<groupId>com.by</groupId> 
<artifactId>ws-api</artifactId> 
<version>0.0.1-SNAPSHOT</version> 
</dependency>

實現 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; 
   } 
   }

修改訂單服務，同樣引入api，調用代碼

@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; } 
  }

多參數請求構造

多參數請求構造分為 GET 請求和 POST 請求兩種方式，首

先來看 GET 請求的多參數請求構造方式，代碼如下所示。

@GetMapping("/user/info") 
String getUserInfo(@RequestParam("name")String name,@RequestParam("age")int age);

另一種是通過 Map 來傳遞多個參數，參數數量可以動態改

變，筆者在這里還是推薦大家用固定的參數方式，不要用

Map 來傳遞參數，Map 傳遞參數最大的問題是可以隨意傳

參。代碼如下所示。

@GetMapping("/user/detail") 
String getUserDetail(@RequestParam Map<String, Object> param);

POST 請求多參數就定義一個參數類，通過

@RequestBody 注解的方式來實現，代碼如下所示。

@PostMapping("/user/add") 
String addUser(@RequestBody User user);

注意： @RequestBody @PathVariable 在實現類上也要

加上注解

@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; } 
 }

關于“Spring Cloud中Feign怎么自定義配置與使用”這篇文章的內容就介紹到這里，感謝各位的閱讀！相信大家對“Spring Cloud中Feign怎么自定義配置與使用”知識都有一定的了解，大家如果還想學習更多知識，歡迎關注億速云行業資訊頻道。