快速入门Spring Cloud Gateway

前言

在深入探讨Spring Cloud Gateway的细节之前，让我们了解有关反向代理和api网关模式的一些基础知识。

反向代理是代表其他事物进行请求的事物。它的行为更像是简单的路由。它可以增加基本的安全性和监视功能，但实际上不能做某些高级事情，例如中介或业务流程。NGINX是众所周知的反向代理服务器之一。

简而言之，API Gateway是增强的反向代理，具有更高级的功能，包括编排以及增加的安全性和监视功能。Netflix Zuul(上文介绍)，Amazon API Gateway，Apigee以及Spring Cloud Gateway当然是少数著名的api网关实现。

• 建立在Spring Framework 5，Project Reactor（后面我会单独开篇幅去介绍reactor3）和Spring Boot 2.0之上

• 能够匹配任何请求属性上的路由。

• 谓词和过滤器特定于路由。

• 断路器集成。

• Spring Cloud DiscoveryClient集成

• 易于编写的谓词和过滤器

• 请求速率限制

• 路径改写

Spring Cloud Gateway 对比 Zuul

• 我知道所有使用Spring Boot的人都想知道，我们已经在使用Zuul。它几乎提供了与Spring Cloud Gateway相同的功能。那么，为什么我们要切换到新框架？对我来说，主要原因是Zuul 1.x没有反应式编程。它使用阻塞api。现在，如果您正在迁移到Reactive模式以从微服务中获得更好的性能，并且您将Spring Boot 2与Reactor一起使用。

• 您可以使用Zuul 2.0，它确实具有Netty的Reactive nonblocking支持。 但是Spring生态系统没有像Zuul 1.x那样给予Zuul 2.0的内置支持，这意味着，您必须使用Zuul运行自己的独立服务。你不能让它与其他现有的spring微服务集成。Spring团队并不打算用Spring来增加对它的支持。

• 所以Spring Cloud Gateway可以与任何微服务集成，使之成为真正的api网关，在一个地方添加身份验证和其他安全功能。因为推荐使用Spring Cloud Gateway。

Spring Cloud Gateway简介

Spring Cloud Gateway是Spring Cloud团队在Spring反应生态系统（Webflux）之上的API网关实现。它提供了一种简单有效的方法，即使用网关处理程序映射将传入的请求路由到适当的目的地。Spring Cloud Gateway使用Netty服务器提供非阻塞异步请求处理。以下是在Spring Cloud Gateway中请求路由的工作原理的高层流程：

Spring Cloud Gateway架构

Spring Cloud Gateway包含3个主要构建模块：

• Route（路由）

  将此视为我们希望将特定请求路由到的目的地。它由目标URI、必须满足的条件或技术术语、谓词和一个或多个筛选器组成。

• Predicate（谓词）

  这实际上是一个需要匹配的条件。 例如if条件。如果请求有某些东西-例如，path=blah或请求头包含foo-bar等。在java技术术语中，它类似于java8函数谓词Predicate。

  具体谓词类型参考文档：

  https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

• Filter（过滤器）

  这些是springframeworkwebfilter的实例。在这里您可以应用修改请求或响应的魔力。框架提供了很多现成的WebFilter。当然，我们讨论的是Spring框架。所以，大家休息吧！！！您始终可以使用自己的逻辑添加自己的筛选器。

Spring Cloud Gateway 原理

Spring Cloud Gateway 的工作原理跟 Zuul 的差不多，最大的区别就是 Gateway 的 Filter 只有 pre 和 post 两种。下面我们简单了解一下 Gateway 的工作原理图，如下图所示。

架构图

• Predicate 原理

  Predicte由PredicateSpec来构建，主要实现有：

Predicte

以PathRoutePredicateFactory为例看下源码：

    @Override
    public Predicate<ServerWebExchange> apply(Config config) {
        final ArrayList<PathPattern> pathPatterns = new ArrayList<>();
        synchronized (this.pathPatternParser) {
            pathPatternParser.setMatchOptionalTrailingSeparator(config.isMatchOptionalTrailingSeparator());
            config.getPatterns()
                    .forEach(pattern -> {
                        // 构建匹配规则
                        PathPattern pathPattern = this.pathPatternParser.parse(pattern);
                        pathPatterns.add(pathPattern);
                    })
            ;
        }
        return exchange -> {
            PathContainer path = parsePath(exchange.getRequest().getURI().getPath());
            // 匹配过滤
            Optional<PathPattern> optionalPathPattern = pathPatterns.stream().filter(pattern -> pattern.matches(path)).findFirst();
            if (optionalPathPattern.isPresent()) {
                // 如果存在匹配成功的  然后设置匹配成功的PathMatchInfo
                PathPattern pathPattern = optionalPathPattern.get();
                traceMatch("Pattern", pathPattern.getPatternString(), path, true);
                PathMatchInfo pathMatchInfo = pathPattern.matchAndExtract(path);
                putUriTemplateVariables(exchange, pathMatchInfo.getUriVariables());
                return true;
            } else {
                traceMatch("Pattern", config.getPatterns(), path, false);
                return false;
            }
        };
    }

• Filter 原理

  Filter分两种，一种GatewayFilter（网关路由过滤器）,一种GlobalFilter（全局路由器）

• GlobalFilter

  为请求业务以及路由的URI转换为真实业务服务的请求地址的核心过滤器，不需要配置，模式系统初始化时加载，并作用在每个路由上。

  GlobalFilter

  GlobalFilter类型参考文档

• GatewayFilter

  Gateway内置了不少可用的GatewayFilter，具体如下：

  GatewayFilter

  以OrderedGatewayFilter为例看下源码：

  /**
   * 排序的网关路由过滤器，用于包装真实的网关过滤器，已达到过滤器可排序
   */
  public class OrderedGatewayFilter implements GatewayFilter, Ordered {
  
      //目标过滤器
      private final GatewayFilter delegate;
      //排序字段
      private final int order;
  
      public OrderedGatewayFilter(GatewayFilter delegate, int order) {
          this.delegate = delegate;
          this.order = order;
      }
  
      @Override
      public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
          // 下个过滤器去过滤
          return this.delegate.filter(exchange, chain);
      }
  }
  
  

  GatewayFilter类型参考文档

Spring Cloud Gateway 入门

1. ###引入依赖

  <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

1. 使用RouteLocator去构建url路由

@SpringBootApplication
public class GatewayClientApplication {

    @Value("${test.uri}")
    private String uri;

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                //basic proxy
                .route(r -> r.path("/order/**")
                        .uri(uri)
                ).build();
    }

    public static void main(String[] args) {
        SpringApplication.run(GatewayClientApplication.class, args);
    }
}

1. application.ymal方式

假设test1-service和test2-service的服务地址分别是http://127.0.0.1:8070,http://127.0.0.1:8060

例如下面的写法中，test1-service最终转发后的路径就是：http://127.0.0.1:8070/** 去除了test1-service路径

test2-service最终路径 ：http://127.0.0.1:8060/test2-service/** 不做路径剥离直接请求。

spring:
  application:
    name: gateway
  cloud:
    gateway:
      discovery:
        locator:
          lowerCaseServiceId: true
          enabled: true
      routes:
        - id: test-1
          uri: lb://test1-service  #负载均衡url
          order: 8001 #定义顺序
          predicates: #谓词
            - Path=/test1-service/**
          filters： #过滤器  
            - AddResponseHeader=X-Response-test1, test1
        - id: test-2
          uri: lb://test2-service
          order: 8003
          predicates:
            - Path=/test2-service/oauth/token
          filters：   
            - AddResponseHeader=X-Response-test2, test2

END

欢迎关注公众号！ 公众号回复:

入群

，扫码加入我们交流群！