深入理解SpringCloud之Gateway

spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: before_route
          uri: http://www.baidu.com
          predicates:
            - Path=/baidu
server:
  port: 8088

public class RoutePredicateHandlerMapping extends AbstractHandlerMapping {
  
  // ....省略部分代码
  @Override
 protected Mono<?> getHandlerInternal(ServerWebExchange exchange) {
  // don't handle requests on management port if set and different than server port
  if (this.managementPortType == DIFFERENT && this.managementPort != null
    && exchange.getRequest().getURI().getPort() == this.managementPort) {
   return Mono.empty();
  }
  exchange.getAttributes().put(GATEWAY_HANDLER_MAPPER_ATTR, getSimpleName());

  return lookupRoute(exchange)
    // .log("route-predicate-handler-mapping", Level.FINER) //name this
    .flatMap((Function<Route, Mono<?>>) r -> {
     exchange.getAttributes().remove(GATEWAY_PREDICATE_ROUTE_ATTR);
     if (logger.isDebugEnabled()) {
      logger.debug(
        "Mapping [" + getExchangeDesc(exchange) + "] to " + r);
     }

     exchange.getAttributes().put(GATEWAY_ROUTE_ATTR, r);
     return Mono.just(webHandler);
    }).switchIfEmpty(Mono.empty().then(Mono.fromRunnable(() -> {
     exchange.getAttributes().remove(GATEWAY_PREDICATE_ROUTE_ATTR);
     if (logger.isTraceEnabled()) {
      logger.trace("No RouteDefinition found for ["
        + getExchangeDesc(exchange) + "]");
     }
    })));
 }
  
  //...省略部分代码

}

    /*
     * TODO: trace logging if (logger.isTraceEnabled()) {
     * logger.trace("RouteDefinition did not match: " + routeDefinition.getId()); }
     */
   }

    //.....省略其它代码
    
    @Override
   public Mono<Void> handle(ServerWebExchange exchange) {
      //拿到当前的route
    Route route = exchange.getRequiredAttribute(GATEWAY_ROUTE_ATTR);
      //获取所有的gatewayFilter
    List<GatewayFilter> gatewayFilters = route.getFilters();
    //获取全局过滤器
    List<GatewayFilter> combined = new ArrayList<>(this.globalFilters);
    combined.addAll(gatewayFilters);
    // TODO: needed or cached?
    AnnotationAwareOrderComparator.sort(combined);
  
    if (logger.isDebugEnabled()) {
     logger.debug("Sorted gatewayFilterFactories: " + combined);
    }
    //交给默认的过滤器链执行所有的过滤操作
    return new DefaultGatewayFilterChain(combined).filter(exchange);
   }
  
    //....省略其它代码
  }

 public static String normalizeRoutePredicateName(
   Class<? extends RoutePredicateFactory> clazz) {
  return removeGarbage(clazz.getSimpleName()
    .replace(RoutePredicateFactory.class.getSimpleName(), ""));
 }

@Component
public class NumberRoutePredicateFactory extends AbstractRoutePredicateFactory<NumberRoutePredicateFactory.Config> {


    public NumberRoutePredicateFactory() {
        super(Config.class);
    }

    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("number");
    }

    @Override
    public ShortcutType shortcutType() {
        return ShortcutType.GATHER_LIST;
    }

    @Override
    public Predicate<ServerWebExchange> apply(Config config) {
        return new GatewayPredicate() {
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                String number = serverWebExchange.getRequest().getQueryParams().getFirst("number");
                return config.number == Integer.parseInt(number);
            }
        };
    }

  
    public static class Config {
        private int number;

        public int getNumber() {
            return number;
        }

        public void setNumber(int number) {
            this.number = number;
        }
    }
}

public class LoadBalancerClientFilter implements GlobalFilter, Ordered {

  protected final LoadBalancerClient loadBalancer;

 private LoadBalancerProperties properties;

 //....
  
  @Override
 @SuppressWarnings("Duplicates")
 public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
 
  // preserve the original url
  addOriginalRequestUrl(exchange, url);

  log.trace("LoadBalancerClientFilter url before: " + url);

    //选择一个服务实例
  final ServiceInstance instance = choose(exchange);
    
  if (instance == null) {
   throw NotFoundException.create(properties.isUse404(),
     "Unable to find instance for " + url.getHost());
  }

  URI uri = exchange.getRequest().getURI();

  // if the `lb:<scheme>` mechanism was used, use `<scheme>` as the default,
  // if the loadbalancer doesn't provide one.
    //判断协议类型
  String overrideScheme = instance.isSecure() ? "https" : "http";
  if (schemePrefix != null) {
   overrideScheme = url.getScheme();
  }
  //重构uri地址
  URI requestUrl = loadBalancer.reconstructURI(
    new DelegatingServiceInstance(instance, overrideScheme), uri);
    
  //...
  return chain.filter(exchange);
 }
}

@Override
  protected Observable<Void> construct() {
      // 执行过滤器链
   return RxReactiveStreams.toObservable(this.chain.filter(exchange));//1
  }

  @Override
  protected Observable<Void> resumeWithFallback() {
   if (this.fallbackUri == null) {
    return super.resumeWithFallback();
   }

   // TODO: copied from RouteToRequestUrlFilter
   URI uri = exchange.getRequest().getURI();
   // TODO: assume always?
   boolean encoded = containsEncodedParts(uri);
   URI requestUrl = UriComponentsBuilder.fromUri(uri).host(null).port(null)
     .uri(this.fallbackUri).scheme(null).build(encoded).toUri();//2
   exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, requestUrl);
   addExceptionDetails();

   ServerHttpRequest request = this.exchange.getRequest().mutate()
     .uri(requestUrl).build();
   ServerWebExchange mutated = exchange.mutate().request(request).build();
   return RxReactiveStreams.toObservable(getDispatcherHandler().handle(mutated));//3
  }

public class DiscoveryClientRouteDefinitionLocator implements RouteDefinitionLocator {
  
  @Override
 public Flux<RouteDefinition> getRouteDefinitions() {

 //....省略部分代码
    
  return Flux.fromIterable(discoveryClient.getServices())//获取所有服务
    .map(discoveryClient::getInstances) //映射转换所有服务实例
    .filter(instances -> !instances.isEmpty()) //过滤出不为空的服务实例
    .map(instances -> instances.get(0)).filter(includePredicate)//根据properites里的include表达式过滤实例
    .map(instance -> {
          
          /*
            构建Route的定义
           */
     String serviceId = instance.getServiceId();

     RouteDefinition routeDefinition = new RouteDefinition();
     routeDefinition.setId(this.routeIdPrefix + serviceId);
     String uri = urlExpr.getValue(evalCtxt, instance, String.class);
     routeDefinition.setUri(URI.create(uri));

     final ServiceInstance instanceForEval = new DelegatingServiceInstance(
       instance, properties);

          //添加Predicate
     for (PredicateDefinition original : this.properties.getPredicates()) {
      PredicateDefinition predicate = new PredicateDefinition();
      predicate.setName(original.getName());
      for (Map.Entry<String, String> entry : original.getArgs()
        .entrySet()) {
       String value = getValueFromExpr(evalCtxt, parser,
         instanceForEval, entry);
       predicate.addArg(entry.getKey(), value);
      }
      routeDefinition.getPredicates().add(predicate);
     }
     //添加filter
     for (FilterDefinition original : this.properties.getFilters()) {
      FilterDefinition filter = new FilterDefinition();
      filter.setName(original.getName());
      for (Map.Entry<String, String> entry : original.getArgs()
        .entrySet()) {
       String value = getValueFromExpr(evalCtxt, parser,
         instanceForEval, entry);
       filter.addArg(entry.getKey(), value);
      }
      routeDefinition.getFilters().add(filter);
     }

     return routeDefinition;
    });
 }
}

public static List<PredicateDefinition> initPredicates() {
  ArrayList<PredicateDefinition> definitions = new ArrayList<>();
  // TODO: add a predicate that matches the url at /serviceId?

  // add a predicate that matches the url at /serviceId/**
  PredicateDefinition predicate = new PredicateDefinition();
  predicate.setName(normalizeRoutePredicateName(PathRoutePredicateFactory.class));
  predicate.addArg(PATTERN_KEY, "'/'+serviceId+'/**'");
  definitions.add(predicate);
  return definitions;
 }

public static List<FilterDefinition> initFilters() {
  ArrayList<FilterDefinition> definitions = new ArrayList<>();

  // add a filter that removes /serviceId by default
  FilterDefinition filter = new FilterDefinition();
  filter.setName(normalizeFilterFactoryName(RewritePathGatewayFilterFactory.class));
  String regex = "'/' + serviceId + '/(?<remaining>.*)'";
  String replacement = "'/${remaining}'";
  filter.addArg(REGEXP_KEY, regex);
  filter.addArg(REPLACEMENT_KEY, replacement);
  definitions.add(filter);

  return definitions;
 }