Alibaba微服務元件 - Feign

阿新 • • 發佈：2022-04-11

JAVA 專案中如何實現介面呼叫？

Httpclient

HttpClient 是 Apache Jakarta Common 下的子專案，用來提供高效的、最新的、功能豐富的，支援 Http 協議的客戶端程式設計工具包，並且它支援 HTTP 協議最新版本和建議。HttpClient相比傳統 JDK 自帶的 URLConnection，提升了易用性和靈活性，使客戶端傳送 HTTP 請求變得容易，提高了開發的效率。

Okhttp

一個處理網路請求的開源專案，是安卓端最火的輕量級框架，由 Square 公司貢獻，用於替代HttpUrlConnection 和 Apache HttpClient。OkHttp 擁有簡潔的 API、高效的效能，並支援多種協議（HTTP/2 和 SPDY）

HttpURLConnection

HttpURLConnection 是 Java 的標準類，它繼承自 URLConnection，可用於向指定網站傳送GET 請求、POST 請求。HttpURLConnection 使用比較複雜，不像 HttpClient 那樣容易使用。

RestTemplate WebClient

RestTemplate 是 Spring 提供的用於訪問 Rest 服務的客戶端，RestTemplate 提供了多種便捷訪問遠端 HTTP 服務的方法，能夠大大提高客戶端的編寫效率。上面介紹的是最常見的幾種呼叫介面的方法，我們下面要介紹的方法比上面的更簡單、方便，它就是 Feign。

1. 什麼是Feign

Feign是Netflix開發的宣告式、模板化的HTTP客戶端，其靈感來自Retrofit、JAXRS-2.0以及WebSocket。Feign可幫助我們更加便捷、優雅地呼叫HTTP API。
Feign支援多種註解，例如Feign自帶的註解或者JAX-RS註解等。
Spring Cloud openfeign對Feign進行了增強，使其支援Spring MVC註解，另外還整合了Ribbon和Nacos，從而使得Feign的使用更加方便

1.1 優勢

Feign可以做到使用 HTTP 請求遠端服務時就像呼叫本地方法一樣的體驗，開發者完全感知不到這是遠端方法，更感知不到這是個 HTTP 請求。它像 Dubbo 一樣，consumer 直接呼叫介面方法呼叫 provider，而不需要通過常規的 Http Client 構造請求再解析返回資料。它解決了讓開發者呼叫遠端介面就跟呼叫本地方法一樣，無需關注與遠端的互動細節，更無需關注分散式環境開發。

2. Spring Cloud Alibaba快速整合OpenFeign

2.1 引入依賴

<!--openfeign 遠端呼叫-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2.2 編寫呼叫介面+@FeignClient註解

package com.xiexie.order.feign;

import com.xiexie.order.config.FeignConfig;
import feign.Param;
import feign.Request;
import feign.RequestLine;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @Description 新增feign介面和方法
 * name: 指定呼叫rest介面所對應的服務名
 * path: 指定呼叫rest介面所在的stockController所對應的@requestMapping
 * configuration: 如果想針對某個或某些服務進行openFeign呼叫，去掉@Configuration註解，並在此宣告
 * @Date 2022-04-11 15:06
 * @Author xie
 */
@FeignClient(name = "stock-server", path = "/stock", configuration = FeignConfig.class)
public interface StockFeignService {

    @RequestMapping("/reduct")
    public String reduct();

    /**
     * 在openFeign中必須要指定引數名 @PathVariable("id")
     *
     * @param id
     * @return java.lang.String
     */
    @RequestMapping("/{id}")
    public String get(@PathVariable("id") Integer id);

    /**
     * 使用原生feign註解
     *
     * @param id
     * @return java.lang.String
     */
    //@RequestLine("GET /{id}")
    //public String get(@Param("id") Integer id);

    /**
     * 使用原生feign註解
     *
     * @param id
     * @return java.lang.String
     */

}

2.3 呼叫端在啟動類上新增@EnableFeignClients註解

package com.xiexie.order;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

/**
 * @Description
 * @Date 2022-04-07 14:52
 * @Author xie
 */
@SpringBootApplication
@EnableDiscoveryClient // 後面版本中可以不加這個註解
@EnableFeignClients
public class OrderApplication {

    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }

    @Bean
    @LoadBalanced // 負載均衡器 預設採用ribbon的輪詢方式（在做微服務的時候必須要加此註解）
    public RestTemplate restTemplate(RestTemplateBuilder builder) {
        RestTemplate restTemplate = builder.build();
        return restTemplate;
    }
}

2.4 發起呼叫，像呼叫本地方式一樣呼叫遠端服務

package com.xiexie.order.controller;

import com.xiexie.order.feign.StockFeignService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

/**
 * @Description
 * @Date 2022-04-07 14:46
 * @Author xie
 */
@RestController
@RequestMapping("/order")
public class OrderController {

    @Autowired
    private RestTemplate restTemplate;

    @Autowired
    private StockFeignService stockFeignService;

    @RequestMapping("/add")
    public String add() {
        System.out.println("下單成功");

        //String msg = restTemplate.getForObject("http://localhost:8011/stock/reduct", String.class);

        //String msg = restTemplate.getForObject("http://stock-server/stock/reduct", String.class);

        String reduct = stockFeignService.reduct();
        String get = stockFeignService.get(1);

        return "Hello order add " + reduct + get;
    }
}

3. Spring Cloud Feign的自定義配置及使用

Feign 提供了很多的擴充套件機制，讓使用者可以更加靈活的使用。

3.1 日誌配置

有時候我們遇到 Bug，比如介面呼叫失敗、引數沒收到等問題，或者想看看呼叫效能，就需要配置 Feign 的日誌了，以此讓 Feign 把請求資訊輸出來

3.1.1 定義一個配置類，指定日誌級別

package com.xiexie.order.config;

import com.xiexie.order.interceptor.feign.CustomFeignInterceptor;
import feign.Contract;
import feign.Logger;
import feign.Request;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Description OpenFeign配置類
 * <p>
 * 全域性配置：當使用@Configuration，會將配置作用於所有的服務提供方
 * 區域性配置：如果只想針對某一個或某些服務進行配置，就不需要加@Configuration註解
 * @Date 2022-04-11 14:44
 * @Author xie
 */
@Configuration
public class FeignConfig {

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

    /**
     * 修改契約配置，支援Feign原生的註解
     *
     * @return feign.Contract
     */
    //@Bean
    //public Contract feignContract() {
    //    return new feign.Contract.Default();
    //}

    /**
     * 設定超時時間
     * @return feign.Request.Options
     */
    //@Bean
    //public Request.Options options() {
    //    return new Request.Options(5000, 10000);
    //}

    /**
     * 自定義攔截器
     * @return com.xiexie.order.interceptor.feign.CustomFeignInterceptor
     */
    //@Bean
    //public CustomFeignInterceptor customFeignInterceptor() {
    //    return new CustomFeignInterceptor();
    //}

}

通過原始碼可以看到日誌等級有 4 種，分別是：

NONE【效能最佳，適用於生產】：不記錄任何日誌（預設值）。
BASIC【適用於生產環境追蹤問題】：僅記錄請求方法、URL、響應狀態程式碼以及執行時間。
HEADERS：記錄BASIC級別的基礎上，記錄請求和響應的header。
FULL【比較適用於開發及測試環境定位問題】：記錄請求和響應的header、body和元資料。

3.1.2 區域性配置（兩種方式）如下：程式碼或者配置檔案

區域性配置，讓呼叫的微服務生效，在@FeignClient 註解中指定使用的配置類
指定configuration = FeignConfig.class

package com.xiexie.order.feign;

import com.xiexie.order.config.FeignConfig;
import feign.Param;
import feign.Request;
import feign.RequestLine;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @Description 新增feign介面和方法
 * name: 指定呼叫rest介面所對應的服務名
 * path: 指定呼叫rest介面所在的stockController所對應的@requestMapping
 * configuration: 如果想針對某個或某些服務進行openFeign呼叫，去掉@Configuration註解，並在此宣告
 * @Date 2022-04-11 15:06
 * @Author xie
 */
@FeignClient(name = "stock-server", path = "/stock", configuration = FeignConfig.class)
public interface StockFeignService {

    @RequestMapping("/reduct")
    public String reduct();

    /**
     * 在openFeign中必須要指定引數名 @PathVariable("id")
     *
     * @param id
     * @return java.lang.String
     */
    @RequestMapping("/{id}")
    public String get(@PathVariable("id") Integer id);

    /**
     * 使用原生feign註解
     *
     * @param id
     * @return java.lang.String
     */
    //@RequestLine("GET /{id}")
    //public String get(@Param("id") Integer id);

    /**
     * 使用原生feign註解
     *
     * @param id
     * @return java.lang.String
     */
}

在yml配置檔案中執行 Client 的日誌級別才能正常輸出日誌，格式是"logging.level.feign介面包路徑=debug"

# springboot的預設日誌級別是info, feign的debug日誌級別就不會輸出（針對feign的介面包進行debug日誌輸出）
logging:
  level:
    com.xiexie.order.feign: debug

# 指定區域性配置，針對某一個或某些服務進行配置
feign:
  client:
    config:
      # 指定服務
      stock-server:
        # feign日誌區域性配置
        loggerLevel: BASIC

3.2 契約配置

Spring Cloud 在 Feign 的基礎上做了擴充套件，使用 Spring MVC 的註解來完成Feign的功能。原生的 Feign 是不支援 Spring MVC 註解的，如果你想在 Spring Cloud 中使用原生的註解方式來定義客戶端也是可以的，通過配置契約來改變這個配置，Spring Cloud 中預設的是 SpringMvcContract。

3.2.1 修改契約配置，支援Feign原生的註解（兩種方式）如下：程式碼或者配置檔案

注意：修改契約配置後，OrderFeignService 不再支援springmvc的註解，需要使用Feign原生的註解

/**
 * 修改契約配置，支援Feign原生的註解
 *
 * @return feign.Contract
 */
@Bean
public Contract feignContract() {
    return new feign.Contract.Default();
}

也可以通過yml配置契約

# 指定區域性配置，針對某一個或某些服務進行配置
feign:
  client:
    config:
      # 指定服務
      stock-server:
        # feign日誌區域性配置
        loggerLevel: BASIC
        # 設定為預設的契約（還原成原生註解）
        contract: feign.Contract.Default()
        # 連線超時時間，預設5s
        connectTimeout: 5000
        # 讀取超時時間，預設2s
        readTimeout: 2000
        # 配置攔截器
        requestInterceptors[0]:
          com.xiexie.order.interceptor.feign.CustomFeignInterceptor

3.2.2 使用Feign原生的註解

/**
 * 使用原生feign註解
 *
 * @param id
 * @return java.lang.String
 */
@RequestLine("GET /{id}")
public String get(@Param("id") Integer id);

3.3 自定義攔截器實現認證邏輯（兩種方式）如下：程式碼或者配置檔案

package com.xiexie.order.interceptor.feign;

import feign.RequestInterceptor;
import feign.RequestTemplate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.UUID;

/**
 * @Description 自定義openFeign攔截器
 * @Date 2022-04-11 16:11
 * @Author xie
 */
public class CustomFeignInterceptor implements RequestInterceptor {

    private static final Logger LOGGER = LoggerFactory.getLogger(CustomFeignInterceptor.class);

    public void apply(RequestTemplate requestTemplate) {
        // 可以做攔截處理，比如認證或者日誌等
        LOGGER.info("feign攔截器");
        String access_token = UUID.randomUUID().toString();
        requestTemplate.header("Authorization", access_token);
        //requestTemplate.uri();
    }
}

package com.xiexie.order.config;

import com.xiexie.order.interceptor.feign.CustomFeignInterceptor;
import feign.Contract;
import feign.Logger;
import feign.Request;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Description OpenFeign配置類
 * <p>
 * 全域性配置：當使用@Configuration，會將配置作用於所有的服務提供方
 * 區域性配置：如果只想針對某一個或某些服務進行配置，就不需要加@Configuration註解
 * @Date 2022-04-11 14:44
 * @Author xie
 */
@Configuration
public class FeignConfig {

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

    /**
     * 修改契約配置，支援Feign原生的註解
     *
     * @return feign.Contract
     */
    //@Bean
    //public Contract feignContract() {
    //    return new feign.Contract.Default();
    //}

    /**
     * 設定超時時間
     * @return feign.Request.Options
     */
    //@Bean
    //public Request.Options options() {
    //    return new Request.Options(5000, 10000);
    //}

    /**
     * 自定義攔截器
     * @return com.xiexie.order.interceptor.feign.CustomFeignInterceptor
     */
    @Bean
    public CustomFeignInterceptor customFeignInterceptor() {
        return new CustomFeignInterceptor();
    }
}

通過yml配置

feign:
  client:
    config:
      # 指定服務
      stock-server:
        # feign日誌區域性配置
        loggerLevel: BASIC
        # 設定為預設的契約（還原成原生註解）
        # contract: feign.Contract.Default()
        # 連線超時時間，預設5s
        connectTimeout: 5000
        # 讀取超時時間，預設2s
        readTimeout: 2000
        # 配置攔截器
        requestInterceptors[0]:
          com.xiexie.order.interceptor.feign.CustomFeignInterceptor

3.4 超時時間配置（兩種方式）如下：程式碼或者配置檔案

通過 Options 可以配置連線超時時間和讀取超時時間，Options 的第一個引數是連線的超時時間（ms），預設值是 2s；第二個是請求處理的超時時間（ms），預設值是 5s。

/**
 * 設定超時時間
 * @return feign.Request.Options
 */
@Bean
public Request.Options options() {
    return new Request.Options(5000, 10000);
}

通過yml配置

feign:
  client:
    config:
      # 指定服務
      stock-server:
        # feign日誌區域性配置
        loggerLevel: BASIC
        # 設定為預設的契約（還原成原生註解）
        # contract: feign.Contract.Default()
        # 連線超時時間，預設5s
        connectTimeout: 5000
        # 讀取超時時間，預設2s
        readTimeout: 2000
        # 配置攔截器
        requestInterceptors[0]:
          com.xiexie.order.interceptor.feign.CustomFeignInterceptor

充補充說明： Feign的底層用的是Ribbon，但超時時間以Feign配置為準

3.5 客戶端元件配置

Feign 中預設使用 JDK 原生的 URLConnection 傳送 HTTP 請求，我們可以整合別的元件來替換掉 URLConnection，比如 Apache HttpClient，OkHttp。
Feign發起呼叫真正執行邏輯：feign.Client#execute （擴充套件點）

3.5.1 配置Apache HttpClient

<!--替換Feign預設URLConnection為HttpClient-->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.7</version>
</dependency>
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
    <version>10.1.0</version>
</dependency>

修改yml配置，將 Feign 的 Apache HttpClient啟用：

feign:
  httpclient:
    # feign 使用 Apache HttpClient 可以忽略，預設開啟
    enabled: true

關於配置可參考原始碼： org.springframework.cloud.openfeign.FeignAutoConfiguration

測試：呼叫會進入feign.httpclient.ApacheHttpClient#execute

3.5.2 配置 OkHttp

<!--替換Feign預設URLConnection為okhttp-->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-okhttp</artifactId>
</dependency>

修改yml配置，將 Feign 的 Apache okhttp啟用：

feign:
  httpclient:
    # feign 使用 Apache HttpClient 可以忽略，預設開啟
    enabled: false
  # feign 使用 okhttp
  okhttp:
    enabled: true

關於配置可參考原始碼： org.springframework.cloud.openfeign.FeignAutoConfiguration

測試：呼叫會進入feign.okhttp.OkHttpClient#execute

3.6 GZIP 壓縮配置

開啟壓縮可以有效節約網路資源，提升介面效能，我們可以配置 GZIP 來壓縮資料：

feign:
  httpclient:
    # feign 使用 Apache HttpClient 可以忽略，預設開啟
    enabled: false
  # feign 使用 okhttp
  okhttp:
    enabled: true
  # 配置 GZIP 來壓縮資料
  compression:
    request:
      enabled: true
      # 配置壓縮的型別
      mime-types: text/xml,application/xml,application/json
      # 最小壓縮值
      min-request-size: 2048
    response:
      enabled: true

注意：只有當 Feign 的 Http Client 不是 okhttp3 的時候，壓縮才會生效，配置原始碼在FeignAcceptGzipEncodingAutoConfiguration

核心程式碼就是 @ConditionalOnMissingBean（type="okhttp3.OkHttpClient"），表示Spring BeanFactory 中不包含指定的 bean 時條件匹配，也就是沒有啟用 okhttp3 時才會進行壓縮配置。