SpringCloudGateway Nacos GitlabRunner全自动灰度服务搭建发布

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

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

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

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

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的脚本中被替换

...
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_.*$/
 ...