Spring Cloud超詳細i講解Feign自定義設定與使用

2022-06-20 14:00:49

紀錄檔設定

有時候我們遇到 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超詳細i講解Feign自定義設定與使用的文章就介紹到這了,更多相關Spring Cloud Feign內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！