完美整合Spring Cloud与异构微服务的框架!Spring Cloud Wii开源啦!
Spring Cloud Wii是一个用来 快速整合 Spring Cloud 与 异构微服务 的框架,灵感来自 Spring Cloud Netflix Sidecar[1] 。目前支持的服务发现组件:
•Nacos•Consul
术语
异构微服务
非Spring Cloud应用,统称异构微服务。比如你的遗留项目,或者非JVM应用。
“完美整合”的三层含义
•享受服务发现的优势•有负载均衡•有断路器
为什么要造这个轮子?
原因有两点:
•Spring Cloud子项目 Spring Cloud Netflix Sidecar
是可以快速整合异构微服务的。然而,Sidecar只支持使用Eureka作为服务发现,如果使用其他服务发现组件就抓瞎了。•Sidecar是基于Zuul 1.x的,Spring Cloud官方明确声明,未来将会逐步淘汰Zuul。今年早些时候,我有给Spring Cloud官方提出需求,希望官方实现一个基于Spring Cloud Gateway的新一代Sidecar,然而官方表示并没有该计划。详见:https://github.com/spring-cloud/spring-cloud-gateway/issues/735[2]
既然没有,索性自己写了。
原理
•Wii根据配置的异构微服务的IP、端口等信息,将异构微服务的IP/端口注册到服务发现组件上 。•Wii实现了 健康检查 ,Wii会定时检测异构微服务是否健康。如果发现异构微服务不健康,Wii会自动将代表异构微服务的Wii实例下线;如果异构微服务恢复正常,则会自动上线。最长延迟是30秒,详见 WiiChecker#check
。
要求
•【必须】你的异构微服务需使用HTTP通信。这一点严格来说不算要求,因为Spring Cloud本身就是基于HTTP的;•【可选】如果微服务配置了 wii.health-check-url
,则表示开启了Wii的健康检查,此时,你的异构微服务需实现健康检查(可以是空实现,只要暴露一个端点,返回类似 {"status": "UP"}
的字符串即可)。
使用示例
•如使用Nacos作为服务发现组件,详见 examples/spring-cloud-wii-example-nacos
•如使用Consul作为服务发现组件,详见 examples/spring-cloud-wii-example-consul
示例代码(以Nacos服务发现为例)
1 依赖管理:Spring Cloud Alibaba版本必须是2.1.x+,否则会报错。这主要是因为Spring Cloud Alibaba修改了包名命名…不同版本的类名包结构不同,而Wii使用了Nacos的类,所以版本必须保持一致。
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>2.1.0.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
2 加依赖:
<dependency>
<groupId>com.itmuch</groupId>
<artifactId>spring-cloud-wii</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
3 写配置:
server:
port: 8070
spring:
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true
application:
name: wii-node-service
wii:
# 异构微服务的IP
ip: 127.0.0.1
# 异构微服务的端口
port: 8060
# 异构微服务的健康检查URL
health-check-url: http://localhost:8060/health.json
配置比较简单,就是把Wii注册到Nacos上,然后添加了几行wii的配置。
异构微服务
我这里准备了一个NodeJS编写的简单微服务。
var http = require('http');
var url = require("url");
var path = require('path');
// 创建server
var server = http.createServer(function(req, res) {
// 获得请求的路径
var pathname = url.parse(req.url).pathname;
res.writeHead(200, { 'Content-Type' : 'application/json; charset=utf-8' });
// 访问http://localhost:8060/,将会返回{"index":"欢迎来到首页"}
if (pathname === '/') {
res.end(JSON.stringify({ "index" : "欢迎来到首页" }));
}
// 访问http://localhost:8060/health,将会返回{"status":"UP"}
else if (pathname === '/health.json') {
res.end(JSON.stringify({ "status" : "UP" }));
}
// 其他情况返回404
else {
res.end("404");
}
});
// 创建监听,并打印日志
server.listen(8060, function() {
console.log('listening on localhost:8060');
});
测试
测试1:Spring Cloud微服务完美调用异构微服务
你的Spring Cloud项目整合Ribbon,只需构建 http://wii-node-service
就可以请求到异构微服务了。
示例:
Ribbon请求 http://wii-node-service/
会请求到 http://localhost:8060/
以此类推。
至于断路器,正常为你的Spring Cloud微服务整合Sentinel或者Hystirx、Resilience4J即可 。
测试2:异构微服务完美调用Spring Cloud微服务
由于Wii基于Spring Cloud Gateway,而网关自带转发能力啊。
示例:
如果你有一个Spring Cloud微服务叫做 spring-cloud-microservice
,那么NodeJS应用只需构建 http://localhost:8070/spring-cloud-microservice/**
,Wii就会把请求转发到 spring-cloud-microservice
的 /**
。
而Spring Cloud Gateway是整合了Ribbon的,所以实现了负载均衡;Spring Cloud Gateway还可以整合Sentinel或者Hystirx、Resilience4J,所以也带有了断路器。
Wii优缺点分析
Wii的设计和Sidecar基本一致,优缺点和Sidecar的优缺点也是一样的。
优点:
•接入简单,几行代码就可以将异构微服务整合到Spring Cloud生态•不侵入原代码
缺点:
•每接入一个异构微服务实例,都需要额外部署一个Wii实例,增加了部署成本(虽然这个成本在Kubernetes环境中几乎可以忽略不计(只需将Wii实例和异构微服务作为一个Pod部署即可));•异构微服务调用Spring Cloud微服务时,本质是把Wii当网关在使用,经过了一层转发,性能有一定下降。不过一般认为这个性能损耗是可以接受的。和快速接入带来的好处相比,这点性能损耗算啥。
GitHub地址
点击文末左下角 "阅读原文",即可前往!欢迎Star、follow。
干货分享
•001:《Java并发与高并发解决方案》学习笔记;•002:《深入JVM内核——原理、诊断与优化》学习笔记;•003:《Java面试宝典》•004:《Docker开源书》•005:《Kubernetes开源书》•006:《DDD速成(领域驱动设计速成)》•007:全部•008:加技术讨论群
近期热文
••••••
References
[1]
Spring Cloud Netflix Sidecar: https://github.com/spring-cloud/spring-cloud-netflix/tree/master/spring-cloud-netflix-sidecar[2]
: https://github.com/spring-cloud/spring-cloud-gateway/issues/735
想知道更多?长按/扫码关注我吧↓↓↓喜欢就点个"在看"呗^_^