快捷導(dǎo)航

Springcloud實(shí)現(xiàn)服務(wù)多版本控制的示例代碼

更新時間：2020年05月15日 11:20:23 作者：Yuicon

這篇文章主要介紹了Springcloud實(shí)現(xiàn)服務(wù)多版本控制的示例代碼，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

需求

小程序新版本上線需要審核，如果有接口新版本返回內(nèi)容發(fā)生了變化，后端直接上線會導(dǎo)致舊版本報錯，不上線審核又通不過。

之前是通過寫新接口來兼容，但是這樣會有很多兼容代碼或者冗余代碼，開發(fā)也不容易能想到這一點(diǎn)，經(jīng)常直接修改了舊接口，于是版本控制就成了迫切的需求。

思路

所有請求都是走的網(wǎng)關(guān)，很自然的就能想到在網(wǎng)關(guān)層實(shí)現(xiàn)版本控制。首先想到的是在ZuulFilter過濾器中實(shí)現(xiàn)，前端所有請求都在請求頭中增加一個version的header,然后進(jìn)行匹配。但是這樣只能獲取到前端的版本，不能匹配選擇后端實(shí)例。

查詢資料后發(fā)現(xiàn)應(yīng)該在負(fù)載均衡的時候?qū)崿F(xiàn)版本控制。同樣是前端所有請求都在請求頭中增加一個version的header，后端實(shí)例都配置一個版本的tag。

實(shí)現(xiàn)

首先需要說明的是我選擇的控制中心是consul，網(wǎng)關(guān)是zuul。

負(fù)載均衡策略被抽象為IRule接口，項目默認(rèn)情況下使用的IRule的子類ZoneAvoidanceRule extends PredicateBasedRule，我們需要實(shí)現(xiàn)一個PredicateBasedRule的子類來替換ZoneAvoidanceRule。

PredicateBasedRule需要實(shí)現(xiàn)一個過濾的方法我們就在這個方法里實(shí)現(xiàn)版本控制，過濾后就是默認(rèn)的負(fù)載均衡策略了，默認(rèn)是輪詢。

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

VersionPredicate

我們可以看到PredicateBasedRule的getPredicate()方法需要返回一個AbstractServerPredicate實(shí)例，這個實(shí)例具體定義了版本控制的業(yè)務(wù)邏輯。代碼如下：

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);
    }
  }

首先來了解下負(fù)載均衡的過程。一個請求到達(dá)網(wǎng)關(guān)后會解析出對應(yīng)的服務(wù)名，然后會獲取到該服務(wù)的所有可用實(shí)例，之后就會調(diào)用我們的過濾方法過濾出該請求可用的所有服務(wù)實(shí)例，最后進(jìn)行輪詢負(fù)載均衡。

PredicateKey類就是上層方法將可用實(shí)例Server和loadBalancerKey封裝后的類。版本控制的業(yè)務(wù)邏輯如下：

判斷predicateKey是否為null，是的話直接返回true，true代表該實(shí)例可用
通過RequestContext獲取當(dāng)前請求實(shí)例HttpServletRequest，再通過請求實(shí)例獲取請求頭里的版本號
判斷前端請求是否帶了版本號，沒帶的話就不進(jìn)行版本控制直接返回true
獲取服務(wù)實(shí)例并轉(zhuǎn)換成ConsulServer類，這里是因為我用的注冊中心是consul，選擇其他的可自行轉(zhuǎn)換成對應(yīng)的實(shí)現(xiàn)類
判斷服務(wù)實(shí)例是否設(shè)置了版本號（例：spring.cloud.consul.discovery.tags="version=1.0.0"），可以看到我們是用consul的tags實(shí)現(xiàn)的版本控制，可以設(shè)置不同的tag實(shí)現(xiàn)很多功能
同樣服務(wù)實(shí)例沒有設(shè)置版本號的話也是直接返回true
最后進(jìn)行版本匹配，返回匹配成功的服務(wù)實(shí)例

注意的點(diǎn)

最終實(shí)現(xiàn)如下：

/**
 * @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注解后在本地直接測試通過了。可是在更新到生產(chǎn)服務(wù)器后卻出現(xiàn)大部分請求都找不到的服務(wù)實(shí)例的錯誤，搞的我一頭霧水，趕緊回滾到原來的版本。

查詢了很多資料后才找到一篇文章，發(fā)現(xiàn)需要一個Config類來聲明替換原有的負(fù)載均衡策略類。代碼如下：

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

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

到此為止版本控制算是實(shí)現(xiàn)成功了。

結(jié)尾

在實(shí)際使用過程中發(fā)現(xiàn)還是有很多問題。比如前端版本號是全局唯一的，當(dāng)其中一個服務(wù)升級了版本號，就需要將所有服務(wù)都升級到該版本號，即使代碼沒有任何更改。比較好的解決方案是前端根據(jù)不同服務(wù)傳遞不同的版本號，不過前端反饋實(shí)現(xiàn)困難。

還有個妥協(xié)的方案，就是利用配置中心來對具體服務(wù)是否開啟版本控制進(jìn)行配置，因為現(xiàn)在的需求只是一小段時間里需要版本控制，小程序?qū)徍诉^后就可以把舊服務(wù)實(shí)例關(guān)了。大家如果有更好的方案歡迎討論。

到此這篇關(guān)于Springcloud實(shí)現(xiàn)服務(wù)多版本控制的示例代碼的文章就介紹到這了,更多相關(guān)Springcloud多版本控制內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: