转载

Springcloud实现服务多版本控制的示例代码

需求

小程序新版本上线需要审核，如果有接口新版本返回内容发生了变化，后端直接上线会导致旧版本报错，不上线审核又通不过。

之前是通过写新接口来兼容，但是这样会有很多兼容代码或者冗余代码，开发也不容易能想到这一点，经常直接修改了旧接口，于是版本控制就成了迫切的需求。

思路

所有请求都是走的网关，很自然的就能想到在网关层实现版本控制。首先想到的是在ZuulFilter过滤器中实现，前端所有请求都在请求头中增加一个version的header,然后进行匹配。但是这样只能获取到前端的版本，不能匹配选择后端实例。

查询资料后发现应该在负载均衡的时候实现版本控制。同样是前端所有请求都在请求头中增加一个version的header，后端实例都配置一个版本的tag。

实现

首先需要说明的是我选择的控制中心是consul，网关是zuul。

负载均衡策略被抽象为IRule接口，项目默认情况下使用的IRule的子类ZoneAvoidanceRule extends PredicateBasedRule，我们需要实现一个PredicateBasedRule的子类来替换ZoneAvoidanceRule。

PredicateBasedRule需要实现一个过滤的方法我们就在这个方法里实现版本控制，过滤后就是默认的负载均衡策略了，默认是轮询。

/**
   * Method that provides an instance of {@link AbstractServerPredicate} to be used by this class.
   *
   */
  public abstract AbstractServerPredicate getPredicate();

VersionPredicate

我们可以看到PredicateBasedRule的getPredicate()方法需要返回一个AbstractServerPredicate实例，这个实例具体定义了版本控制的业务逻辑。代码如下：

private static class VersionPredicate extends AbstractServerPredicate {

    private static final String VERSION_KEY = "version";

    @Override
    public boolean apply(@NullableDecl PredicateKey predicateKey) {
      if (predicateKey == null) {
        return true;
      }
      RequestContext ctx = RequestContext.getCurrentContext();
      HttpServletRequest request = ctx.getRequest();
      String version = request.getHeader(VERSION_KEY);
      if (version == null) {
        return true;
      }
      ConsulServer consulServer = (ConsulServer) predicateKey.getServer();
      if (!consulServer.getMetadata().containsKey(VERSION_KEY)) {
        return true;
      }
      return consulServer.getMetadata().get(VERSION_KEY).equals(version);
    }
  }

首先来了解下负载均衡的过程。一个请求到达网关后会解析出对应的服务名，然后会获取到该服务的所有可用实例，之后就会调用我们的过滤方法过滤出该请求可用的所有服务实例，最后进行轮询负载均衡。

PredicateKey类就是上层方法将可用实例Server和loadBalancerKey封装后的类。版本控制的业务逻辑如下：

判断predicateKey是否为null，是的话直接返回true，true代表该实例可用
通过RequestContext获取当前请求实例HttpServletRequest，再通过请求实例获取请求头里的版本号
判断前端请求是否带了版本号，没带的话就不进行版本控制直接返回true
获取服务实例并转换成ConsulServer类，这里是因为我用的注册中心是consul，选择其他的可自行转换成对应的实现类
判断服务实例是否设置了版本号（例：spring.cloud.consul.discovery.tags="version=1.0.0"），可以看到我们是用consul的tags实现的版本控制，可以设置不同的tag实现很多功能
同样服务实例没有设置版本号的话也是直接返回true
最后进行版本匹配，返回匹配成功的服务实例

注意的点

最终实现如下：

/**
 * @author Yuicon
 */
@Slf4j
public class VersionRule extends PredicateBasedRule {

  private final CompositePredicate predicate;

  public VersionRule() {
    super();
    this.predicate = createCompositePredicate(new VersionPredicate(),
        new AvailabilityPredicate(this, null));
  }

  @Override
  public AbstractServerPredicate getPredicate() {
    return this.predicate;
  }

  private CompositePredicate createCompositePredicate(VersionPredicate versionPredicate,
                            AvailabilityPredicate availabilityPredicate) {
    return CompositePredicate.withPredicates(versionPredicate, availabilityPredicate)
        .build();
  }

  private static class VersionPredicate extends AbstractServerPredicate {

    private static final String VERSION_KEY = "version";

    @Override
    public boolean apply(@NullableDecl PredicateKey predicateKey) {
      if (predicateKey == null) {
        return true;
      }
      RequestContext ctx = RequestContext.getCurrentContext();
      HttpServletRequest request = ctx.getRequest();
      String version = request.getHeader(VERSION_KEY);
      if (version == null) {
        return true;
      }
      ConsulServer consulServer = (ConsulServer) predicateKey.getServer();
      if (!consulServer.getMetadata().containsKey(VERSION_KEY)) {
        return true;
      }
      log.info("id is {}, header is {}, metadata is {}, result is {}",
          consulServer.getMetaInfo().getInstanceId(),
          version, consulServer.getMetadata().get(VERSION_KEY),
          consulServer.getMetadata().get(VERSION_KEY).equals(version));
      return consulServer.getMetadata().get(VERSION_KEY).equals(version);
    }
  }
}

原本我是加上@Component注解后在本地直接测试通过了。可是在更新到生产服务器后却出现大部分请求都找不到的服务实例的错误，搞的我一头雾水，赶紧回滚到原来的版本。

查询了很多资料后才找到一篇文章，发现需要一个Config类来声明替换原有的负载均衡策略类。代码如下：

@RibbonClients(defaultConfiguration = RibbonGatewayConfig.class)
@Configuration
public class RibbonGatewayConfig {

  @Bean
  public IRule versionRule() {
    return new VersionRule();
  }
}

到此为止版本控制算是实现成功了。

结尾

在实际使用过程中发现还是有很多问题。比如前端版本号是全局唯一的，当其中一个服务升级了版本号，就需要将所有服务都升级到该版本号，即使代码没有任何更改。比较好的解决方案是前端根据不同服务传递不同的版本号，不过前端反馈实现困难。

还有个妥协的方案，就是利用配置中心来对具体服务是否开启版本控制进行配置，因为现在的需求只是一小段时间里需要版本控制，小程序审核过后就可以把旧服务实例关了。大家如果有更好的方案欢迎讨论。

到此这篇关于Springcloud实现服务多版本控制的示例代码的文章就介绍到这了,更多相关Springcloud多版本控制内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

时间：2020-05-15

SpringCloud Finchley+Spring Boot 2.0 集成Consul的方法示例(1.2版本)

概述: Spring Boot 2.0相对于之前的版本,变化还是很大的.首先对jdk的版本要求已经不能低于1.8,其次依赖的spring的版本也是最新版本5.0,并集成了功能强大的webflux等. SpringCloud Finchley 版本的升级也带来了全新组件:Spring Cloud Function 和 Spring Cloud Gateway ,前者致力于函数式编程模块的整合,后者则是网关netflix zuul 的替换组件. 1)需要的依赖: <?xml version="

Spring Cloud升级最新Finchley版本的所有坑

Spring Boot 2.x 已经发布了很久,现在 Spring Cloud 也发布了基于 Spring Boot 2.x 的 Finchley 版本,现在一起为项目做一次整体框架升级. 升级前 => 升级后 Spring Boot 1.5.x => Spring Boot 2.0.2 Spring Cloud Edgware SR4 => Spring Cloud Finchley.RELEASE Eureka Server Eureka Server 依赖更新升级前: <

spring boot和spring cloud之间的版本关系

什么是Spring Boot Spring Boot简化了基于Spring的应用开发,通过少量的代码就能创建一个独立的.产品级别的Spring应用. Spring Boot为Spring平台及第三方库提供开箱即用的设置,这样你就可以有条不紊地开始.多数Spring Boot应用只需要很少的Spring配置. Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程.该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的

SpringCloud版本问题报错及解决方法

问题 springboot 集成springcloud时常常由于版本问题而报错,如下: com.sun.jersey.api.client.ClientHandlerException: java.net.ConnectException: Connection refused: connect 或者 com.netflix.discovery.shared.transport.TransportException: Cannot execute request on any known ser

SpringCloud Edgware.SR3版本中Ribbon的timeout设置方法

概述 Spring Cloud中,客户端的负载均衡使用的是Ribbon,Ribbon的超时时间默认很短,需要进行调整. Spring Cloud版本 Edgware.SR3 Ribbon timeout设置 Ribbon的默认timeout时间是1秒,这个可以在RibbonClientConfiguration类中看到. public class RibbonClientConfiguration { public static final int DEFAULT_CONNECT_TIMEOUT

Android编程中TextView字体属性设置方法(大小、字体、下划线、背景色)

本文实例讲述了Android编程中TextView字体属性设置方法(大小.字体.下划线.背景色).分享给大家供大家参考,具体如下: import android.content.Context; import android.graphics.Color; import android.text.SpannableString; import android.text.Spanned; import android.text.style.AbsoluteSizeSpan; import andr

基于TabLayout中的Tab间隔设置方法(实例讲解)

TabLayout和ViewPager搭配使用,是有很多方便性,但是TabLayout这东西还是有很多被人吐槽的地方. 这里只讲怎么设置tab之间的间隔,网上找了一堆方法,什么padding和margin的啥都没用,没办法,想用TabLayout只能自己想办法了.效果如下: 一.实现方法,既然这东西不好设置,那就直接在背景上做点事情,布局代码如下: <android.support.design.widget.TabLayout xmlns:app="http://schemas.andr

VMware中虚拟机的NAT设置方法

最近重新转了windows8,然后再win8下想装一个Ubuntu的虚拟机,于是先装了VMware9再安装了ubuntu,但是发现虚拟机上不了网,于是在网上找了很多关于vmware的nat设置的文章来看,终于解决了这个问题,现在将其写出来,希望对大家有用. 一.设施windows下的网络设置. 1.进入本网络的属性 2.设置共享,共享的网卡为VMware network adapter VMnet8 二.对VMware中的NAT进行设置 1. 2 点击添加 3. Host Port为宿主机的端

Python3.x版本中新的字符串格式化方法

我们知道Python3.x引入了新的字符串格式化语法.不同于Python2.x的复制代码代码如下: "%s %s "%(a,b) Python3.x是复制代码代码如下: "{0} {1}".format(a,b) 今天我在用MySQLdb时,需要用带参数的复制代码代码如下: cursor.execute(sql,param) 语句来完成SQL操作.被其他文章的陈旧说法给误导,用了复制代码代码如下: cursor.execute('insert int

Apache中php.ini的设置方法

例如: 复制代码代码如下: 1 LoadModule php5_module "D:/wamp/bin/php/php5.4.3/php5apache2_2.dll"2 PHPIniDir "D:/wamp/bin/php/php5.4.3" 这样Apache使用的php.ini和PHP的DLL都是加载的5.4.3版本的.让IIS使用环境变量中的php.ini. 另外在wamp启动的时候,经常会提示类似 "无法定位程序输入点 php_checkuid 于

window中oracle环境变量设置方法分享

window server中Oracle的环境变量设置 1.右击"我的电脑"->选择"属性"->选择"高级"->单击"环境变量"2.选择"Path"这一行,单击"编辑",在"Path"的变量值文本框的最后面先加入一个分号":",然后再分号后面加入sqlplus文件的目录路径,如"C:/Program Files/orac

Serv-U中虚拟目录的设置方法(文字+图文)

Serv-U虚拟目录设置文字版: 一.用Serv-U时,如果使用虚拟路径映射(虚拟目录),那么就只需设定某个文件夹为主目录,然后把想要分享文件映射到该目录下,可以有效提高利用效率,好处不言自明:不用每次把文件内容复制到主目录下.访客通过FTP就可以打开主人设定的文件资料--即使是在不同盘符下的. 要增加虚拟目录,以用户(admin)的主目录为F:/admin,想要能通过ftp://IP/admin的格式能访问到在E:/Download/中的内容,则需要为它添加虚拟目录.操作步骤如下: (1)在管

Bash Shell中忽略大小写的设置方法

大多数人在使用 Bash 时,都会对其进行改造,因为默认的设置真的好难用- 参考以下 ~/.inputrc 设置: 复制代码代码如下: # do not show hidden files in the list set match-hidden-files off # auto complete ignoring case set show-all-if-ambiguous on set completion-ignore-case on "/ep": history-sear

在MySQL中修改密码及访问限制的设置方法详解

由于其源码的开放性及稳定性,且与网站流行编挥镅 PHP的完美结合,现在很多站点都利用其当作后端数据库,使其获得了广泛应用.处于安全方面的考虑,需要为每一用户赋于对不同数据库的访问限制,以满足不同用户的要求.下面就分别讨论,供大家参考. 一.MySQL修改密码方法总结首先要说明一点的是:一般情况下,修改MySQL密码是需要有mysql里的root权限的,这样一般用户是无法更改密码的,除非请求管理员帮助修改. 方法一使用phpMyAdmin (图形化管理MySql数据库的

原文 https://www.zhangshengrong.com/p/AvN6YgK8am/

正文到此结束