springboot FeignClient註解及引數
一、FeignClient註解
FeignClient註解被@Target(ElementType.TYPE)修飾,表示FeignClient註解的作用目標在介面上
@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標籤的常用屬性如下:
- name:指定FeignClient的名稱,如果專案使用了Ribbon,name屬性會作為微服務的名稱,用於服務發現
- url: url一般用於除錯,可以手動指定@FeignClient呼叫的地址
- decode404:當發生http 404錯誤時,如果該欄位位true,會呼叫decoder進行解碼,否則丟擲FeignException
- configuration: Feign配置類,可以自定義Feign的Encoder、Decoder、LogLevel、Contract
- fallback: 定義容錯的處理類,當呼叫遠端介面失敗或超時時,會呼叫對應介面的容錯邏輯,fallback指定的類必須實現@FeignClient標記的介面
- fallbackFactory: 工廠類,用於生成fallback類示例,通過這個屬性我們可以實現每個介面通用的容錯邏輯,減少重複的程式碼
- path: 定義當前FeignClient的統一字首
@FeignClient(name = "github-client",configuration = GitHubExampleConfig.class,fallback = GitHubClient.DefaultFallback.class) public interface GitHubClient { @RequestMapping(value = "/search/repositories",method = RequestMethod.GET) String searchRepo(@RequestParam("q") String queryStr); /** * 容錯處理類,當呼叫失敗時,簡單返回空字串 */ @Component public class DefaultFallback implements GitHubClient { @Override public String searchRepo(@RequestParam("q") String queryStr) { return ""; } } }
在使用fallback屬性時,需要使用@Component註解,保證fallback類被Spring容器掃描到,GitHubExampleConfig內容如下:
@Configuration public class GitHubExampleConfig { @Bean Logger.Level feignLoggerLevel() { return Logger.Level.FULL; } }
在使用FeignClient時,Spring會按name建立不同的ApplicationContext,通過不同的Context來隔離FeignClient的配置資訊,在使用配置類時,不能把配置類放到Spring App Component scan的路徑下,否則,配置類會對所有FeignClient生效.
二、Feign Client 和@RequestMapping
當前工程中有和Feign Client中一樣的Endpoint時,Feign Client的類上不能用@RequestMapping註解否則,當前工程該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類上,當像如下程式碼請求/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",configuration = FeignClientConfiguration.class ) public interface CardFeignClient { @RequestMapping(value = "/v1/card/balance",produces = MediaType.APPLICATION_JSON_VALUE) Info info(); }
三、Feign請求超時問題
Hystrix預設的超時時間是1秒,如果超過這個時間尚未響應,將會進入fallback程式碼。而首次請求往往會比較慢(因為Spring的懶載入機制,要例項化一些類),這個響應時間可能就大於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。該做法除非一些特殊場景,不推薦使用。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。