OpenFeign服務介面呼叫
學習地址:https://www.bilibili.com/video/BV18E411x7eT?p=43
OpenFeign
官方文件:https://docs.spring.io/spring-cloud-openfeign/docs/2.2.5.RELEASE/reference/html/
Git:https://github.com/spring-cloud/spring-cloud-openfeign
介紹
-
Feign是一個宣告式WebService客戶端。使用Feign能讓編寫Web Service客戶端更加簡單。
-
它的使用方法是定義一個服務接囗然後在上面添加註釋。Feign也支援可拔插式的編碼器和解碼器。SpringCloud對Feign進行了封裝,使其支援Spring MVC標準註解和HttpMessageConvertersoFeign可以與Eureka和Ribbon組合亻吏用以支援負載均衡
優勢
-
Feign旨在使編寫Java Http客戶端變得更容易。
- 前面在使用Ribbon+RestTempIate時,利用RestTemplate對http請求的封裝處理,形成了一套模版化的呼叫方法。但是在實際開發中,由於對服務依賴的呼叫可能不止一處,往往一個接囗會被多處呼叫,所以通常都會針對每個微服務自行封裝一些客戶端類來包裝這些依賴服務的呼叫。所以,Feign在此基礎上做了進一步封裝,由他來幫助我們定義和實現依賴服務介面的定義。在Feign的實現下,我們只需建立一個介面並使用註解的方式來配置它(以前是Dao接囗上面標註Mappe主解,現在是一個微服務接囗上面標汪一個Feign註解即可),即可完成對服務提供方的介面繫結,簡化了使ESpringcloudRibbon時,自動封裝服務呼叫客戶端的開發量。
-
Feign整合成了Ribbon
- 利用Ribbon維護了Payment的服務列表資訊,並目通過輪詢實現了客戶端的負載均衡。而與Ribbon不同的是,通過feign只需要定義服務繫結接囗目以宣告式的方法,優雅而簡單的實現了服務呼叫
-
Feign和OpenFeign兩者區別
OpenFeign使用步驟
cloud-consumer-feign-order80
-
建module
-
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>springcloud2020</artifactId> <groupId>com.nuc.springcloud</groupId> <version>1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>cloud-consumer-feign-order80</artifactId> <!--openfeign--> <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.nuc.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>
- YML
server:
port: 80
eureka:
client:
register-with-eureka: false
service-url:
defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka
- 主啟動類
@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain80 {
public static void main(String[] args) {
SpringApplication.run(OrderFeignMain80.class,args);
}
}
- 業務類
- 介面類
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {
@GetMapping(value = "/payment/get/{id}")
public CommonResult getPaymentById(@PathVariable("id") Long id);
}
- 控制層Controller
@RestController
@Slf4j
public class OrderFeignController {
@Resource
private PaymentFeignService paymentFeignService;
@GetMapping(value = "/consumer/payment/get/{id}")
public CommonResult getPaymentById(@PathVariable("id") Long id){
return paymentFeignService.getPaymentById(id);
}
}
- 測試
先啟動2個eureka叢集7001/7002
再啟動2個微服務8001/8002
啟動OpenFeign啟動
http://localhost/consumer/payment/get/31
Feign自帶負載均衡配置項
- 總結
OpenFeign超時控制
超時設定,故意設定超時演示出錯情況
- 服務提供方8001故意寫暫停程式
@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeout() {
try {
TimeUnit.SECONDS.sleep(3);
} catch (InterruptedException e) {
e.printStackTrace();
}
return serverPort;
}
- 服務消費方80新增超時方法PaymentFeignService
@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeout();
- 服務消費方80新增超時方法OrderFeignController
@GetMapping(value = "/consumer/payment/feign/timeout")
public String paymentFeignTimeout(){
return paymentFeignService.paymentFeignTimeout();
}
- 測試
http://localhost/consumer/payment/feign/timeout
OpenFeign預設等待一秒鐘,超過後報錯
預設Feign客戶端只等待一秒,但服務端處理需要超過1秒鐘,導致Feign客戶端不想等待了,直接返回報錯。為了避免這樣的情況,有時候我們需要設定Feign客戶端的超時控制。
#設定feign客戶端超時時間(OpenFeign預設支援ribbon)
ribbon:
#指的是建立連線所用的時間,適用於網路正常的情況下,兩端連線所用的時間
ReadTimeout: 5000
#指的是建立連線後從伺服器讀取到可用資源所用的時間
ConnectTimeout: 5000
設定5秒,訪問成功
OpenFeign日誌列印功能
Feign提供了日誌列印功能,我們可以通過配置來調整日誌級別,從而瞭解Feign中Http請求的細節。對Feign介面的呼叫情況進行監控和輸出
-
NONE:預設的,不顯示任何日誌;
-
BASIC:僅記錄請求方法、URL、相應狀態碼及執行時間;
-
HEADERS:除了BASIC中定義的資訊之外,還有請求和相應的頭資訊
-
FULL:除了HEADERS中的定義的資訊之外,還有請求和相應的正文及元資料
- 配置日誌bean
@Configuration
public class FeignConfig {
@Bean
Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
}
- yml配置
logging:
level:
#feign日誌以什麼級別監控哪個介面
com.nuc.springcloud.service.PaymentFeignService: debug
- 測試