目录
Gateway
???Gateway是在Spring生态系统之上构建的API网关服务，基于Spring 5，Spring Boot 2和 Project Reactor等技术。
????????Gateway旨在提供一种简单而有效的方式来对API进行路由，以及提供一些强大的过滤器功能，例如:熔断、限流、重试等。
SpringCloud Gateway
????????SpringCloud Gateway是Spring Cloud的一个全新项目，基于Spring 5.0+Spring Boot 2.0和PrgjectReactor等技术开发的网关，它旨在为微服务架构提供─种简单有效的统一的API路由管理方式。
????????SpringCloud Gateway作为Spring Cloud 生态系统中的网关，目标是替代Zuul，在Spring Cloud 2.0以上版本中，没有对新版本的Zuul 2.0以上最新高性能版本进行集成，仍然还是使用的Zuul 1.x非Reactor模式的老版本。而为了提升网关的性能，SpringCloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。
????????Spring Cloud Gateway的目标提供统一的路由方式且基于Filter链的方式提供了网关基本的功能，例如：安全，监控/指标，和限流。
? ? ? ? Spring Cloud Gateway 使用的 Webflux 中的 reactor-netty 响应式编程组件，底层使用了 Netty 通讯框架。
????????Cloud全家桶中有个很重要的组件就是网关，在1.x版本中都是采用的Zuul网关；但在2.x版本中，zuul的升级—直跳票，SpringCloud最后自己研发了一个网关替代Zuul,那就是SpringCloud Gateway一句话: gateway是原zuul1.x版的替代
网关所处的位置
主要功能：反向代理、鉴权、流量控制、熔断、日志监控
选择 SpringCloud Gateway 的理由
????????一方面因为Zuul1.0已经进入了维护阶段，而且Gateway是SpringCloud团队研发的，值得信赖。而且很多功能Zuul都没有用起来也非常的简单便捷。
????????Gateway是基于异步非阻塞模型上进行开发的，性能方面不需要担心。虽然Netflix早就发布了最新的Zuul 2.x,但Spring Cloud貌似没有整合计划。而且Netflix相关组件都宣布进入维护期;不知前景如何?
????????多方面综合考虑Gateway是很理想的网关选择。
Spring Cloud Gateway具有如下特性:
1、基于Spring Framework 5, Project Reactor和Spring Boot 2.0进行构建；
2、动态路由：能够匹配任何请求属性；可以对路由指定Predicate (断言)和Filter (过滤器);
3、集成Hystrix的断路器功能;
4、集成Spring Cloud服务发现功能;
5、易于编写的 Predicate(断言）和Filter (过滤器);请求限流功能;
6、支持路径重写。
Spring Cloud Gateway 与Zuul的区别
在SpringCloud Finchley正式版之前，Spring Cloud推荐的网关是Netflix提供的Zuul:
1、Zuul 1.x，是一个基于阻塞I/O的APl Gateway
2、Zuul 1.x基于Servlet 2.5使用阻塞架构它不支持任何长连接(如WebSocket)Zuul的设计模式和Nginx较像，每次I / О操作都是从工作线程中选择一个执行，请求线程被阻塞到工作线程完成，但是差别是Nginx用C+＋实现，Zul用Java实现，而JVM本身会有第—次加载较慢的情况，使得Zuul的性能相对较差。
3、Zuul 2.x理念更先进，想基于Netty非阻塞和支持长连接，但SpringCloud目前还没有整合。Zuul 2.x的性能较Zul 1.x有较大提升。在性能方面，根据官方提供的基准测试, Spring Cloud Gateway的RPS(每秒请求数)是Zuul的1.6倍。
4、Spring Cloud Gateway建立在Spring Framework 5、Project Reactor和Spring Boot2之上，使用非阻塞API。
5、Spring Cloud Gateway还支持 WebSocket，并且与Spring紧密集成拥有更好的开发体验
Zuul1.x 模型
????????Springcloud中所集成的Zuul版本，采用的是Tomcat容器，使用的是传统的Servlet lO处理模型
Servlet 由 servlet container 进行生命周期管理。container启动时构造servlet对象并调用servlet init()进行初始化;
container运行时接受请求，并为每个请求分配一个线程（一般从线程池中获取空闲线程)然后调用service()。container关闭时调用servlet destory()销毁servlet;
上述模式的缺点:
????????servlet是一个简单的网络IO模型，当请求进入servlet container时，servlet container就会为其绑定一个线程，在并发不高的场景下这种模型是适用的。但是一旦高并发(比如用jemeter压)，线程数量就会上涨，而线程资源代价是昂贵的(上线文切换，内存消耗大、严重影响请求的处理时间。在一些简单业务场景下，不希望为每个request分配一个线程，只需要1个或几个线程就能应对极大并发的请求，这种业务场景下servlet模型没有优势。所以Zuul1.X是基于sevlet之上的一个阻塞式处理模型，即spring实现了处理所有request请求的一个servlet (DispatcherServlet)并由该servlet阻塞式处理。所以 SpringCloud Zuul 无法摆脱 servlet 模型的弊端。
Getway 模型
????????传统的Web框架，比如说: struts2，springmvc等都是基于Servlet APl与Servlet容器基础之上运行的。但是在Servlet3.1之后有了异步非阻寒的支持。而WebFlux是一个典型非阻塞异步的框架，它的核心是基于Reactor的相关API实现的。相对于传统的web框架来说，它可以运行在诸如Netty,Undertow及支持Servlet3.1的容器上。非阻塞式+函数式编程(Spring5必须让你使用java8)
Spring WebFlux是Spring 5.0引入的新的响应式框架，区别于Spring MVC，它不需要依赖Servlet API，它是完全异步非阻塞的，并且基于Reactor来实现响应式流规范。
三大核心概念
Route(路由)：路由是构建网关的基本模块，它由ID，目标URI，一系列的断言和过滤器组成，如果断言为true则匹配该路由
Predicate(断言)：参考的是Java8的java.util.function.Predicate?开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数)，如果请求与断言相匹配则进行路由
Filter(过滤)：指的是 Spring 框架中Gateway Filter 的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改。
总体：
web请求，通过一些匹配条件，定位到真正的服务节点。并在这个转发过程的前后，进行一些精细化控制。
predicate就是我们的匹配条件；而 filter，就可以理解为一个无所不能的拦截器。有了这两个元素，再加上目标uri，就可以实现一个具体的路由了
SpringCloud Gateway 工作流程
????????客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到GatewayWeb Handler。
????????Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。
过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“preT)或之后(“post”）执行业务逻辑。
????????Filter在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等
在“post”类型的过滤器中可以做响应内容、响应头的修改，日志的输出，流量监控等有着非常重要的作用。?
? ? ? ? 核心逻辑：路由转发 + 执行过滤链
入门配置
1、创建?cloud-gateway-gateway9527
2、添加 POM 依赖，
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--网关也要注册进服务注册中心-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.atyixuan</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>不要有这两个依赖，否则会报错
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>3、YML 配置文件
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
routes:
- id: payment_routh #路由的ID，没有固定规则但要求唯一，建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2
uri: http://localhost:8001
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
eureka:
instance:
hostname: cloud-gateway-service
client:
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka4、主启动类
@EnableEurekaClient
@SpringBootApplication
public class GateWayMain9527 {
public static void main(String[] args) {
SpringApplication.run(GateWayMain9527.class, args);
}
}cloud-gateway-gateway9527 做路由映射，我们目前不想暴露8001端口，希望在cloud-provider-payment8001外面套一层9527，通过?cloud-gateway-gateway9527 来访问?cloud-provider-payment8001
我们在?cloud-gateway-gateway9527 的 YML 配置文件中添加如下内容：
server:
port: 9527
spring:
application:
name: cloud-gateway
# 添加的内容
cloud:
gateway:
routes:
- id: payment_routh # 路由的 ID， 没有固定规则但要求唯一，建议配合服务名
uri: http://localhost:8001 # 匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- id: payment_routh2
uri: http://localhost:8001
predicates:
- Path=/payment/lb/**
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka5、测试
启动? cloud-eureka-server7001、cloud-provider-payment8001? 和??cloud-gateway-gateway9527
可以通过两种方式访问，添加网关前：http://localhost:8001/payment/get/31
添加网关后：http://localhost:9527/payment/get/31
6、Gateway网关路由有两种配置方式
一种是上述的 YML? 配置方式
另一种是?代码中注入RouteLocator的Bean 的方式，以通过cloud-gateway-gateway9527 网关访问到外网的百度新闻网址
添加配置类：com.atyixuan.springcloud.config.GateWayConfig
@Configuration
public class GateWayConfig {
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes.route("path_route_atyixuan",
r -> r.path("/guonei")
.uri("http://news.baidu.com/guonei")).build();
return routes.build();
}
@Bean
public RouteLocator customRouteLocator2(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes.route("path_route_atyixuan",
r -> r.path("/guoji")
.uri("http://news.baidu.com/guoji")).build();
return routes.build();
}
}重启?cloud-gateway-gateway9527
分别输入链接访问如下链接，即可访问的百度新闻的国际和国内新闻
通过微服务名实现动态路由
默认情况下Gateway会根据注册中心的服务列表，以注册中心上微服务名为路径创建动态路由进行转发，从而实现动态路由的功能
?采用?cloud-eureka-server7001、cloud-provider-payment8001、cloud-provider-payment8002 和?cloud-gateway-gateway9527 演示改功能
修改??cloud-gateway-gateway9527 的 YML 配置文件
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true # 开启从注册人中心动态创建路由的功能，利用微服务名进行路由
routes:
- id: payment_routh # 路由的 ID， 没有固定规则但要求唯一，建议配合服务名
# uri: http://localhost:8001 # 匹配后提供服务的路由地址
# 需要注意的是uri的协议为lb，表示启用Gateway的负载均衡功能。
# lb://serviceName是spring cloud gateway在微服务中自动为我们创建的负载均衡uri
uri: lb://cloud-payment-service
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- id: payment_routh2
# uri: http://localhost:8001
uri: lb://cloud-payment-service
predicates:
- Path=/payment/lb/**
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka
测试：启动 cloud-eureka-server7001、cloud-provider-payment8001、cloud-provider-payment8002 和?cloud-gateway-gateway9527
http://localhost:9527/payment/lb，这样就会在?cloud-provider-payment8001 和 cloud-provider-payment8002 之间来回切换
?Predicate的使用：官网链接
????????Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。
Spring Cloud Gateway包括许多内置的Route Predicate工厂。所有这些Predicate都与HTTP请求的不同属性匹配。多个RoutePredicate工厂可以进行组合
????????Spring Cloud Gateway创建Route对象时，使用RoutePredicateFactory 创建 Predicate对象，Predicate对象可以赋值给Route。Spring Cloud Gateway包含许多内置的Route Predicate Factories。
????????所有这些断言都匹配HTTP请求的不同属性。多种断言工厂可以组合，并通过逻辑 and。
1、The After Route Predicate Factory?After路由断言工厂接受一个参数，一个datetime(它是一个java ZonedDateTime)。此断言匹配发生在指定日期时间之后的请求。
datetime 生成方式如下：
import java.time.ZonedDateTime;
public class Test {
public static void main(String[] args) {
ZonedDateTime now = ZonedDateTime.now();
System.out.println(now);
// 输出结果： 2022-01-23T18:35:12.810+08:00[Asia/Shanghai]
}
}
配置after路由断言的示例如下:
spring:
cloud:
gateway:
routes:
- id: after_route
uri: https://example.org
predicates:
- After=2017-01-20T17:42:47.789-07:00[America/Denver]2、The Before Route Predicate Factory?Before路由断言工厂接受一个参数，一个datetime(它是一个java ZonedDateTime)。此断言匹配发生在指定日期时间之前的请求。
spring:
cloud:
gateway:
routes:
- id: before_route
uri: https://example.org
predicates:
- Before=2017-01-20T17:42:47.789-07:00[America/Denver]
3、The Between Route Predicate Factory?Between路由断言工厂接受两个参数，datetime1和datetime2，它们是java ZonedDateTime对象。这个断言匹配发生在datetime1之后和datetime2之前的请求。datetime2必须在datetime1之后。
spring:
cloud:
gateway:
routes:
- id: between_route
uri: https://example.org
predicates:
- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]4、?The Cookie Route Predicate Factory?Cookie路由断言工厂接受两个参数，Cookie名称和regexp(这是一个Java正则表达式)。此断言匹配具有给定名称且其值与正则表达式匹配的cookie。此路由将匹配具有一个名为chocolate的cookie的请求，该cookie的值匹配ch.p正则表达式。下面的例子配置了一个cookie路由断言工厂:
spring:
cloud:
gateway:
routes:
- id: cookie_route
uri: https://example.org
predicates:
- Cookie=chocolate, ch.p5、The Header Route Predicate Factory?Header路由断言工厂接受两个参数，头和regexp(它是一个Java正则表达式)。该断言与具有给定名称的头匹配，该名称的值与正则表达式匹配。下面的例子配置了报头路由断言:
spring:
cloud:
gateway:
routes:
- id: header_route
uri: https://example.org
predicates:
- Header=X-Request-Id, \d+6、The Host Route Predicate Factory?主机路由断言工厂接受一个参数:主机名模式列表。该模式是一个 Ant-style 的模式。作为分隔符。这个断言匹配匹配模式的Host头。配置主机路由断言的示例如下:
spring:
cloud:
gateway:
routes:
- id: host_route
uri: https://example.org
predicates:
- Host=**.somehost.org,**.anotherhost.orgURI模板变量(例如 {sub}.myhost.org)也被支持。
如果请求的Host报头值为www.somehost.org 或 beta.somehost.org 或 www.anotherhost.org，则此路由匹配。
这个断言提取URI模板变量(例如sub，在前面的例子中定义)作为名称和值的映射，并将其与在ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE中定义的键放在ServerWebExchange.getAttributes()中。这些值可以被GatewayFilter工厂使用
7、The Method Route Predicate Factory?方法路由断言工厂接受一个方法参数，它是一个或多个参数:要匹配的HTTP方法。下面的例子配置了一个方法路由断言:
如果请求方法是GET或POST，则此路由匹配。
spring:
cloud:
gateway:
routes:
- id: method_route
uri: https://example.org
predicates:
- Method=GET,POST8、The Path Route Predicate Factory?Path Route Predicate Factory接受两个参数:一个Spring PathMatcher模式列表和一个名为matchTrailingSlash的可选标志(默认为true)。下面的例子配置了一个路径路由断言:
spring:
cloud:
gateway:
routes:
- id: path_route
uri: https://example.org
predicates:
- Path=/red/{segment},/blue/{segment}9、The Query Route Predicate Factory?Query路由断言工厂接受两个参数:一个必需的参数和一个可选的regexp(它是一个Java正则表达式)。下面的例子配置了一个查询路由断言:
spring:
cloud:
gateway:
routes:
- id: query_route
uri: https://example.org
predicates:
- Query=green如果请求包含? green 查询参数，则上述路由匹配。
所有的示例汇总如下：
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true # 开启从注册中心动态创建路由的功能，利用微服务名进行路由
routes:
- id: payment_routh # 路由的 ID， 没有固定规则但要求唯一，建议配合服务名
# uri: http://localhost:8001 # 匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- id: payment_routh2
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2022-01-23T18:35:12.810+08:00[Asia/Shanghai]
- Cookie=username,java #并且Cookie是username=java才能访问
# - Header=X-Request-Id, \d+ #请求头中要有X-Request-Id属性并且值为整数的正则表达式
# - Host=**.atguigu.com
# - Method=GET
# - Query=username, \d+ #要有参数名称并且是正整数才能路由
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka
说白了，Predicate就是为了实现一组匹配规则，让请求过来找到对应的Route进行处理
启动? cloud-gateway-gateway9527
curl 中输入 如下内容测试：
Filter的使用
? ? ? ? filter 指的是Spring 框架中 GatewayFilter 的实例，使用过滤器，可以在请求被路由活在和之后对请求进行修改
????????路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应，路由过滤器只能指定路由进行使用。Spring Cloud Gateway内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生
? ? ???Filter??生命周期有 pre 和 post
? ? ? ? Fileter 有?GatewayFilter?Factories?和?Global Filters?两种配置
? ? ? ? 自定义过滤器举例：
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true # 开启从注册中心动态创建路由的功能，利用微服务名进行路由
routes:
- id: payment_routh # 路由的 ID， 没有固定规则但要求唯一，建议配合服务名
# uri: http://localhost:8001 # 匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- id: payment_routh2
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
filters:
# 过滤器工厂会在匹配的请求头加上一对请求头，名称为 X-Request-red 值为 blue
- AddRequestHeader=X-Request-red, blue
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2022-01-23T18:35:12.810+08:00[Asia/Shanghai]
- Cookie=username,java #并且Cookie是username=java才能访问
# - Header=X-Request-Id, \d+ #请求头中要有X-Request-Id属性并且值为整数的正则表达式
# - Host=**.atguigu.com
# - Method=GET
# - Query=username, \d+ #要有参数名称并且是正整数才能路由
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka
自定义全局GlobalFilter（用的较多)：主要用于全局日志记录和统一网关鉴权
实现两个接口??GlobalFilter, Ordered
@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("*************************come in MyLogGateWayFilter: " + new Date());
String uname = exchange.getRequest().getQueryParams().getFirst("uname");
if(uname == null){
log.info("******************用户名为 null, 非法用户，o(╥﹏╥)o");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
// 去下一个过滤链
return chain.filter(exchange);
}
@Override
public int getOrder() {
return 0;
}
}
这里为了简便将 filter 和 predicate 的相关配置内容注释掉，最终的 YML 配置如下
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true # 开启从注册中心动态创建路由的功能，利用微服务名进行路由
routes:
- id: payment_routh # 路由的 ID， 没有固定规则但要求唯一，建议配合服务名
# uri: http://localhost:8001 # 匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- id: payment_routh2
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
# filters:
# # 过滤器工厂会在匹配的请求头加上一对请求头，名称为 X-Request-red 值为 blue
# - AddRequestHeader=X-Request-red, blue
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2022-01-23T18:35:12.810+08:00[Asia/Shanghai]
# - Cookie=username,java #并且Cookie是username=java才能访问
# - Header=X-Request-Id, \d+ #请求头中要有X-Request-Id属性并且值为整数的正则表达式
# - Host=**.atguigu.com
# - Method=GET
# - Query=username, \d+ #要有参数名称并且是正整数才能路由
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka
测试：
依次启动?
cloud-eureka-server7001 cloud-provider-payment8001 cloud-provider-payment8002 cloud-gateway-gateway9527
后续在发送请求的时候需要带上 uname=*** 这部分的内容
?
?否则直接就无法访问