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

到此為止版本控制算是實現成功了。
 

結尾
 

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

還有個妥協的方案，就是利用配置中心來對具體服務是否開啟版本控制進行配置，因為現在的需求只是一小段時間裡需要版本控制，小程序審核過後就可以把舊服務實例關了。大家如果有更好的方案歡迎討論。