转载

Spring cloud 实现服务多版本控制

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

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

思路

所有请求都是走的网关，很自然的就能想到在网关层实现版本控制。首先想到的是在 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();
    }

}
复制代码

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