您好,登錄后才能下訂單哦!
這篇文章主要介紹了怎么使用原生的Feign,具有一定借鑒價值,感興趣的朋友可以參考下,希望大家閱讀完這篇文章之后大有收獲,下面讓小編帶著大家一起了解一下。
Feign 是由 Netflix 團(tuán)隊開發(fā)的一款基于 Java 實現(xiàn)的 HTTP client,借鑒了 Retrofit、 JAXRS-2.0、WebSocket 等類庫。通過 Feign,我們可以像調(diào)用方法一樣非常簡單地訪問 HTTP API。這篇博客將介紹如何使用原生的 Feign,注意,是原生的,不是經(jīng)過 Spring 層層封裝的 Feign。
補(bǔ)充一下,在 maven 倉庫中搜索 feign,我們會看到兩種 Feign: OpenFeign Feign 和 Netflix Feign。它們有什么區(qū)別呢?簡單地說,OpenFeign Feign 的前身就是 Netflix Feign,因為 Netflix Feign 從 2016 年開始就不維護(hù)了,所以建議還是使用 OpenFeign Feign。
首先,因為 Feign 本身是一款 HTTP client,所以,這里先回答:為什么使用 HTTP client?
假設(shè)不用 HTTP client,我們訪問 HTTP API 的過程大致如下。是不是相當(dāng)復(fù)雜呢?直接操作 socket 已經(jīng)非常麻煩了,我們還必須在熟知 HTTP 協(xié)議的前提下自行完成報文的組裝和解析,代碼的復(fù)雜程度可想而知。
那么,這個過程是不是可以更簡單一些呢?
我們可以發(fā)現(xiàn),在上面的圖中,紅框的部分是相對通用的,是不是可以把這些邏輯封裝起來?基于這樣的思考,于是就有了 HTTP client(根據(jù)類庫的不同,封裝的層次會有差異)。
所以,為什么要使用 HTTP client 呢?簡單地說,就是為了讓我們更方便地訪問 HTTP API。
HTTP client 的類庫還有很多,例如 Retrofit、JDK 自帶的 HttpURLConnection、Apache HttpClient、OkHttp、Spring 的 RestTemplate,等等。我很少推薦說要使用哪種具體的類庫,如果真的要推薦 Feign 的話,主要是由于它優(yōu)秀的擴(kuò)展性(不是一般的優(yōu)秀,后面的使用例子就可以看到)。
關(guān)于如何使用 Feign,官方給出了非常詳細(xì)的文檔,在我看過的第三方類庫中,算是比較少見的。
本文用到的例子也是參考了官方文檔。
os:win 10
jdk:1.8.0_231
maven:3.6.3
IDE:Spring Tool Suite 4.6.1.RELEASE
這里引入 gson,是因為入門例子需要有一個 json 解碼器。
<properties> <feign.version>11.2</feign.version> </properties> <dependencies> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-core</artifactId> <version>${feign.version}</version> </dependency> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-gson</artifactId> <version>${feign.version}</version> </dependency> </dependencies>
入門例子中使用 Feign 來訪問 github 的接口獲取 Feign 這個倉庫的所有貢獻(xiàn)者。
通過下面的代碼可以發(fā)現(xiàn),F(xiàn)eign 本質(zhì)上是使用了動態(tài)代理來生成訪問 HTTP API 的代碼,定義 HTTP API 的過程有點像在定義 advice。
// 定義HTTP API interface GitHub { @RequestLine("GET /repos/{owner}/{repo}/contributors") // @RequestLine(value = "GET /repos/{owner}/{repo}/contributors", decodeSlash = false)// 測試轉(zhuǎn)義"/"、"+" // @RequestLine("GET /repos/{owner:[a-zA-Z]*}/{repo}/contributors")// 測試正則校驗 // @Headers("Accept: application/json") // 測試添加header List<Contributor> contributors(@Param("owner") String owner, @Param("repo") String repo); } public static class Contributor { String login; int contributions; } public class MyApp { public static void main(String... args) { // 獲取用來訪問HTTP API的代理類 GitHub github = Feign.builder() .decoder(new GsonDecoder()) // 返回內(nèi)容為json格式,所以需要用到j(luò)son解碼器 // .options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true)) // 配置超時參數(shù)等 .target(GitHub.class, "https://api.github.com"); // 像調(diào)用方法一樣訪問HTTP API github.contributors("OpenFeign", "feign").stream() .map(contributor -> contributor.login + " (" + contributor.contributions + ")") .forEach(System.out::println); } }
除了簡單方便之外,F(xiàn)eign 還有一個很大的亮點,就是有相當(dāng)優(yōu)秀的擴(kuò)展性,幾乎什么都可以自定義。下面是官方給的一張圖,基本涵蓋了 Feign 可以擴(kuò)展的內(nèi)容。每個擴(kuò)展支持都有一個對應(yīng)的適配包,例如,更換解碼器為 jackson 時,需要引入io.github.openfeign:feign-jackson的適配包。
在入門例子中,我們使用 Feign 自帶的注解來定義 HTTP API。但是,對于習(xí)慣了 Spring 注解的許多人來說,無疑需要增加學(xué)習(xí)成本。我們自然會問,F(xiàn)eign 能不能支持 Spring 注解呢?答案是肯定的。Feign 不但能支持 Spring 注解,還可以支持 JAX-RS、SOAP 等等。
下面就是使用 Sping 注解定義 HTTP API 的例子。注意,pom 文件中要引入 io.github.openfeign:feign-spring4 的依賴。
// 定義HTTP API interface GitHub { @GetMapping("/repos/{owner}/{repo}/contributors") List<Contributor> contributors(@RequestParam("owner") String owner, @RequestParam("repo") String repo); } public class MyApp { public static void main(String... args) { // 獲取用來訪問HTTP API的代理類 GitHub github = Feign.builder() .decoder(new GsonDecoder()) .contract(new SpringContract())// 自定義contract .target(GitHub.class, "https://api.github.com"); } }
在入門例子中,我們使用 gson 來解析 json。那么,如果我想把它換成 jackson 行不行?Feign 照樣提供了支持。
注意,pom 文件中要引入 io.github.openfeign:feign-jackson 的依賴。
public class MyApp { public static void main(String... args) { // 獲取用來訪問HTTP API的代理類 GitHub github = Feign.builder() .decoder(new JacksonDecoder()) // 自定義解碼器 .encoder(new JacksonEncoder()) // 自定義編碼器 .target(GitHub.class, "https://api.github.com"); } }
接下來的這個自定義就更厲害了。Feign 本身作為一款 HTTP client,竟然還可以支持其他 HTTP client。
這里用 OkHttp 作例子。注意,pom 文件中要引入 io.github.openfeign:feign-okhttp 的依賴。
public class MyApp { public static void main(String... args) { // 獲取用來訪問HTTP API的代理類 GitHub github = Feign.builder() .decoder(new GsonDecoder()) .client(new OkHttpClient())// 自定義client .target(GitHub.class, "https://api.github.com"); } }
我們訪問外部接口時,有時需要帶上一些特定的 header,例如,應(yīng)用標(biāo)識、token,我們可以通過兩種方式實現(xiàn):一是使用注解定義 HTTP API,二是使用攔截器(更常用)。下面的例子中,使用攔截器給請求添加 token 請求頭。
public class MyInterceptor implements RequestInterceptor { @Override public void apply(RequestTemplate template) { template.header("token", LoginUtils.getCurrentToken()); } } public class MyApp { public static void main(String... args) { // 獲取用來訪問HTTP API的代理類 GitHub github = Feign.builder() .decoder(new GsonDecoder()) .requestInterceptor(new MyInterceptor()) .target(GitHub.class, "https://api.github.com"); } }
默認(rèn)情況下,F(xiàn)eign 訪問 HTTP API 時,如果拋出IOException,它會認(rèn)為是短暫的網(wǎng)絡(luò)異常而發(fā)起重試,這時,F(xiàn)eign 會使用默認(rèn)的重試器feign.Retryer.Default(最多重試 5 次),如果不想啟用重試,則可以選擇另一個重試器feign.Retryer.NEVER_RETRY。當(dāng)然,我們也可以自定義。
奇怪的是,F(xiàn)eign 通過重試器的 continueOrPropagate(RetryableException e)方法是否拋出RetryableException來判斷是否執(zhí)行重試,為什么不使用 true 或 false 來判斷呢?
注意,重試器是用來判斷是否執(zhí)行重試,自身不包含重試的邏輯。
public class MyRetryer implements Retryer { int attempt = 0; @Override public void continueOrPropagate(RetryableException e) { // 如果把RetryableException拋出,則不會繼續(xù)重試 // 否則繼續(xù)重試 if(attempt++ >= 3) {// 重試三次 throw e; } } @Override public Retryer clone() { return this; } } public class MyApp { public static void main(String... args) { // 獲取用來訪問HTTP API的代理類 GitHub github = Feign.builder() .decoder(new GsonDecoder()) .retryer(new MyRetryer()) //.retryer(Retryer.NEVER_RETRY) // 不重試 .exceptionPropagationPolicy(ExceptionPropagationPolicy.UNWRAP) .target(GitHub.class, "https://api.github.com"); } }
感謝你能夠認(rèn)真閱讀完這篇文章,希望小編分享的“怎么使用原生的Feign”這篇文章對大家有幫助,同時也希望大家多多支持億速云,關(guān)注億速云行業(yè)資訊頻道,更多相關(guān)知識等著你來學(xué)習(xí)!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。