如何使用Spring Cloud Gateway，99%的人都不知道!

Posted 2021-05-29 jinggege795

使用Spring Cloud Gateway

Spring Cloud Gateway有以下3个基本概念。

口路由(Route) :这是网关的基本构建块。它由用于标识路由的唯一ID、目标URI、谓词列表和过滤器列表组成。仅当已满足所有谓词时才匹配路径。

口谓词(Predicate) :这些是在处理每个请求之前执行的逻辑。它负责检测HTTP请求的不同属性(如标头和参数)是否与定义的标准匹配。该实现基于Java8接口java.ilfunction.Predicate <T>.其输入类型则依次基于Spring的org springfamnework.web.server.ServerWebExchange.

口过滤器 (Filter) :它们允许修改传入的HTTP请求或传出的HTTP响应。可以在发送下游请求之前或之后修改它们。路径过滤器的范围限定为特定路径。它们实现了Spring

org.springframework.web.server.GatewayFilter.

 

为项目启用Spring Cloud Gateway

Spring Cloud Gateway 构建于Netty Web 容器和Reactor框架之上。Reactor 项目和Spring Web Flux 可以与Spring Boot 2.0版-起使用。 到目前为止，我们使用的都是1.5版，因此父项目版本的声明不同。目前, Spring Boot 2.0仍处于里程碑阶段。以下是Maven的pom.xml中的片段，它继承自spring boot-starter-parent项目。

<parent>

<groupId>org .spr ingframework.boot</groupId>

<artifactId>spring- boot -starter - parent</artifactId>

<version>2.0.0.M7</version>

</parent>

与前面的示例相比，我们还需要更改Spring Cloud 的版本列车。最新的里程碑版本是Finchley.M5.

<properties>

<project.build. sourceEncoding>UTF-8</project .build. sourceEncoding>

<project . report ing . outputEncoding>UTE 8</project. reporting .outputEncoding>

<java.version>1.8</java.version>

<spring-cloud. vers lon>Finchley .M5</spring-cloud.version>

</properties>

<dependencyManagement>

<dependencies>

<dependency>

<groupId>org .springframework. cloud</groupId>

<artifactId>spring-cloud-dependencies</artifactId>

<version>$ (spring-cloud .version}</version>

<type>pom</type>

<scope> import</scope>

</dependency>

</ dependencies>

</dependencyManagement>

在设置了正确版本的Spring Boot和Spring Cloud之后，最终才可能在项目依赖项中包含spring-cloud- starter gateway启动器。

<dependency>

<groupId>org。springframework.cloud</groupId>

<artifactId>spring-cloud- starter -gateway</artifactId>

</dependency>

内置谓词和过滤器

Spring Cloud Gateway包括许多内置路由谓词(Route Predicate) 和网关过滤器工厂(Gateway Filter Factory)。可以使用application.yml文件中的配置属性或使用Fluent Java Routes API以编程方式定义每个路由。表8.1就是其可用谓词工厂列表。可以将多个工厂组合为具有逻辑与(and)关系的单个路由定义。在aplicationyml文件中，通过spring cloud.gateway.routes属性下已定义的每个路由的predicates属性可以配置过滤器集合。

 

网关过滤器模式也有一些内置实现。 表8.2提供了其可用工厂列表。在aplication.ym文件中，通过spring. cloud. gateway .routes属性下定义的每个路由的filters属性可以配置过滤器集合。

 

以下是一个简单的示例，其中包含两个谓词和两个过滤器集合。每次GET /account 1{id}请求进入网关时都将转发到htt:t/lhos/:080/a/iaccouxt/tx {id}， 其中包含新的HTTP标头X-Request-ID.

spring:

cloud:

gateway:

routes:

- id: example_ route

uri: http://localhost:8080

predicates:

- Method=GET

- Path=/account/lid}

filters:

- AddRequestHeader-X-Request-ID, 123

- PrefixPath-/api

可以使用Route类中定义的Fluent API提供相同的配置。这种风格给了开发人员更大的灵活性。虽然通过YAML进行配置可以使用逻辑与(and)组合谓词，但是Fluent Java API允许开发人员在Predicate类上使用and)、or(和 negate0运算符。以下是使用Fluent API实现的替代路由。

@Bean

public RouteLocator customRouteLocator (RouteLocatorBuilder routeBuilder)

{

return routeBuilder.routes 0)

.route(r -> r. method (HttpMethod. GET) .and() .path ("/account/(id}")

. addRequestHeader ("X-Request-ID", "123") .prefixPath("/api")

.uri ("http://localhost:8080")1

.build( );

}

微服务的网关

现在不妨回到之前的基于微服务的系统的示例，这是本章在基于SpringCloudNettlix Zuul的API网关配置内容中讨论过的例子。我们希望为应用程序准备静态路由定义，并且该定义与基于Zuul代理准备的相同。然后，每个服务将在网关地址和特定路径下可用，如h:t/ocalhost:.080/accoun/**.使用Spring Cloud Gateway声明此类配置的最合适方式是通过Path Route Predicate Factory和RewritePath GatewayFilter Factory.重写路径机制将通过参与或添加一些模式来更改请求路径。在我们的示例中，每个传入的请求路径都将从accoun/123重写为/123.以下是该网关的application.yml 文件。

 

spring:

application:

name: gateway-service

cloud:

gateway:

discovery:

locator :

enabled:true

routes:

-id: account-service

uri: 1b://account-service

predicates :

- Path=/account/**

filters:

一RewritePath-/account/ (?<path>.*), /$\\{path}

一id: customer -service

uri: 1b:/ /customer - service

predicates :

一Path=/customer/**

filters:

一RewritePath=/customer/ (?<path>.*), /$\\(path}

- id: order-service

uri: 1b://order-service

predicates:

- Path=/order/*+

filters:

- RewritePath=/order/ (?<path>.*), /S\\{path}

id: product-service

uri: lb://product-service

predicates:

一Path=/product/**

filters:

一RewritePath=/product/ (2<path>.*), /$\\[path}

令人惊讶的是，这就是本示例必须要做的一切。 与我们在使用其他Spring Cloud 组件(如Eureka或Config Server)时所做的相比，在这里不必提供任何其他注解。因此，我们的网关应用程序的main类将如以下代码所示。必须使用mvn clean install构建项目并使用java -jar启动它，或者也可以从集成开发环境运行main类。本示例应用程序的源代码可在GitHub (tps:/github.com/piomin/sample-spring-cloud-gateway.git) 上获得。

@SpringBootApplication

public class GatewayApplication {

public static void main(String[] args) {

SpringApplication. run (GatewayApplication.class, args);

  }

}

与服务发现集成

网关可以被配置为基于在服务发现中注册的服务列表来创建路由。它可以与具有.DiscoveryClient兼容服务注册表的解决方案集成，如Nettlix Eureka、Consul或Zookeeper.要启用DiscoveryClient 路由定义定位器，应将spring. cloud gateway discovery.locator.enabled属性设置为true, 并在类路径上提供DiscoveryClient 实现。开发人员可以使用Eureka客户端和服务器进行发现。请注意，要使用Spring Cloud 的最新里程碑版本Finchley.M5，在该版本中，所有Netlix 的工件名称都已更改，例如，现在spring-cloud-starter. -eureka已经被修改为spring cloud-starter- nttlix eureka-client.

<dependency>

<groupId>org. springframework. cloud</groupId>

<artifactId>spring-cloud-starter -netflix-eureka-client</artifactId>

</ dependency>

Eureka客户端应用程序的main类应该相同，使用@DiscoveryClient注解。以下是带路由配置的application.yml 文件。与前一个示例相比，唯一的变化是每个已定 义路由的uri属性。开发人员可以使用从具有Ilb前缀的发现服务器(如b://order-service获取的名称，而不是提供网络地址。

spring:

application:

name: gateway-service

cloud:

gateway:

discovery:

locator :

enabled:true

routes:

-id: account-service

uri: 1b://account-service

predicates :

- Path=/account/**

filters:

一RewritePath-/account/ (?<path>.*), /$\\{path}

一id: customer -service

uri: 1b:/ /customer - service

predicates :

一Path=/customer/**

filters:

一RewritePath=/customer/ (?<path>.*), /$\\(path}

- id: order-service

uri: 1b://order-service

predicates:

- Path=/order/*+

filters:

- RewritePath=/order/ (?<path>.*), /S\\{path}

id: product-service

uri: lb://product-service

predicates:

一Path=/product/**

filters:

一RewritePath=/product/ (2<path>.*), /$\\[path}

小结

在介绍完API网关之后，本书就已经完成了关于Spring Cloud中基于微服务的架构的核心元素实现的讨论。阅读完本书的这一部分之后，开发人员应该能够自定义和使用Eureka、Spring Cloud Config. Ribbon、 Feign和Hystrix等工具，最后还可以使用基于Zuul和Spring Cloud Gateway的网关。

本章可以被视为两种可用解决方案的比较一较旧 的Nettlix Zuul和最新的解决方案Spring Cloud Gateway。 其中，第二种解决方案仍在不断变化。它的当前版本2.0只能在Spring5中使用，并且在发行版中仍然不可用。第一种解 决方案Netlix Zuul则是稳定的，但它不支持异步和非阻塞连接等特性。它仍然基于Netlix Zuul 1.0,当然也有-一个新版本的Zuul支持异步通信。不管它们之间的区别如何，本章已经描述了如何使用这两种解决方案提供简单和更高级的配置。基于前面章节中的示例，本章还介绍了与服务发现、客户端负载均衡器和断路器的集成。

需要这份文档来学习的小伙伴，可以转发此文关注小编。

扫码来获取就可以了！