1. 概述
Feign是一個聲明式WebService用戶端。使用Feign可以讓編寫WebService用戶端更加簡單。
它的使用方法是定義一個服務接口然後在上面添加注解。Feign也支援可拔插式的編碼器和解碼器。Spring Cloud對Feign進行了封裝,使其支援了Spring Mvc标準注解和HttpMessageConverters。Feign可以與Eureka和Ribbon組合使用以支援負載均衡。
源碼位址:https://github.com/spring-cloud/spring-cloud-openfeign
1.1 能幹什麼
Feign旨在使編寫Java Http用戶端變得更容易。
前面在使用Ribboon+RestTemplate時,利用RestTemplate對http請求的封裝處理,形成了一套模闆化的調用方法,但是實際開發中,由于對服務依賴的調用可能不止一處,往往一個接口被多處調用,是以通常都會針對每個微服務自行封裝一些用戶端類類包裝這些依賴服務的調用,是以,Feign在此基礎上做了進一步封裝,由它來幫助我們定義和實作依賴服務接口的定義。在Feign的實作下,我們隻需建立一個接口并使用注解的方式來配置它(以前是Dao接口上标注@Mapper注解,現在是一個微服務就扣上面标注一個Feign注解即可)即可完成對服務提供方的接口綁定,簡化了使用Spring cloud Ribbon時,自動封裝服務調用用戶端的開發量。
Feign內建了Ribbon:
利用Ribbon維護了Payment的服務清單資訊,并且通過輪詢實作了用戶端的負載均衡,而與Ribbon不同的是,通過feign隻需要定義服務綁定接口且以聲明式的方法,優雅而簡單的實作了服務調用。
Feign和OpenFeign兩者差別:
Feign | OpenFeign |
---|---|
Feign是Spring Cloud元件中的一個輕量級RESTful的HTTP服務用戶端,Feign内置了Ribbon,用來做用戶端負載均衡,去調用服務注冊中心的服務,Feign的使用方法是:使用Feign的注解定義接口,調用這個接口,就可以調用服務注冊中心的服務 | OpenFeign是Spring Cloud在Feign的基礎上支援了SpringMVC的注解,如@RequestMapping 等等,OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口,并通過動态代理的方式産生實作類,實作類中做負載均衡并調用其他服務 |
- feign:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
</dependency>
- openfeign:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2. OpenFeign使用步驟
2.1 接口+注解
微服務調用接口[email protected]
2.2 建立cloud-consumer-feign-order80
Feign在消費端使用
2.3 pom
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>spring-cloud-demo</artifactId>
<groupId>com.lele.springcloud</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>cloud-consumer-feign-order80</artifactId>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>com.lele.springcloud</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>
2.4 yml
server:
port: 80
eureka:
client:
register-with-eureka: false
service-url:
defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/
2.5 主啟動類
package com.lele.springcloud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;
/**
* @author: lele
* @date: 2021/3/17 7:27
* @description:
*/
@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain80 {
public static void main(String[] args) {
SpringApplication.run(OrderFeignMain80.class, args);
}
}
2.6 業務類
業務邏輯接口[email protected]配置調用provider服務
建立PaymentFeignService接口并新增注解@FeignClient
package com.lele.springcloud.service;
import com.lele.springcloud.entities.CommonResult;
import com.lele.springcloud.entities.Payment;
import feign.Param;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
/**
* @author: lele
* @date: 2021/3/17 7:31
* @description:
*/
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {
@GetMapping(value = "/payment/get/{id}")
CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
}
2.7 控制層Controller
package com.lele.springcloud.controller;
import com.lele.springcloud.entities.CommonResult;
import com.lele.springcloud.entities.Payment;
import com.lele.springcloud.service.PaymentFeignService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
/**
* @author: lele
* @date: 2021/3/17 7:39
* @description:
*/
@RestController
@Slf4j
public class OrderFeignController {
@Resource
private PaymentFeignService paymentFeignService;
@GetMapping(value = "/consumer/payment/get/{id}")
public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id) {
return paymentFeignService.getPaymentById(id);
}
}
2.8 測試
- 先啟動 Eureka 叢集 7001、7002
- 啟動 8001、8002
- 啟動 cloud-consumer-feign-order80
- 通路:http://localhost/consumer/payment/get/1
Feign 自帶負載均衡配置項
3. OpenFeign 逾時控制
- 8001 PaymentController
- 80 PaymentFeignService
- 80 OrderFeignController
- 啟動 7001、7002
- 啟動 8001
-
啟動 feign80
通路: http://localhost/consumer/payment/feign/timeout
OpenFeign預設等待一秒鐘,但是服務端處理需要超過1秒鐘,導緻Feign用戶端不想等待了,直接傳回報錯,為了避免這樣的情況,有時候需要設定Feign用戶端的逾時控制。
yml配置檔案中開啟:
# 設定feign用戶端逾時時間(openfiegn預設支援riboon)
ribbon:
# 建立連接配接所用的時間,适用于網絡狀況正常的情況下,兩端連接配接所用的時間
ReadTimeout: 5000
# 建立連接配接後從伺服器讀取到可用資源所用的時間
ConnectTimeout: 5000
- 重新開機 feign80
- 通路:http://localhost/consumer/payment/feign/timeout
4. OpenFeign日志列印功能
4.1 是什麼
Feign提供了日志列印功能,我們可以通過配置來調整日志級别,進而了解Feign中Http 的請求細節。
即,對Feign接口的調用情況進行監控和輸出。
4.2 日志級别
- NONE:預設的不顯示任何日志;
- BASIC:僅記錄請求方法、URL、響應狀态碼及執行時間;
- HEADERS:除了BASIC中定義的資訊之外,還有請求和響應的頭資訊;
- FULL:除了HEADERS中定義的資訊之外,還有請求和響應的正文及中繼資料;
4.3 配置日志bean
4.4 YML檔案裡需要開啟日志的Feign用戶端
logging:
level:
# feign日志以什麼級别監控哪個接口
com.lele.springcloud.service.PaymentFeignService: debug
通路:http://localhost/consumer/payment/get/1