欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

一文教你如何使用原生的Feign

 更新時(shí)間：2021年10月30日 12:20:49   作者：子月生  
Feign使得 Java HTTP 客戶(hù)端編寫(xiě)更方便,Feign 靈感來(lái)源于Retrofit、JAXRS-2.0和WebSocket,這篇文章主要給大家介紹了如何使用原生的Feign的相關(guān)資料,需要的朋友可以參考下

什么是Feign

Feign 是由 Netflix 團(tuán)隊(duì)開(kāi)發(fā)的一款基于 Java 實(shí)現(xiàn)的 HTTP client，借鑒了 Retrofit、 JAXRS-2.0、WebSocket 等類(lèi)庫(kù)。通過(guò) Feign，我們可以像調(diào)用方法一樣非常簡(jiǎn)單地訪問(wèn) HTTP API。這篇博客將介紹如何使用原生的 Feign，注意，是原生的，不是經(jīng)過(guò) Spring 層層封裝的 Feign。

補(bǔ)充一下，在 maven 倉(cāng)庫(kù)中搜索 feign，我們會(huì)看到兩種 Feign： OpenFeign Feign 和 Netflix Feign。它們有什么區(qū)別呢？簡(jiǎn)單地說(shuō)，OpenFeign Feign 的前身就是 Netflix Feign，因?yàn)?Netflix Feign 從 2016 年開(kāi)始就不維護(hù)了，所以建議還是使用 OpenFeign Feign。

為什么使用Feign

為什么要使用HTTP client

首先，因?yàn)?Feign 本身是一款 HTTP client，所以，這里先回答：為什么使用 HTTP client？

假設(shè)不用 HTTP client，我們?cè)L問(wèn) HTTP API 的過(guò)程大致如下。是不是相當(dāng)復(fù)雜呢？直接操作 socket 已經(jīng)非常麻煩了，我們還必須在熟知 HTTP 協(xié)議的前提下自行完成報(bào)文的組裝和解析，代碼的復(fù)雜程度可想而知。

那么，這個(gè)過(guò)程是不是可以更簡(jiǎn)單一些呢？

我們可以發(fā)現(xiàn)，在上面的圖中，紅框的部分是相對(duì)通用的，是不是可以把這些邏輯封裝起來(lái)？基于這樣的思考，于是就有了 HTTP client（根據(jù)類(lèi)庫(kù)的不同，封裝的層次會(huì)有差異）。

所以，為什么要使用 HTTP client 呢？簡(jiǎn)單地說(shuō)，就是為了讓我們更方便地訪問(wèn) HTTP API。

為什么要使用Feign

HTTP client 的類(lèi)庫(kù)還有很多，例如 Retrofit、JDK 自帶的 HttpURLConnection、Apache HttpClient、OkHttp、Spring 的 RestTemplate，等等。我很少推薦說(shuō)要使用哪種具體的類(lèi)庫(kù)，如果真的要推薦 Feign 的話，主要是由于它優(yōu)秀的擴(kuò)展性（不是一般的優(yōu)秀，后面的使用例子就可以看到）。

如何使用Feign

關(guān)于如何使用 Feign，官方給出了非常詳細(xì)的文檔，在我看過(guò)的第三方類(lèi)庫(kù)中，算是比較少見(jiàn)的。

本文用到的例子也是參考了官方文檔。

項(xiàng)目環(huán)境說(shuō)明

os：win 10

jdk：1.8.0_231

maven：3.6.3

IDE：Spring Tool Suite 4.6.1.RELEASE

引入依賴(lài)

這里引入 gson，是因?yàn)槿腴T(mén)例子需要有一個(gè) 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>

入門(mén)例子

入門(mén)例子中使用 Feign 來(lái)訪問(wèn) github 的接口獲取 Feign 這個(gè)倉(cāng)庫(kù)的所有貢獻(xiàn)者。

通過(guò)下面的代碼可以發(fā)現(xiàn)，F(xiàn)eign 本質(zhì)上是使用了動(dòng)態(tài)代理來(lái)生成訪問(wèn) HTTP API 的代碼，定義 HTTP API 的過(guò)程有點(diǎn)像在定義 advice。

// 定義HTTP API
interface GitHub {
    
    @RequestLine("GET /repos/{owner}/{repo}/contributors")
    // @RequestLine(value = "GET /repos/{owner}/{repo}/contributors", decodeSlash = false)// 測(cè)試轉(zhuǎn)義"/"、"+"
    // @RequestLine("GET /repos/{owner:[a-zA-Z]*}/{repo}/contributors")// 測(cè)試正則校驗(yàn)
    // @Headers("Accept: application/json") // 測(cè)試添加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) {
        // 獲取用來(lái)訪問(wèn)HTTP API的代理類(lèi)
        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í)參數(shù)等
                .target(GitHub.class, "https://api.github.com");

        // 像調(diào)用方法一樣訪問(wèn)HTTP API
        github.contributors("OpenFeign", "feign").stream()
            .map(contributor -> contributor.login + " (" + contributor.contributions + ")")
            .forEach(System.out::println);
    }
}

個(gè)性化配置

除了簡(jiǎn)單方便之外，F(xiàn)eign 還有一個(gè)很大的亮點(diǎn)，就是有相當(dāng)優(yōu)秀的擴(kuò)展性，幾乎什么都可以自定義。下面是官方給的一張圖，基本涵蓋了 Feign 可以擴(kuò)展的內(nèi)容。每個(gè)擴(kuò)展支持都有一個(gè)對(duì)應(yīng)的適配包，例如，更換解碼器為 jackson 時(shí)，需要引入io.github.openfeign:feign-jackson的適配包。

更換為Spring的注解

在入門(mén)例子中，我們使用 Feign 自帶的注解來(lái)定義 HTTP API。但是，對(duì)于習(xí)慣了 Spring 注解的許多人來(lái)說(shuō)，無(wú)疑需要增加學(xué)習(xí)成本。我們自然會(huì)問(wèn)，F(xiàn)eign 能不能支持 Spring 注解呢？答案是肯定的。Feign 不但能支持 Spring 注解，還可以支持 JAX-RS、SOAP 等等。

下面就是使用 Sping 注解定義 HTTP API 的例子。注意，pom 文件中要引入 io.github.openfeign:feign-spring4 的依賴(lài)。

// 定義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) {
        // 獲取用來(lái)訪問(wèn)HTTP API的代理類(lèi)
        GitHub github = Feign.builder()
                .decoder(new GsonDecoder())
                .contract(new SpringContract())// 自定義contract
                .target(GitHub.class, "https://api.github.com");
    }
}

自定義解碼器和編碼器

在入門(mén)例子中，我們使用 gson 來(lái)解析 json。那么，如果我想把它換成 jackson 行不行？Feign 照樣提供了支持。

注意，pom 文件中要引入 io.github.openfeign:feign-jackson 的依賴(lài)。

public class MyApp {

    public static void main(String... args) {
        // 獲取用來(lái)訪問(wèn)HTTP API的代理類(lèi)
        GitHub github = Feign.builder()
                .decoder(new JacksonDecoder()) // 自定義解碼器
                .encoder(new JacksonEncoder()) // 自定義編碼器
                .target(GitHub.class, "https://api.github.com");
    }
}

自定義內(nèi)置的HTTP client

接下來(lái)的這個(gè)自定義就更厲害了。Feign 本身作為一款 HTTP client，竟然還可以支持其他 HTTP client。

這里用 OkHttp 作例子。注意，pom 文件中要引入 io.github.openfeign:feign-okhttp 的依賴(lài)。

public class MyApp {

    public static void main(String... args) {
        // 獲取用來(lái)訪問(wèn)HTTP API的代理類(lèi)
        GitHub github = Feign.builder()
                .decoder(new GsonDecoder())
                .client(new OkHttpClient())// 自定義client
                .target(GitHub.class, "https://api.github.com");
    }
}

自定義攔截器

我們?cè)L問(wèn)外部接口時(shí)，有時(shí)需要帶上一些特定的 header，例如，應(yīng)用標(biāo)識(shí)、token，我們可以通過(guò)兩種方式實(shí)現(xiàn)：一是使用注解定義 HTTP API，二是使用攔截器（更常用）。下面的例子中，使用攔截器給請(qǐng)求添加 token 請(qǐng)求頭。

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) {
        // 獲取用來(lái)訪問(wèn)HTTP API的代理類(lèi)
        GitHub github = Feign.builder()
                .decoder(new GsonDecoder())
                .requestInterceptor(new MyInterceptor())
                .target(GitHub.class, "https://api.github.com");
    }
}

自定義重試器

默認(rèn)情況下，F(xiàn)eign 訪問(wèn) HTTP API 時(shí)，如果拋出IOException，它會(huì)認(rèn)為是短暫的網(wǎng)絡(luò)異常而發(fā)起重試，這時(shí)，F(xiàn)eign 會(huì)使用默認(rèn)的重試器feign.Retryer.Default（最多重試 5 次），如果不想啟用重試，則可以選擇另一個(gè)重試器feign.Retryer.NEVER_RETRY。當(dāng)然，我們也可以自定義。

奇怪的是，F(xiàn)eign 通過(guò)重試器的 continueOrPropagate(RetryableException e)方法是否拋出RetryableException來(lái)判斷是否執(zhí)行重試，為什么不使用 true 或 false 來(lái)判斷呢？

注意，重試器是用來(lái)判斷是否執(zhí)行重試，自身不包含重試的邏輯。

public class MyRetryer implements Retryer {
    
    int attempt = 0;

    @Override
    public void continueOrPropagate(RetryableException e) {
        // 如果把RetryableException拋出，則不會(huì)繼續(xù)重試
        // 否則繼續(xù)重試
        if(attempt++ >= 3) {// 重試三次
            throw e;
        }
    }

    @Override
    public Retryer clone() {
        return this;
    }
}
public class MyApp {

    public static void main(String... args) {
        // 獲取用來(lái)訪問(wèn)HTTP API的代理類(lèi)
        GitHub github = Feign.builder()
                .decoder(new GsonDecoder())
                .retryer(new MyRetryer())
                //.retryer(Retryer.NEVER_RETRY) // 不重試
                .exceptionPropagationPolicy(ExceptionPropagationPolicy.UNWRAP)
                .target(GitHub.class, "https://api.github.com");
    }
}

結(jié)語(yǔ)

以上，基本講完 Feign 的使用方法，其實(shí) Feign 還有其他可以擴(kuò)展的東西，例如，斷路器、監(jiān)控等等。感興趣的話，可以自行分析。

到此這篇關(guān)于如何使用原生的Feign的文章就介紹到這了,更多相關(guān)使用原生的Feign內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

參考資料

Feign github

相關(guān)源碼請(qǐng)移步：https://github.com/ZhangZiSheng001/feign-demo

相關(guān)文章

最新評(píng)論