Spring Cloud Netflix多語言/非java語言支持之Spring Cloud Netflix Sidecar
Polyglot support with Sidecar
前言
公司有一個調研要做,調研如何將Python語言提供的服務納入到Spring Cloud管理中來,找到了這個Sidecar組件,發現官方提供一篇文檔,對其進行相關翻譯。
聲明:如果在閱讀時發現有誤或有更好的翻譯方式,請及時通知給我。
Sidecar簡介
根據我的理解,Sidecar是作為一個代理的服務來間接性的讓其他語言可以使用Eureka等相關組件。通過與Zuul的來進行路由的映射,從而可以做到服務的獲取,然后可以使用Ribbon,Feign對服務進行消費,以及對Config Server的間接性調用。(此段內容僅個人理解,只作為參考,歡迎討論,同時有誤請及時指正。)
正文翻譯
以下是原文翻譯,原文地址:https://cloud.spring.io/spring-cloud-netflix/multi/multi__polyglot_support_with_sidecar.html
你是否想要在非jvm的語言中利用(間接性使用)Eureka,Ribbon以及Config Server?Spring Cloud Netflix Sidecar的設計靈感來自Netflix Prana。它包含一個簡單的http api去獲取一個已知服務的所有實例(例如主機和端口)。你也可以通過嵌入的Zuul代理(Zuul中有一個代理功能)對代理的服務進行調用,Zuul從Eureka服務注冊中心獲取所有的路由記錄(route entries)。通過host發現(host lookup)或者Zuul代理可以直接訪問Spring Cloud Config。非jvm需要應該實現一個健康檢查,Sidecar能夠以此來報告給Eureka注冊中心該應用是up還是down狀態。
在你的項目中使用Sidecar,需要添加依賴,其group為org.springframework.cloud
,artifact id為spring-cloud-netflix-sidecar
。(這是以maven依賴的方式)
啟用Sidecar,創建一個Spring Boot應用程序,並在在應用主類上加上@EnableSidecar
注解。該注解包含@EnableCircuitBreaker
, @EnableDiscoveryClient
以及@EnableZuulProxy
。Run the resulting application on the same host as the non-jvm application. (這句不太會翻譯,我的理解為:在與非jvm應用程序相同的主機上運行生成的應用程序)注:這里的生成應該是通過代理產生的服務。
配置Sidecar,在application.yml中添加sidecar.port
和sidecar.health-uri
。sidecar.port
屬性是非jre程序監聽的端口號,這就是Sidecar可以正確注冊應用到Eureka的原因。sidecar.health-uri
是非jre應用提供的一個對外暴露的可訪問uri地址,在該地址對應的接口中需要實現一個模仿Spring Boot健康檢查指示器的功能。它需要返回如下的json文檔。(注:通過返回一個json,其用status字段來標識你的應用的服務狀態,是up還是down,sidecar會將該狀態報告給eureka注冊中心從而實現你的服務的狀態可用情況。簡單的說就是用來控制sidecar代理服務的狀態!)
health-uri-document.
health-uri-document.(heal-uri指向的接口地址需要返回的json文檔)
{
"status":"UP"
}
這里是一個Sidecar應用程序的application.yml配置示例:
application.yml
server:
port: 5678
spring:
application:
name: sidecar
sidecar:
port: 8000
health-uri: http://localhost:8000/health.json
API DiscoveryClient.getInstances()
所對應的訪問方式是/hosts/{serviceId}
,這是訪問/hosts/customers
后的響應示例,它返回了兩個不同主機上的實例(可以看到主機地址不一樣)。
非jre程序可以訪問這個api,如果sidecar的端口號為5678,那么完整url則為:http://localhost:5678/hosts/{serviceId}
.
/hosts/customers.
[
{
"host": "myhost",
"port": 9000,
"uri": "http://myhost:9000",
"serviceId": "CUSTOMERS",
"secure": false
},
{
"host": "myhost2",
"port": 9000,
"uri": "http://myhost2:9000",
"serviceId": "CUSTOMERS",
"secure": false
}
]
Zuul代理會自動為每個在Eureka注冊中心上的服務添加路由到/serviceId
上,所以上面那個customers的服務可以通過/customers
訪問。非Jre應用可以通過http://localhost:5678/customers
來訪問Customer Service(假設Sidecar的監聽端口為5678)
如果Config Server注冊到了Eureka,非jre應用就可以通過Zuul代理訪問它。如果ConfigServer的serviceId為configserver
並且Sidecar的端口為5678,那么可以通過http://localhost:5678/configserver 的方式來訪問Config Server。
非Jvm應用可以利用Config Server的能力來獲取Config Server返回的YAML文檔,通過訪問 http://sidecar.local.spring.io:5678/configserver/default-master.yml 就可以獲取到類似下面的YAML文檔結果
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8761/eureka/
password: password
info:
description: Spring Cloud Samples
url: https://github.com/spring-cloud-samples
上面是介紹,這里是一篇具體的使用案例:《使用Sidecar將Node.js引入Spring Cloud
》