快捷導(dǎo)航

springboot FeignClient注解及參數(shù)

更新時間：2019年12月17日 14:31:56 作者：珠混魚目

這篇文章主要介紹了springboot FeignClient注解及參數(shù)，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

一、FeignClient注解

FeignClient注解被@Target(ElementType.TYPE)修飾，表示FeignClient注解的作用目標(biāo)在接口上

@FeignClient(name = "github-client", url = "https://api.github.com", configuration = GitHubExampleConfig.class)
public interface GitHubClient {
  @RequestMapping(value = "/search/repositories", method = RequestMethod.GET)
  String searchRepo(@RequestParam("q") String queryStr);
}

聲明接口之后，在代碼中通過@Resource注入之后即可使用。@FeignClient標(biāo)簽的常用屬性如下：

name：指定FeignClient的名稱，如果項目使用了Ribbon，name屬性會作為微服務(wù)的名稱，用于服務(wù)發(fā)現(xiàn)
url: url一般用于調(diào)試，可以手動指定@FeignClient調(diào)用的地址
decode404:當(dāng)發(fā)生http 404錯誤時，如果該字段位true，會調(diào)用decoder進行解碼，否則拋出FeignException
configuration: Feign配置類，可以自定義Feign的Encoder、Decoder、LogLevel、Contract
fallback: 定義容錯的處理類，當(dāng)調(diào)用遠程接口失敗或超時時，會調(diào)用對應(yīng)接口的容錯邏輯，fallback指定的類必須實現(xiàn)@FeignClient標(biāo)記的接口
fallbackFactory: 工廠類，用于生成fallback類示例，通過這個屬性我們可以實現(xiàn)每個接口通用的容錯邏輯，減少重復(fù)的代碼
path: 定義當(dāng)前FeignClient的統(tǒng)一前綴

@FeignClient(name = "github-client",
    url = "https://api.github.com",
    configuration = GitHubExampleConfig.class,
    fallback = GitHubClient.DefaultFallback.class)
public interface GitHubClient {
  @RequestMapping(value = "/search/repositories", method = RequestMethod.GET)
  String searchRepo(@RequestParam("q") String queryStr);
 
  /**
   * 容錯處理類，當(dāng)調(diào)用失敗時，簡單返回空字符串
   */
  @Component
  public class DefaultFallback implements GitHubClient {
    @Override
    public String searchRepo(@RequestParam("q") String queryStr) {
      return "";
    }
  }
}

在使用fallback屬性時，需要使用@Component注解，保證fallback類被Spring容器掃描到,GitHubExampleConfig內(nèi)容如下：

@Configuration
public class GitHubExampleConfig {
  @Bean
  Logger.Level feignLoggerLevel() {
    return Logger.Level.FULL;
  }
}

在使用FeignClient時，Spring會按name創(chuàng)建不同的ApplicationContext，通過不同的Context來隔離FeignClient的配置信息，在使用配置類時，不能把配置類放到Spring App Component scan的路徑下，否則，配置類會對所有FeignClient生效.

二、Feign Client 和@RequestMapping

當(dāng)前工程中有和Feign Client中一樣的Endpoint時，F(xiàn)eign Client的類上不能用@RequestMapping注解否則，當(dāng)前工程該endpoint http請求且使用accpet時會報404
Controller：

@RestController
@RequestMapping("/v1/card")
public class IndexApi {
 
  @PostMapping("balance")
  @ResponseBody
  public Info index() {
    Info.Builder builder = new Info.Builder();
    builder.withDetail("x", 2);
    builder.withDetail("y", 2);
    return builder.build();
  }
}

Feign Client

@FeignClient(
    name = "card",
    url = "http://localhost:7913",
    fallback = CardFeignClientFallback.class,
    configuration = FeignClientConfiguration.class
)
@RequestMapping(value = "/v1/card")
public interface CardFeignClient {
 
  @RequestMapping(value = "/balance", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
  Info info();
 
}

if @RequestMapping is used on class, when invoke http /v1/card/balance, like this :

如果 @RequestMapping注解被用在FeignClient類上，當(dāng)像如下代碼請求/v1/card/balance時，注意有Accept header：

Content-Type:application/json
Accept:application/json
 
POST http://localhost:7913/v1/card/balance

那么會返回 404。

如果不包含Accept header時請求，則是OK：

Content-Type:application/json
POST http://localhost:7913/v1/card/balance

或者像下面不在Feign Client上使用@RequestMapping注解,請求也是ok，無論是否包含Accept:

@FeignClient(
    name = "card",
    url = "http://localhost:7913",
    fallback = CardFeignClientFallback.class,
    configuration = FeignClientConfiguration.class
)
 
public interface CardFeignClient {
 
  @RequestMapping(value = "/v1/card/balance", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
  Info info();
 
}

三、Feign請求超時問題

Hystrix默認的超時時間是1秒，如果超過這個時間尚未響應(yīng)，將會進入fallback代碼。而首次請求往往會比較慢（因為Spring的懶加載機制，要實例化一些類），這個響應(yīng)時間可能就大于1秒了
解決方案有三種，以feign為例。

方法一
hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 5000
該配置是讓Hystrix的超時時間改為5秒

方法二
hystrix.command.default.execution.timeout.enabled: false
該配置，用于禁用Hystrix的超時時間

方法三
feign.hystrix.enabled: false
該配置，用于索性禁用feign的hystrix。該做法除非一些特殊場景，不推薦使用。

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: