API網關是系統的唯一入口,調用任何服務的請求都需要經過網關層,最終纔可能到達目標服務,既然是必經之路,那我們可以在網關層進行一些通用的操作,如:認證、鑑權、限流、智能路由、緩存、日誌、監控、超時、熔斷、重試等等,這樣既使整個框架條理清晰,也讓開發者更多注重功能的邏輯實現。
常見的 API 網關項目有:Kong、Tyk、Netflix zuul、Ocelot 等。在 Spring Cloud 中,Zuul 是其核心組件,下面將介紹 .NET Core 中通過 Zuul 來進行統一 API 調用。
搭建 Zuul Server
Eureka Server 的搭建請參考 .NET Core + Spring Cloud:服務註冊與發現
在 IntelliJ IDEA 中新建項目,選 Spring Initializr 完成項目創建
-
在 pom.xml 添加 zuul 和 eureka-client 的依賴,我們將會把 Zuul Server 註冊到 Eureka Server
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-zuul</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency>
-
在啓動類上添加 EnableZuulProxy 註解
@EnableZuulProxy @SpringBootApplication public class EurekaServiceApplication { public static void main(String[] args) { SpringApplication.run(EurekaServiceApplication.class, args); } }
-
修改 application.yml 配置文件(集羣模式通過一個類似 gateway.xxx.com 的域名指向多個 Zuul Server 實例即可)
spring: application: name: zuul-service server: port: 5555 eureka: instance: hostname: server1 # 超過這個時間沒收到心跳就剔除這個服務,這個配置一般爲服務刷新時間配置的三倍,默認90s lease-expiration-duration-in-seconds: 15 # 服務刷新時間,默認30s lease-renewal-interval-in-seconds: 5 client: service-url: defaultZone: http://server1:8001/eureka/,http://server2:8002/eureka/,http://server3:8003/eureka/
-
啓動服務,訪問:http://server1:8001/(請確保 Eureka Server 已啓動),可以發現 Zuul Server 已在 5555 端口啓動
創建 .NET Core 服務
這裏直接基於文章 .NET Core + Spring Cloud:服務註冊與發現 中的測試項目,修改 .NET Core 客戶端服務的配置文件 services:base-service:url
"services": {
"base-service": {
"url": "http://server1:5555/base-service/" // 原來 http://base-service/
}
}
因爲我們的 Zuul Server 是啓動在 server1 的 5555 端口,通過 Zuul 網關調用服務的路由規則是 http://server1:5555/ + {Application 小寫},而基礎服務的 Application名稱爲 BASE-SERVICE,所以 url 設置爲 http://server1:5555/base-service/
測試
訪問 base-service
通過網關的路由地址 http://server1:5555/base-service/ 訪問 api/values 接口,多次請求可測試負載均衡效果
訪問 client-service
通過網關的路由地址 http://server1:5555/client-service/ 訪問 api/values 接口,而配置文件中的 base-service 設置的也是網關地址,所以實際在調用 base-service 也是通過網關