Spring Cloud Gray - 微服务灰度中间件

介绍

Spring Cloud Gray 是一套开源的微服务灰度路由解决方案，它由spring-cloud-gray-client，spring-cloud-gray-client-netflix 和 spring-cloud-tray-server，spring-cloud-gray-webui组成。
spring-cloud-gray-client定义了一套灰度路由决策模型，灰度信息追踪模型，以及和spring-cloud-gray-server的基本通信功能。
spring-cloud-gray-client-netflix在spring-cloud-gray-client的基础上集成了微服务注册中心eureka，扩展ribbon的负载均衡规则，提供了对zuul,feign,RestTemplate的灰度路由能力，并且无缝支持hystrix线程池隔离。
spring-cloud-gray-server负责灰度决策、灰度追踪等信息的管理以及持久化。
spring-cloud-gray-webui提供操作界面。

钉钉交流群

Demo

点击查看

在管控端数据库执行一条insert语名：

insert into `user` ( `user_id`, `account`, `name`, `password`, `roles`, `status`, `create_time`, `operater`, `update_time`, `operator`, `operate_time`) values ( 'admin', 'admin', 'Admin', 'e7a57e51394e91cba19deca3337bfab0', 'admin', '1', null, null, null, 'admin', '2019-08-09 00:11:12');

这是添加管理员账号的，用户名:admin 密码:abc123

版本信息

项目版本	srpingcloud版本	springboot版本
A.1.1.0	Edgware.SR6	1.5.22.RELEASE
B.0.0.1	Finchley.SR4	2.0.9.RELEASE
C.0.0.1-SNAPHOST	Greenwich.SR2	2.1.7.RELEASE

工程模块

功能模块

模块	描述
spring-cloud-gray-utils	工具包
spring-cloud-gray-core	灰度数据模型/Java Bean定义，client端和server端通用
spring-cloud-gray-client	灰度客户端的核心代码，属于灰度客户端的内核
spring-cloud-gray-client-netflix	灰度客户端与spring cloud netflix集成的代码，与之相关的插件都依赖这个模块
spring-cloud-gray-plugin-webmvc	支撑灰度客户端在spring mvc运行的插件
spring-cloud-gray-plugin-webflux	支撑灰度客户端在spring webfulx运行的插件(B版及以上)
spring-cloud-gray-plugin-eureka	灰度客户端与注册中心eureka集成的插件
spring-cloud-gray-plugin-feign	灰度客户端与openFiegn集成的插件
spring-cloud-gray-plugin-zuul	灰度客户端与zuul 1.0集成的插件
spring-cloud-gray-plugin-gateway	灰度客户端与spring cloud gateway集成的插件(B版及以上)
spring-cloud-gray-plugin-event-stream	灰度客户端与spring cloud stream(rabbitmq)集成的插件
spring-cloud-gray-server	灰度管控端的核心代码
spring-cloud-gray-server-plugin-eureka	灰度管控端与注册中心eureka集成的插件
spring-cloud-gray-server-plugin-event-stream	灰度管控端与spring cloud stream(rabbitmq)集成的插件
spring-cloud-starter-gray-client	灰度客户端starter
spring-cloud-starter-gray-server	灰度管控端starter
spring-cloud-starter-gray-eureka-server	eureka server的灰度插件
spring-cloud-gray-webui	灰度管控端的web界面，vue编写

示例模块

模块	描述
spring-cloud-gray-eureka-sample	eureka server/注册中心
spring-cloud-gray-server-sample	灰度管控端示例，界面是spring-cloud-gray-webui模块
spring-cloud-gray-service-a-sample	服务提供方示例
spring-cloud-gray-service-a1-sample	服务提供方示例
spring-cloud-gray-ervice-b-sample	服务消费方示例
spring-cloud-gray-zuul-sample	zuul网关示例
spring-cloud-gray-gateway-sample	spring-cloud-gateway网关示例(B版及以上)

设计

在微服务架构中，接口的调用通常是服务消费方按照某种负载均衡策略去选择服务实例；但这无法满足线上更特殊化的一些路由逻辑，比如根据一次请求携带的请求头中的信息路由到某一个服务实例上。Spring Cloud Gray正是为此而创建。
在Spring Cloud Gray中定义了几个角色灰度客户端(gray-client)、灰度管控端(gray-server)、注册中心。

注册中心 负责服务的注册和发现。

灰度客户端 灰度的客户端是指依赖了spring-cloud-gray-client的服务，一般是指服务消费方。

灰度管控端 负责灰度信息的管理、持久化等维护工作。

灰度客户端会从灰度管控端拉取一份灰度信息的清单，并在内存中维护这份清单信息，清单中包含服务，服务实例，灰度策略，灰度追踪字段等。 当请求达到网关时，网关就会在灰度追踪中将需要透传的信息记录下来，并将传递给转发的服务实例，后面的接口调用也会按照同样的逻辑将追踪信息透传下去，从而保证所有一个请求在微服务调用链中的灰度路由。
如下图所示：

灰度决策

灰度决策是灰度路由的关键，灰度决策由工厂类创建，工厂类的抽象接口是cn.springcloud.gray.decision.factory.GrayDecisionFactory。
目前已有的灰度决策有：

名称	工厂类	描述
HttpHeader	HttpHeaderGrayDecisionFactory	根据http请求头的字段进行判断
HttpMethod	HttpMethodGrayDecisionFactory	根据http请求方法的字段进行判断
HttpParameter	HttpParameterGrayDecisionFactory	根据http url参数进行判断
HttpTrackHeader	HttpTrackHeaderGrayDecisionFactory	根据灰度追踪记录的http请求头的字段进行判断
HttpTrackParameter	HttpTrackParameterGrayDecisionFactory	根据灰度追踪记录的http url参数进行判断
TraceIpGray	TraceIpGrayDecisionFactory	根据灰度追踪记录的请求ip进行判断
TrackAttribute	TrackAttributeGrayDecisionFactory	根据灰度追踪记录的属性值进行判断
FlowRateGray	FlowRateGrayDecisionFactory	按百分比放量进行判断

灰度追踪

灰度追踪记录的逻辑是由cn.springcloud.gray.request.GrayInfoTracker的实现类实现。
目前已有的灰度追踪有:

名称	实现类	描述
HttpReceive	HttpReceiveGrayInfoTracker	接收调用端传递过来的灰追踪信息
HttpHeader	HttpHeaderGrayInfoTracker	获取http请求的header并记录到灰度追踪的Header中
HttpIP	HttpIPGrayInfoTracker	获取http请求的ip并记录到灰度追踪中
HttpMethod	HttpMethodGrayInfoTracker	获取http请求的请求方法并记录到灰度追踪中
HttpParameter	HttpParameterGrayInfoTracker	获取http请求的url参数并记录到灰度追踪的parameter中
HttpURI	HttpURIGrayInfoTracker	获取http请求的URI并记录到灰度追踪中