基于Spring cloud ribbon实现多版本控制

在咱们使用spring mvc单体架构时， 咱们能够经过uri，或者请求头作多版本路由，虽然同一个功能须要维护多个版本的接口，可是对于系统而言，不会由于新增一个接口版本而影响到老用户。当咱们使用spring cloud构建微服务平台时，也但愿能作到这一点，然而spring cloud并无提供这个功能。

在spring cloud的微服务体系中，大可能是使用eureka作为注册中心，ribbon作为负载均衡，hystrix作为断路器。可是在国内网络中却鲜少关于spring-cloud的接口多版本控制的开源项目，而在国内，spring cloud作为愈来愈被创业公司认同的微服务框架，多版本控制的需求也愈来愈明显，因而就有了fm-cloud-bamboo这个多版本控制的项目。

多版本控制

该项目是在spring-cloud-ribbon的基础上进行扩展，以实现接口的多个版本的调用及负载均衡，支持feign方式和断路器(spring-cloud-hystrix)。

场景

在spring cloud微服务体系中，服务的请求来源无外乎两个方面：

• 来源1： 
  外部请求经过网关(zuul)转发而来。
• 来源2： 
  内部服务之间的调用请求。

不论网关转发过来的请求，仍是内部服务调用过来的请求，都须要ribbon作负载均衡，因此能够扩展ribbon的负载均衡策略从而实现不一样版本的请求转发到不一样的服务实例上。 

网关的转发过程是:zuul > hystrix > ribbon 
内部服务调用的过程有两种: 
RestTemplate > hystrix > ribbon 
Feign > hystrix > ribbon

而其中hystrix有一个线程池隔离的能力，会建立另外一个线程去请求服务，拥有更好的控制并发访问量、以及服务降级等能力，可是会出现一个问题，就是线程变量(ThreadLocal)的传递问题，这能够经过com.netflix.hystrix.strategy.concurrency.HystrixRequestVariableDefault对象解决。

代码设计

虽然整个项目实现起来代码量很多， 可是在接口设计上， 却只有三个简单的接口负责数据传递，路由的逻辑依然是封装在实现了IRule接口的实现类中(后面分析)。

• BambooRibbonConnectionPoint： 
  这个接口是负责将bamboo跟ribbon链接起来的，将请求的信息， 以及根据业务须要添加的一些路由信息，和获取请求接口的目标版本，还有触发执行LoadBanceRequestTrigger等，都是由该接口的实现类DefaultRibbonConnectionPoint负责实现。 
  

• RequestVersionExtractor: 
  这个接口负责获取请求须要访问的目标接口的版本。好比有些接口版本是放在路径上，如:/v1/api/test/get。也有放在uri参数中:/api/test/get?v=1。也有可能放到header中，因此在bamboo抽象出来一个接口， 具体的实现由开发者根据业务去实现。

• LoadBalanceRequestTrigger: 
  Ribbon请求的触发器，在ribbon请求发起时， 会被执行。这个接口有三个方法，分别是判断是否须要执行的方法(shouldExecute)，以及请求以前执行(before)和请求完成以后执行(after)，若是出现异常，after方法依然会被执行。

代码实现

上面三个接口只是简单的实现了获取请求的目标版本、触发ribbon请求的触发器，以及将信息向下一步传递。在这一段中，将介绍如何与zuul、feign、RestTemplate以及ribbon和hystrix衔接起来。

• RestTemplate衔接 
  ClientHttpRequestInterceptor是RestTemplate的拦截器接口，能够经过这个接口添加bamboo的逻辑， 从而将RestTemplate和bamboo衔接起来。 
  BambooClientHttpRequestIntercptor是ClientHttpRequestInterceptor接口的实现类，它加入了bamboo的逻辑。 
  

• Feign衔接 
  BambooFeignClient类实现了feign.Client接口， 该类是一个代理类，主要的Feign的调用逻辑依然由被代理的类去执行，在该类中添加了bamboo的逻辑，从而将Feign和bamboo衔接起来。 
  

• Zuul衔接 
  实现两个ZuulFilter接口，分别是pre和post类型，将bamboo的逻辑加入其中。Pre类型的ZuulFilter获取请求信息，并执行LoadBalanceRequestTrigger#before方法。Post类型的ZuulFilter执行LoadBalanceRequestTrigger#after方法，并清除存在ThradLocal中的相关信息。 
  

• Hystrix衔接 
  Hystrix实现降级、断路器等功能，可是在使用线程池隔离时，ThreadLocal存储的信息如何传递下去呢?使用HystrixRequestVariableDefault能够解决这个问题。能够查看com.netflix.hystrix.strategy.concurrency包下的HystrixContexSchedulerAction、HystrixContextCallable、HystrixContextRunnable，它们都有一段相同功能的代码 
  
  parentThreadState也是一个HystrixRequestContext对象，它是在hystrix建立线程以前的，也就是处理http请求的线程的HystrixRequestContext对象，咱们通常也是维护这个对象。在使用线程池隔离时，hystrix会将parentThreadState中的信息复到到新线程中，实现跨线程的数据传递，从而在后面的逻辑中能够获取到parentThreadState中维护的信息，包括ribbon的路由信息。在bamboo中，将一步骤的逻辑放到BambooRequestContext中，将BambooRequestContext实例自己传递下去。 
  

• Ribbon 路由规则 
  Bamboo中的BambooZoneAvoidanceRule继承了ZoneAvoidanceRule,因此它会有ZvoidanceRule的一切特性，在此基础上，还加入了版本过滤的逻辑，这个逻辑主要是由BambooApiVersionPredicate实现。从BambooRequestContext中获取请求的接口的版本，若是有该没有获取到版本，就返回true;若是有获取到版本，就获取服务实例的metadata中的version信息，并进行匹配校验，返回结果。 
  

使用指导

在使用多版本控制时，须要修改服务提供方的两个文件，分别是pom.xml和application.yaml。

1. 将bamboo-start项目添加到maven中。 
   
2. 在application.yaml中添加versions属性，标明服务支持哪些版本。 
   
   在服务消费方，只须要在pom.xml添加bamboo-starter到maven中便可。

在一个名为eureka-client的项目中加入1,2两个步骤， 启动服务。网关作为服务消费方，在pom.xml中加入fm-cloud-starter-bamboo, 并在application.yaml中加入zuul的配置： 

启动服务后，访问http://localhost:10002/gateway/client/api/test/get?version=2 会返回数据，由于eureka-client支持version=2 

若是访问http://localhost:10002/gateway/client/api/test/get?version=3 会报错， 由于找不到支持版本3的服务实例 

项目地址

https://github.com/saleson/fm-cloud/tree/master/fm-cloud/fm-cloud-plugins/fm-cloud-bamboo