從零開始搭建spring-cloud(3) ----feign
Feign簡介
Feign是Netflix開發的宣告式、模組化的HTTP客戶端,其靈感來自Retrofit、JAXRS-2.0以及WebSocket。Feign可幫組我們更加便捷、優雅的呼叫HTTP API。
在Spring Cloud中,使用Feign非常簡單——建立一個介面,並在介面上新增一些註解,程式碼就完成了。Feign支援多種註解,例如Feign自帶的註解或者JAX-RS註解等。
Spring Cloud對feign進行了增強,並整合了Ribbon和Eureka,從而讓Feign的使用更加便捷。
Feign是一個宣告式的偽Http客戶端,它使得寫Http客戶端變得更簡單。使用Feign,只需要建立一個介面並註解。它具有可插拔的註解特性,可使用Feign 註解和JAX-RS註解。Feign支援可插拔的編碼器和解碼器。Feign預設集成了Ribbon,並和Eureka結合,預設實現了負載均衡的效果。
簡而言之:
- Feign 採用的是基於介面的註解
- Feign 整合了ribbon
準備工作
繼續之前的工作,啟動Eureka server,埠為8080,啟動spring-cloud-eureka-provider-A-1、啟動spring-cloud-eureka-provider-A-2,埠分別為8081、8082
建立一個feign服務
新建一個spring-boot工程,取名為spring-cloud-feign,在它的pom檔案引入Feign的起步依賴spring-cloud-starter-feign、Eureka的起步依賴spring-cloud-starter-eureka、Web的起步依賴spring-boot-starter-web,程式碼如下:
<?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"> <modelVersion>4.0.0</modelVersion> <groupId>com.vincent</groupId> <artifactId>spring-cloud-feign</artifactId> <version>1.0-SNAPSHOT</version> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>2.1.4.RELEASE</version> <scope>import</scope> <type>pom</type> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Greenwich.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> </dependencies> </project>
在工程的配置檔案application.properties檔案,指定程式名為service-feign,埠號為8083,服務註冊地址為http://127.0.0.1:8080/eureka/,程式碼如下:
# 註冊中心的註冊地址
eureka.client.service-url.defaultZone=http://127.0.0.1:8080/eureka/
# 服務名稱--呼叫的時候根據名稱來呼叫該服務的方法
spring.application.name=service-feign
server.port=8083
在程式的啟動類App ,加上@EnableFeignClients註解開啟Feign的功能:
package com.vincent;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.openfeign.EnableFeignClients;
/**
* Created by vincent on 2019-6-18 21:56
*/
@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
定義一個feign介面,通過@ FeignClient(“服務名”),來指定呼叫哪個服務。比如在程式碼中呼叫了service-provider-A服務的“/user/{name}”介面,程式碼如下:
@FeignClient("service-provider-A")
public interface FeignService {
@GetMapping("/user/{name}")
Map<String,Object> getUser(@PathVariable("name") String userName);
}
在Web層的controller層,對外暴露一個"/user/{name}"的API介面,通過上面定義的Feign客戶端FeighService 來消費服務。程式碼如下:
public class UserController {
@Autowired
FeignService feignService;
@GetMapping("/user/{userName}")
public Map<String, Object> getUser(@PathVariable("userName") String userName){
Map<String, Object> user = feignService.getUser(userName);
System.out.println(user);
return user;
}
}
啟動程式,多次訪問http://localhost:8083/user/vincent,瀏覽器交替顯示:
{"from":"provider-A-2","id":"vincent"}
{"from":"provider-A-1","id":"vincent"}
Ribbon與Feign的區別
Ribbon
是一個基於 HTTP 和 TCP 客戶端 的負載均衡的工具。
它可以 在客戶端 配置 RibbonServerList(服務端列表),使用 HttpClient 或 RestTemplate 模擬http請求,步驟相當繁瑣。
Feign
Feign 是在 Ribbon的基礎上進行了一次改進,是一個使用起來更加方便的 HTTP 客戶端。
採用介面的方式, 只需要建立一個介面,然後在上面添加註解即可 ,將需要呼叫的其他服務的方法定義成抽象方法即可, 不需要自己構建http請求。
然後就像是呼叫自身工程的方法呼叫,而感覺不到是呼叫遠端方法,使得編寫 客戶端變得非常容易。
類似於 mybatis 的 @Mapper註解 。
spring-cloud-starter-openfeign 裡面已經包含了 spring-cloud-starter-ribbon(Feign 中也使用了 Ribbon)