【硬核】Spring Cloud Gateway

概念

Gateway是基于异步非阻塞模型上进行开发的，有springcloud团队开发。用来代替Zuul。

近几个月收集了收集了N份精校过的PDF版的Java八股文大全，涉及Java后端的方方面面，分享给大家。希望能帮助到大家面试前的复习且找到一个好的工作，也节省大家在网上搜索资料的时间来学习。

看这里： 直接获取方式点我

文档版，如下图：

内容 Route(路由)

路由是构建网关的基本模块，它由ID，目标URL，一系列的断言和过滤器组成，如果断言为true则匹配该路由

Predicate(断言)

参考的是java8的java.util.function.Predicate
开发人员可以匹配HTTP请求中的所有内容(例如请求头或者请求参数)，如果请求与断言想匹配则路由

Filter(过滤)

指的是Spring框架中GatewayFilter的实例，使用过滤器，可以请求被路由器前或者之后对请求进行修改

Zuul

Zuul1基于servlet阻塞I/O的API Gateway，且进入维护
Zuul2虽然基于非阻塞I/O，但是还没有发布，且SpringCloud没有整合

优点

基于Spring Framework5, Project Reactor 和SpringBoot 2.0 进行构建
动态路由：能够匹配任何请求属性
可以对路由指定Predicate(断言) 和 Filter(过滤器)
继承Hystrix的断路器功能
集成SpringCloud服务发现功能
易于编写的Predicate(断言) 和 Filter(过滤器)
请求限流功能
支持路由重写

作用

可以不对外开放服务端，只对外开放网关

Spring Cloud Gateway工作流程

使用

1、 新建网关模型
2、 pom引入Gateway

  org.springframework.cloud
  spring-cloud-starter-gateway

3、将网关注册进eureka/Zookeeper/Consul
4、由yml网关配置。在yml中加入

spring: 
  cloud:
    gateway:
      routes:
        - id: payment_routh #路由的id，没有固定规则但要求唯一，建议配合服务名
        -url: http://localhost:8001 #匹配后提供服务的路由地址
        -predicates:
          - Path=/payment/get/** #断言，路径相匹配的进行路由

        - id: payment_routh2 #路由的id，没有固定规则但要求唯一，建议配合服务名
        -url: http://localhost:8001 #匹配后提供服务的路由地址
        -predicates:
          - Path=/payment/1b/** #断言，路径相匹配的进行路由

5、测试
在网关中，不需要springboot的web和actuator，否则启动报错。在pom中移除即可
–启动eureka/Zookeeper/Consul、网关、服务端
–通过网关访问服务端

6、用代码配置，创建一个配置类

@Configuration
public class GatwayConfig{
  @Bean
  public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
    RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
    
    routes .route("path_route",r -> r.path("/guonei").uri("http://baidu.com/guonei")).build();
    return routes.build();
  }
}

实现动态路由功能

默认情况下Gateway会根据注册中心注册的服务列表，以注册中心上微服务名为路径创建动态路由进行转发，从而实现动态路由功能

实现

spring: 
  cloud:
    gateway:
      discovery: 
        locator:
          enabled: true
      routes:
        - id: payment_routh #路由的id，没有固定规则但要求唯一，建议配合服务名
       # -url: http://localhost:8001 #匹配后提供服务的路由地址
        -url: 1b://cloud-payment-service
        -predicates:
          - Path=/payment/get/** #断言，路径相匹配的进行路由

        - id: payment_routh2 #路由的id，没有固定规则但要求唯一，建议配合服务名
        #-url: http://localhost:8001 #匹配后提供服务的路由地址
        -url: 1b://cloud-payment-service
        -predicates:
          - Path=/payment/1b/** #断言，路径相匹配的进行路由

predicates的参数.如下为官网内容

1、所述After路线谓词工厂有一个参数，一个datetime（其是Java ZonedDateTime）。该谓词匹配在指定日期时间之后发生的请求。下面的示例配置路由后谓词：
例子1. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: https://example.org
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]

这条路线符合2017年1月20日17:42山区时间（丹佛）之后的任何请求。

• 获取时区

ZonedDateTime zbj = ZonedDateTime.now();//默认时区
System.out.println(zbj);

2、所述Before路线谓词工厂有一个参数，一个datetime（其是Java ZonedDateTime）。该谓词匹配在指定之前发生的请求datetime。下面的示例配置路由前谓词：
例子2. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: before_route
        uri: https://example.org
        predicates:
        - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

这条路线符合2017年1月20日山区时间（丹佛）之前的任何请求。

3、该Between路线谓词工厂有两个参数，datetime1并且datetime2 这是JavaZonedDateTime对象。该谓词匹配之后datetime1和之前发生的请求datetime2。该datetime2参数必须是后datetime1。以下示例配置了路由之间的谓词：
例子3. application.yml

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]

此路线与2017年1月20日山区时间（丹佛）之后和2017年1月21日17:42山区时间（丹佛）之后的任何请求相匹配。这对于维护时段可能很有用。

4、所述Cookie路线谓词工厂采用两个参数，该cookiename和regexp（其是Java正则表达式）。该谓词匹配具有给定名称且其值与正则表达式匹配的cookie。以下示例配置cookie路由谓词工厂：
例子4. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: cookie_route
        uri: https://example.org
        predicates:
        - Cookie=chocolate, ch.p

此路由匹配具有名称为chocolate与ch.p正则表达式匹配的cookie的请求。

5、所述Header路线谓词工厂采用两个参数，报头name和一个regexp（其是Java正则表达式）。该谓词与具有给定名称的标头匹配，该标头的值与正则表达式匹配。以下示例配置标头路由谓词：
例子5. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: https://example.org
        predicates:
        - Header=X-Request-Id, \d+

如果请求具有名为X-Request-Id其值与\d+正则表达式匹配的标头（即，其值为一个或多个数字），则此路由匹配。

6、该Host路线谓词工厂需要一个参数：主机名的列表patterns。该模式是带有.分隔符的Ant样式的模式。谓词与Host匹配模式的标头匹配。以下示例配置主机路由谓词：
例子6. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: https://example.org
        predicates:
        - Host=**.somehost.org,**.anotherhost.org

{sub}.myhost.org还支持URI模板变量（例如）。

如果请求具有这种路由匹配Host用的头值www.somehost.org或beta.somehost.org或www.anotherhost.org。

该谓词提取URI模板变量（例如sub，在前面的示例中定义的）作为名称和值的映射，并ServerWebExchange.getAttributes()使用中定义的键将其放在中ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE。这些值可供工厂使用GatewayFilter

7、所述Method路线谓词厂需要methods的参数，它是一个或多个参数：HTTP方法来匹配。以下示例配置方法route谓词：
例子7. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: method_route
        uri: https://example.org
        predicates:
        - Method=GET,POST

如果请求方法是aGET或a，则此路由匹配POST。

8、该Path路线谓词厂有两个参数：春天的列表PathMatcher patterns和所谓的可选标志matchTrailingSlash（默认true）。以下示例配置路径路由谓词：
例子8. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: path_route
        uri: https://example.org
        predicates:
        - Path=/red/{segment},/blue/{segment}

如果请求路径为，则此路由匹配，例如：/red/1或/red/1/或/red/blue或/blue/green。

如果matchTrailingSlash设置为false，则请求路径/red/1/将不匹配。

该谓词提取URI模板变量（例如segment，在前面的示例中定义的）作为名称和值的映射，并ServerWebExchange.getAttributes()使用中定义的键将其放在中ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE。这些值可供工厂使用GatewayFilter

可以使用实用程序方法（称为get）来简化对这些变量的访问。下面的示例演示如何使用该get方法：

Map<String, String> uriVariables = ServerWebExchangeUtils.getPathPredicateVariables(exchange);

String segment = uriVariables.get("segment");

9、所述Query路线谓词工厂采用两个参数：所要求的param和可选的regexp（其是Java正则表达式）。以下示例配置查询路由谓词：
例子9. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: https://example.org
        predicates:
        - Query=green

如果请求包含green查询参数，则前面的路由匹配。

application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: https://example.org
        predicates:
        - Query=red, gree.

如果请求包含一个前述路线匹配red，其值相匹配的查询参数gree.的regexp，所以green和greet将匹配。

10、所述RemoteAddr路线谓词工厂需要的列表（分钟尺寸1） sources，其是CIDR的表示法（IPv4或IPv6）的字符串，如192.168.0.1/16（其中192.168.0.1是一个IP地址和16一个子网掩码）。以下示例配置一个RemoteAddr路由谓词：
例子10. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: remoteaddr_route
        uri: https://example.org
        predicates:
        - RemoteAddr=192.168.1.1/24

如果请求的远程地址为，则此路由匹配192.168.1.10。

11、该Weight路线谓词工厂有两个参数：group和weight（一个int）。权重是按组计算的。以下示例配置权重路由谓词：
例子11. application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: weight_high
        uri: https://weighthigh.org
        predicates:
        - Weight=group1, 8
      - id: weight_low
        uri: https://weightlow.org
        predicates:
        - Weight=group1, 2

这条路线会将大约80％的流量转发到weighthigh.org，将大约20％的流量转发到weightlow.org。

Spring Cloud gateway的Filter

非自定义的简单，按照文档配置即可
Spring Cloud gateway的Filte官方文档

生命周期与种类

1、生命周期-Only Two

• pre
• post

2、种类 - Only Two

• GatewayFilter 单一的Filter
• GlobalFilter 全局的Filter

自定义过滤器

新建Gateway配置类，实现GlobalFilter,Ordered接口，内容如下

@Component
public class GatewayConfig implements GlobalFilter,Ordered{
  @Override
  public Mono<Void> filter(ServerWebExchange exchange,GatewayFilterChain chain){//exchange可以获取到请求信息，chain用来将新的请求发出到下一个过滤链
    String name = exchange.getRequest().getQueryParams().getFilter("uname");
    if(name == null){
      ...
    }
    return chain.filter(exchange);
  }
  //getOrder是顺序
  @Override
  public int getOrder(){
    ...
    return 0;
  }
}

👇🏻 扫一扫 添加备注：（锦鲤） 获取更多资料👇🏻