SpringCloudGateway?Nacos?GitlabRunner全自動灰度服務怎么搭建

這篇文章主要介紹了SpringCloudGateway Nacos GitlabRunner全自動灰度服務怎么搭建的相關知識，內容詳細易懂，操作簡單快捷，具有一定借鑒價值，相信大家閱讀完這篇SpringCloudGateway Nacos GitlabRunner全自動灰度服務怎么搭建文章都會有所收獲，下面我們一起來看看吧。

1 | 業務場景說明

要實現的業務場景：

• 可以根據單個用戶id或者批量用戶id，判斷是否需要灰度該用戶/批量用戶

• 可以根據請求頭字段（可動態設定的任意kv），判斷是否需要走灰度服務

2 | 具體實現方案

這里采用 SpringCloudGateway（SCG） + Nacos + GitlabRunner 來實現整個自動化的灰度發布。

• SCG：統一的流量入口 + 正常/灰度服務選擇分發邏輯處理

• Nacos：loadbalancer 提供方，通過 metadata 維護灰度服務

• GitlabRunner：灰度服務部署的自動化 CICD Pipeline 處理

下面分別從以上這三個組件來搭建。

2.1 | SCG

直接上代碼，通過注釋講解。

• GrayLoadBalancerClientFilter: 自定義灰度服務負載均衡過濾器

/**
 * 通過GrayLoadBalancer過濾實例
 */
@Component
@Slf4j
public class GrayLoadBalancerClientFilter implements GlobalFilter, Ordered {
    @Resource
    private LoadBalancerClientFactory clientFactory;
    @Resource
    private CustomProperty customProperty;
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        URI url = exchange.getAttribute(ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR);
        ServerWebExchangeUtils.addOriginalRequestUrl(exchange, url);
        if (url == null || BizConstant.HTTP.equalsIgnoreCase(url.getScheme())) {
            return chain.filter(exchange);
        }
        return doFilter(exchange, chain, url);
    }
    private Mono<Void> doFilter(ServerWebExchange exchange, GatewayFilterChain chain, URI url) {
        return this.choose(exchange).doOnNext(res -> {
            if (!res.hasServer()) {
                throw NotFoundException.create(true, "Unable to find instance for ".concat(url.getHost()));
            }
            URI uri = exchange.getRequest().getURI();
            String overrideScheme = null;
            DelegatingServiceInstance delegatingServiceInstance = new DelegatingServiceInstance(res.getServer(), overrideScheme);
            URI reqUrl = this.reconstructURI(delegatingServiceInstance, uri);
            if (log.isDebugEnabled()) {
                log.debug("GrayLoadBalancerClientFilter url chosen: {}", reqUrl.toString());
            }
            exchange.getAttributes().put(ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR, reqUrl);
        }).then(chain.filter(exchange));
    }
    private URI reconstructURI(DelegatingServiceInstance delegatingServiceInstance, URI originalUri) {
        return LoadBalancerUriTools.reconstructURI(delegatingServiceInstance, originalUri);
    }
    private Mono<Response<ServiceInstance>> choose(ServerWebExchange exchange) {
        URI uri = exchange.getAttribute(ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR);
        if (uri == null) {
            throw new MMException("{} is null", ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR);
        }
        GrayLoadBalancer loadBalancer = new GrayLoadBalancer(clientFactory.getLazyProvider(uri.getHost(), ServiceInstanceListSupplier.class), uri.getHost(), customProperty);
        return loadBalancer.choose(this.createRequest(exchange));
    }
    private Request createRequest(ServerWebExchange exchange) {
        return new DefaultRequest(exchange.getRequest().getHeaders());
    }
    @Override
    public int getOrder() {
        return FILTER_ORDER_GRAY;
    }
}

NOTE

FILTER_ORDER_GRAY 是一個 int 常量，其值不能隨意定義(如-1,0,1,2之類)。從下表可以看到，SCG 的 LoadBalancerClientFilter 執行順序是 10100，那么 GrayLoadBalancerClientFilter 的執行順序必須 > 10100 （否則自定義的 Filter 里就會有變量未被賦值）, 這里假定 FILTER_ORDER_GRAY = 10110

• GrayLoadBalancer: 灰度發布負載均衡策略

/**
 * 灰度發布負載均衡策略
 */
@Slf4j
public class GrayLoadBalancer implements ReactorServiceInstanceLoadBalancer {
    private ObjectProvider<ServiceInstanceListSupplier> serviceInstanceListSupplierProvider;
    private String serviceId;
    private CustomProperty customProperty;
    public GrayLoadBalancer(ObjectProvider<ServiceInstanceListSupplier> serviceInstanceListSupplierProvider, String serviceId, CustomProperty customProperty) {
        this.serviceId = serviceId;
        this.serviceInstanceListSupplierProvider = serviceInstanceListSupplierProvider;
        this.customProperty = customProperty;
    }
    @Override
    public Mono<Response<ServiceInstance>> choose(Request request) {
        HttpHeaders headers = (HttpHeaders) request.getContext();
        if (this.serviceInstanceListSupplierProvider != null) {
            ServiceInstanceListSupplier supplier = this.serviceInstanceListSupplierProvider.getIfAvailable(NoopServiceInstanceListSupplier::new);
            return supplier.get().next().map(item -> getInstanceResponse(item, headers));
        }
        return null;
    }
    private Response<ServiceInstance> getInstanceResponse(List<ServiceInstance> instances, HttpHeaders headers) {
        if (instances.isEmpty()) {
            return getServiceInstanceEmptyResponse();
        }
        return getServiceInstanceResponseByUidsOrGrayTag(instances, headers);
    }
    /**
     * 從nacos獲取服務實例列表，并根據策略返回灰度服務的實例還是正常服務的實例
     */
    private Response<ServiceInstance> getServiceInstanceResponseByUidsOrGrayTag(List<ServiceInstance> instances, HttpHeaders headers) {
        List<ServiceInstance> grayInstances = new ArrayList<>();
        List<ServiceInstance> normalInstances = new ArrayList<>();
        for (ServiceInstance instance : instances) {
            Map<String, String> metadata = instance.getMetadata();
            // nacos元數據包含“gray-tag”的key值,且value="true"，則判定為灰度實例
            String isGrayInstance = metadata.get(BizConstant.GRAY_TAG);
            if (BizConstant.TRUE.equals(isGrayInstance)) {
                grayInstances.add(instance);
            } else {
                normalInstances.add(instance);
            }
        }
        //沒有灰度服務，直接返回
        if (grayInstances.isEmpty()) {
            return new DefaultResponse(chooseOneInstance(normalInstances));
        }
        //有灰度服務，判斷是否需要灰度
        if (checkIfNeedGray(headers)) {
            log.info("gray service of {} will be called", this.serviceId);
            return new DefaultResponse(chooseOneInstance(grayInstances));
        }
        return new DefaultResponse(chooseOneInstance(normalInstances));
    }
    /**
     * 從實例列表中獲取其中一個實例的策略實現，這里采用的是隨機挑選
     * pick strategy 可以根據業務需要，在這個方法里改寫
     */
    private ServiceInstance chooseOneInstance(List<ServiceInstance> serviceInstances) {
        // strategy 1：可用的里面隨機選擇一個
        int size = serviceInstances.size();
        if (size == 1) {
            return serviceInstances.get(0);
        }
        Random rand = new Random();
        int random = rand.nextInt(size);
        return serviceInstances.get(random);
    }
    /**
     * 灰度判斷邏輯：
     * 1. 判斷請求header里是否用灰度標識的 kv，有則走灰度服務
     * 2. 如果 1 不滿足，則判斷請求的用戶 id 是否在灰度用戶池中，有則走灰度服務
     * 3. 1 和 2 都不滿足，走正常服務
     */
    private boolean checkIfNeedGray(HttpHeaders headers) {
        String grayTag = headers.getFirst(BizConstant.GRAY_TAG);
        if (grayTag != null) {
            if (BizConstant.TRUE.equalsIgnoreCase(grayTag)) {
                // todo 可擴展點：目前是只判斷header里是否有BizConstant.GRAY_TAG的kv不為空且v="true"，后面v可以改為版本號
                return true;
            }
        }
        String uid = headers.getFirst(BizConstant.UID);
        if (uid != null && customProperty.getGraySetting().getGrayUids().contains(uid)) {
            return true;
        }
        return false;
    }
    private Response<ServiceInstance> getServiceInstanceEmptyResponse() {
        log.warn("No servers available for service: " + this.serviceId);
        return new EmptyResponse();
    }
}

• Https2HttpFilter：將進入網關的 https 請求轉換為 http 請求

/**
 * https scheme to http
 */
@Component
@Slf4j
public class Https2HttpFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        URI originalUri = request.getURI();
        ServerHttpRequest.Builder mutate = request.mutate();
        String forwardUri = request.getURI().toString();
        if (forwardUri != null && forwardUri.startsWith(BizConstant.HTTPS)) {
            try {
                URI mutatedUri = new URI(BizConstant.HTTP,
                        originalUri.getUserInfo(),
                        originalUri.getHost(),
                        originalUri.getPort(),
                        originalUri.getPath(),
                        originalUri.getQuery(),
                        originalUri.getFragment());
                mutate.uri(mutatedUri);
            } catch (Exception e) {
                log.error(e.getMessage());
                throw new MMException("Https related error");
            }
        }
        ServerHttpRequest build = mutate.build();
        return chain.filter(exchange.mutate().request(build).build());
    }
    @Override
    public int getOrder() {
        return FILTER_ORDER_HTTPS_2_HTTP;
    }
}

NOTE

FILTER_ORDER_HTTPS_2_HTTP 是一個 int 常量，需要滿足 LoadBalancerClientFilter 的執行順序(10100) < FILTER_ORDER_HTTPS_2_HTTP < FILTER_ORDER_GRAY (10110)。這里可以假定 FILTER_ORDER_HTTPS_2_HTTP = 10105。之所以需要加一個Https2HttpFilter 過濾器，是因為如果 https 請求直接進入到 GrayLoadBalancerClientFilter 會報 NotSslRecordException 證書錯誤。

2.2 | Nacos

Nacos 主要做一件事情：通過 metadata 維護灰度服務。

從上圖可以看出，metadata 里 gray-tag=true 的實例即為灰度服務的實例。

通過 webUI 的編輯按鈕可以實時的新增修改 metadata。

那么，如何在代碼側配置呢？

可以直接在bootstrap.yml添加以下字段：

spring:
  cloud:
    nacos:
      discovery:
        metadata:
          # 如果${gray}變量不存在，則gray-tag=false
          gray-tag: ${gray:false}

2.3 | GitlabRunner

gitlab-runner 主要是 kube_deploy.yml 和 .gitlab-ci.yml 的一個聯動配置

• kube_deploy.yml添加以下環境變量：

apiVersion: apps/v1
kind: Deployment
metadata:
  name: ccc-deploy
  namespace: ccc
spec:
  template:
    spec:
      containers: 
      - env:
          - name: gray
            value: "gray-tag" # 這里的gray-tag值 將會在在.gitlab-ci.yml的腳本中被替換

• .gitlab-ci.yml 灰度服務部署 gitlab-runner 腳本關鍵部分：

...
stages:
  - k8s-deploy
k8s-deploy-gray-service:
  stage: k8s-deploy
  script:
    - echo "=============== 開始 k8s 部署任務 ==============="
    - sed -i "s/gray-tag/true/g" kube_deploy.yml # 這
    - kubectl apply -f kube_deploy.yml
  only:
    - /^tag_gray_.*$/
k8s-deploy-normal-service:
  stage: k8s-deploy
  script:
    - echo "=============== 開始 k8s 部署任務 ==============="
    - sed -i "s/gray-tag/false/g" kube_deploy.yml # 這里替換 gray-tag 為 false
    - kubectl apply -f kube_deploy.yml
  only:
    - /^tag_normal_.*$/
 ...

此時，當打了一個以 tag_gray_ 開頭的 tag 之后，kube_deploy.yml里的gray-tag就會被替換成 true，那么，nacos 的元數據上就會有一個gray-tag=true的標簽，就會走灰度服務的發布流程。同理，以 tag_normal_ 開頭的 tag，就會走正常服務的發布流程。

把這段腳本嵌入到 pipeline 之后，就可以通過 tag 的方式，自動化部署灰度/正常服務了。

3 | 后續 TODO

目前實現的是后端服務的灰度發布，一個完整的灰度，還包含了前端應用的灰度，后續會就前端的灰度發布再做一次整理。

4 | 使用版本說明

實戰依賴版本

需要注意的

在 Spring Cloud 全家桶中，最初的網關使用的是 Netflix 的 Zuul 1x 版本，但是由于其性能問題，Spring Cloud 在苦等 Zuul 2x 版本未果的情況下，推出了自家的網關產品，取名叫 Spring Cloud Gateway （以下簡稱 SCG)，基于Webflux，通過底層封裝Netty，實現異步IO，大大地提示了性能。

Zuul 1x 版本

本質上就是一個同步Servlet，采用多線程阻塞模型進行請求轉發。簡單講，每來一個請求，Servlet容器要為該請求分配一個線程專門負責處理這個請求，直到響應返回客戶端這個線程才會被釋放返回容器線程池。如果后臺服務調用比較耗時，那么這個線程就會被阻塞，阻塞期間線程資源被占用，不能干其它事情。我們知道Servlet容器線程池的大小是有限制的，當前端請求量大，而后臺慢服務比較多時，很容易耗盡容器線程池內的線程，造成容器無法接受新的請求。且不支持任何長連接，如websocket

NOTE 由于兩個網關的底層架構不一致，負載均衡的邏輯也完全不一致，本文只探討 Spring Cloud Gateway 配合 Nacos 來實現灰度發布（ Spring Cloud Zuul 網關的灰度發布不展開）。

關于“SpringCloudGateway Nacos GitlabRunner全自動灰度服務怎么搭建”這篇文章的內容就介紹到這里，感謝各位的閱讀！相信大家對“SpringCloudGateway Nacos GitlabRunner全自動灰度服務怎么搭建”知識都有一定的了解，大家如果還想學習更多知識，歡迎關注億速云行業資訊頻道。