Gateway新一代网关

2023-05-16

一、概述

1.官网

2.介绍

3.作用

4.微服务架构中网关的位置

5.有Zuul了怎么又出来了gateway

①我们为什么选择Gateway？

②Zuul1.x模型

🐟Servlet的生命周期?

③gateway模型

二、三大核心概念

1.Route路由

2.Predicate(断言)

3.Filter(过滤)

三、Gateway工作流程

1.官网讲解

2. 核心逻辑

四、入门配置

1.新建Module cloud-gateway-gateway9527

2.pom.xml

3.application.yml

4.主启动类

5.9527网关如何做路由映射

6.YML新增网关配置

7.测试

①启动7001

②启动8001

③启动9527网关

④访问说明

8.Gateway网关路由的两种配置方式

①在配置文件yml中配置

②代码中注入RouteLocator的Bean

五、通过微服务名实现动态路由

1.pom.xml

2.application.yml

六、Predicate的使用

1.是什么

2.Route Predicate Factories

3. 常用的Route Predicate

①After Route Predicate

②Before Route Predicate

③Between Route Predicate

④Cookie Route Predicate

⑤Hearder Route Predicate

⑥Host Route Predicate

⑦Method Route Predicate

⑧Path Route Predicate

⑨Query Route Predicate

⑩Weight Route Predicate

💧ReadBodyPredicateFactory Route Predicate

💧RemoteAddr Route Predicate

七、Filter的使用

1.定义

2.Spring Cloud Gateway的Filter

①生命周期

②种类，Only Two

3.常用的GatewayFilter

🐟AddRequestParameter GatewayFilter Factory

🐟 AddRequestHeader GatewayFilter Factory

🐟 AddResponseHeader GatewayFilter Factory

🐟DedupeResponseHeader GatewayFilter Factory

4.自定义过滤器

一、概述

1.官网

上一代zuul 1.X:Home · Netflix/zuul Wiki · GitHub

gateway的官网：Spring Cloud Gateway

2.介绍

SpringCloud Gateway是SpringCloud的一个全新项目，基于Spring5.O+Springboot 2.0和ProjectReactor等技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的API路由管理方式。
SpringCloudGateway作为SpringCloud生态系统中的网关，目标是替代Zuul
在SpringCloud2.0以上版本中，没有对新版本的zuul2.0以上最新高性能版本进行集成，仍然还是使用的Zuul 1.x非Reactor模式的老版本。
为了提升网关的性能，SpringCloud Gateway是基于WebFlux框架实现的，而webFlux框架底层则使用了高性能的Reactor模式通信框架Netty。
springCloud Gateway的目标提供统一的路由方式且基于Filter链的方式提供了网关基本的功能，例如：安全、监控/指标、限流。

3.作用

反向代理
鉴权
流量控制
熔断
日志监控
.........

4.微服务架构中网关的位置

5.有Zuul了怎么又出来了gateway

①我们为什么选择Gateway？

一方面因为Zuul1.0已经进入了维护阶段，而且Gateway是SpringCloud团队研发的，是亲儿子产品，值得信赖。
而且很多功能Zuul都没有用起来也非常的简单便捷。
Gateway是基于异步非阻塞模型上进行开发的，性能方面不需要担心。
虽然Netflix早就发布了最新的 Zuul 2.x，但 Spring Cloud 貌似没有整合计划。而且Netflix相关组件都宣布进入维护期
多方面综合考虑Gateway是很理想的网关选择。

Spring Cloud Gateway 具有如下特性：

基于Spring Framework 5, Project Reactor 和 Spring Boot 2.0 进行构建；
动态路由：能够匹配任何请求属性；
可以对路由指定 Predicate（断言）和 Filter（过滤器）；
集成Hystrix的断路器功能；
集成 Spring Cloud 服务发现功能；
易于编写的 Predicate（断言）和 Filter（过滤器）；
请求限流功能；
支持路径重写。

Spring Cloud Gateway 与 Zuul的区别

在SpringCloud Finchley正式版之前，Spring Cloud 推荐的网关是 Netflix 提供的Zuul：

Zuul 1.x，是一个基于阻塞 I/ O 的 API Gateway
Zuul 1.x 基于Servlet 2. 5使用阻塞架构它不支持任何长连接(如 WebSocket) Zuul 的设计模式和Nginx较像，每次 I/ O 操作都是从工作线程中选择一个执行，请求线程被阻塞到工作线程完成
差别是Nginx 用C++ 实现，Zuul 用 Java 实现，而 JVM 本身会有第一次加载较慢的情况，使得Zuul 的性能相对较差。
Zuul 2.x理念更先进，想基于Netty非阻塞和支持长连接，但SpringCloud目前还没有整合
Zuul 2.x的性能较 Zuul 1.x 有较大提升。
在性能方面，根据官方提供的基准测试， Spring Cloud Gateway 的 RPS（每秒请求数）是Zuul 的 1. 6 倍
Spring Cloud Gateway 建立在 Spring Framework 5、 Project Reactor 和 Spring Boot 2 之上，使用非阻塞 API。
Spring Cloud Gateway 还支持 WebSocket，并且与Spring紧密集成拥有更好的开发体验

②Zuul1.x模型

Springcloud中所集成的Zuul版本，采用的是Tomcat容器，使用的是传统的Servlet IO处理模型。

🐟Servlet的生命周期?

servlet由servlet container进行生命周期管理。
container启动时构造servlet对象并调用servlet init()进行初始化；
container运行时接受请求，并为每个请求分配一个线程（一般从线程池中获取空闲线程）然后调用service()。
container关闭时调用servlet destory()销毁servlet

上述模式的缺点：

servlet是一个简单的网络IO模型，当请求进入servlet container时，servlet container就会为其绑定一个线程，在并发不高的场景下这种模型是适用的。
但是一旦高并发(比如用jemeter压测)，线程数量就会上涨，而线程资源代价是昂贵的（上线文切换，内存消耗大）严重影响请求的处理时间。
在一些简单业务场景下，不希望为每个request分配一个线程，只需要1个或几个线程就能应对极大并发的请求，这种业务场景下servlet模型没有优势
所以Zuul 1.X是基于servlet之上的一个阻塞式处理模型，即spring实现了处理所有request请求的一个servlet（DispatcherServlet）并由该servlet阻塞式处理处理。
所以Springcloud Zuul无法摆脱servlet模型的弊端

③gateway模型

💧💧💧💧💧什么是webflux

传统的Web框架，比如说：struts2，springmvc等都是基于Servlet API与Servlet容器基础之上运行的。
但是在Servlet3.1之后有了异步非阻塞的支持。而WebFlux是一个典型非阻塞异步的框架
核心是基于Reactor的相关API实现的
相对于传统的web框架来说，它可以运行在诸如Netty，Undertow及支持Servlet3.1的容器上。非阻塞式+函数式编程（Spring5必须让你使用java8）
Spring WebFlux 是 Spring 5.0 引入的新的响应式框架，区别于 Spring MVC，它不需要依赖Servlet API，它是完全异步非阻塞的，并且基于 Reactor 来实现响应式流规范。

二、三大核心概念

1.Route路由

路由是构建网关的基本模块，它由ID，目标URI，一系列的断言和过滤器组成

如果断言为true则匹配该路由

2.Predicate(断言)

参考的是Java8的java.util.function.Predicate

开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数)
如果请求与断言相匹配则进行路由

3.Filter(过滤)

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

web请求，通过一些匹配条件，定位到真正的服务节点。并在这个转发过程的前后，进行一些精细化控制。
predicate就是我们的匹配条件
而filter，就可以理解为一个无所不能的拦截器。
有了这两个元素，再加上目标uri，就可以实现一个具体的路由了

三、Gateway工作流程

1.官网讲解

客户端向 Spring Cloud Gateway 发出请求。

然后在 Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到 Gateway Web Handler。

Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。

过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前（“pre”）或之后（“post”）执行业务逻辑。

Filter在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等
在“post”类型的过滤器中可以做响应内容、响应头的修改，日志的输出，流量监控等有着非常重要的作用。

2. 核心逻辑

路由转发+执行过滤器链

四、入门配置

1.新建Module cloud-gateway-gateway9527

2.pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>cloud2022</artifactId>
        <groupId>com.atxupt.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-gateway-gateway9527</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>
        <!--gateway-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--eureka-client-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- 引入自己定义的api通用包，可以使用Payment支付Entity -->
        <dependency>
            <groupId>com.atxupt.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <!--一般基础配置类-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

3.application.yml

4.主启动类

@SpringBootApplication
@EnableEurekaClient
public class GateWay9527 {
    public static void main(String[] args) {
        SpringApplication.run(GateWay9527.class,args);
    }
}

5.9527网关如何做路由映射

6.YML新增网关配置

server:
  port: 9527

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

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

eureka:
  instance:
    hostname: cloud-gateway-service
  client: #服务提供者provider注册进eureka服务列表内
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

7.测试

①启动7001

②启动8001

③启动9527网关

④访问说明

8.Gateway网关路由的两种配置方式

①在配置文件yml中配置

按照上面的步骤完成

②代码中注入RouteLocator的Bean

Ⅰ、官网的案例

Ⅱ、百度国内新闻网址，需要外网

百度新闻——海量中文资讯平台

Ⅲ、自己写一个

新建配置类GateWayConfig

@Configuration
public class GateWayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        //http://news.baidu.com/guonei
        //当访问地址 http://localhost:9527/guonei时会自动转发到地址： 
        //http://news.baidu.com/guonei

        routes.route(
                "path_route_atxupt",
                r -> r.path("/guonei").uri("http://news.baidu.com/guonei")).build();

        return routes.build();
    }
}

最终效果

存在的问题：地址写死啦

五、通过微服务名实现动态路由

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

1.pom.xml

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

2.application.yml

server:
  port: 9527

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true #开启从注册中心动态创建路由的功能，利用微服务名进行路由
      routes:
        - id: payment_routh #payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名
          # uri: http://localhost:8001          #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/get/**         # 断言，路径相匹配的进行路由

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

eureka:
  instance:
    hostname: cloud-gateway-service
  client: #服务提供者provider注册进eureka服务列表内
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

六、Predicate的使用

1.是什么

启功gateway9527时

2.Route Predicate Factories

Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。
Spring Cloud Gateway包括许多内置的Route Predicate工厂。所有这些Predicate都与HTTP请求的不同属性匹配。
多个Route Predicate工厂可以进行组合
Spring Cloud Gateway 创建 Route 对象时，使用 RoutePredicateFactory 创建 Predicate 对象，Predicate 对象可以赋值给 Route。
Spring Cloud Gateway 包含许多内置的Route Predicate Factories。
所有这些谓词都匹配HTTP请求的不同属性。
多种谓词工厂可以组合，并通过逻辑and。

3. 常用的Route Predicate

说白了，Predicate就是为了实现一组匹配规则，让请求过来找到对应的Route进行处理。

①After Route Predicate

After断言有一个参数，一个datetime（其是Java ZonedDateTime）。该断言匹配在指定日期时间之后发生的请求（如果没到时间，就会报404错误）。下面的示例配置路由后断言

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

②Before Route Predicate

Before断言有一个参数，一个datetime（其是Java ZonedDateTime）。该断言匹配在指定之前发生的请求datetime。以下示例配置了路由前断言

spring:
  cloud:
    gateway:
      routes:
      - id: before_route
        uri: https://example.org
        predicates:
        - Before=2022-12-30T17:20:00.789-07:00[America/Denver]

③Between Route Predicate

Between Route Predicate Factory 中获取一个UTC时间格式的参数，当请求的当前时间在配置的UTC时间之间，则会成功匹配，否则不能成功匹配。

spring:
  cloud:
    gateway:
      routes:
      - id: between_route
        uri: https://example.org
        predicates:
        - Between=2022-12-30T17:20:00.789-07:00[America/Denver], 2019-01-21T17:42:47.789-07:00[America/Denver]

④Cookie Route Predicate

Cookie Route Predicate Factory 会取两个参数
（Header中以“Cookie”命名的名称，对应的Key和Value）
当请求携带的cookie和Cookie断言工厂配置的一致，则路由匹配成功，否则匹配失败。

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

⑤Hearder Route Predicate

Header Route Predicate Factory 根据配置的路由Header信息进行断言匹配路由，匹配成功进行转发，否则不进行转发。

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

⑥Host Route Predicate

Host Route Predicate Factory 根据配置的Host，对请求中的Host进行断言处理，断言匹配成功进行转发，否则不进行转发。

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

⑦Method Route Predicate

Method Route Predicate Factory 根据路由信息配置的Method对请求方式是Get或者Post等进行断言匹配，断言匹配成功进行转发，否则不进行转发

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

⑧Path Route Predicate

Path Route Predicate Factory 基于Spring PathMatcher 模式的路径匹配路由

application.yml
spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: https://example.org
        predicates:
        - Path=/foo/{segment},/bar/{segment}

⑨Query Route Predicate

Query Route Predicate Factory 根据请求中的两个参数进行断言匹配，断言匹配成功进行转发，否则不进行转发。

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

⑩Weight Route Predicate

WeightAddrRoutePredicate由group和weight(权重数值)组成，表示将相同的请求根据权重跳转到不同的uri地址，要求group的名称必须一致，配置如下

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

💧ReadBodyPredicateFactory Route Predicate

SCG自带ReadBodyPredicateFactory断言，可以将body中的内容读取到exchange对象中，使用exchange.getAttribute("cachedRequestBodyObject")获取

但是当body为空时，无法匹配该路由，导致返回404错误。

        - id: r_fapi #测试
          uri: lb://LIZZ-GATEWAY
          predicates:
            - Path=/fapi/**
            - name: ReadBodyPredicateFactory #读取body断言
              args:
                inClass: "#{T(String)}" #body数据类型
                predicate: "#{@testRequestBody}" #自定义断言处理器

💧RemoteAddr Route Predicate

RemoteAddr Route Predicate Factory 配置一个IPv4或者IPv6网段的字符串或者IP。当请求IP地址在网段之内或者和配置的IP相同，断言匹配成功进行转发，否则不进行转发。

七、Filter的使用

1.定义

路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应，路由过滤器只能指定路由进行使用。
Spring Cloud Gateway 内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生

2.Spring Cloud Gateway的Filter

①生命周期

（业务逻辑之前和业务逻辑之后）

②种类，Only Two

Ⅰ、GatewayFilter （单一）

Spring Cloud Gateway

Ⅱ、GlobalFilter（全局）

3.常用的GatewayFilter

🐟AddRequestParameter GatewayFilter Factory

输入两个参数：Request Query Name、Value，向下游请求地址添加 URL 参数信息

server:
  port: 9588

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true #开启从注册中心动态创建路由的功能
          lower-case-service-id: true #使用小写服务名，默认是大写
      routes:
        - id: payment_routh #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: lb://cloud-provider-payment #匹配后的目标服务地址，供服务的路由地址
          #uri: http://localhost:8001 #匹配后提供服务的路由地址
          filters:
            - AddRequestParameter=X-Request-Id,1024 #过滤器工厂会在匹配的请求头加上一对请求头，名称为X-Request-Id值为1024
          predicates:
            - Path=/paymentInfo/**        # 断言，路径相匹配的进行路由
            - Method=GET,POST

eureka:
  instance:
    hostname: cloud-gateway-service
  client: #服务提供者provider注册进eureka服务列表内
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

🐟 AddRequestHeader GatewayFilter Factory

输入两个参数：Header Name、Value，向下游请求地址添加 Header 信息，示例配置：

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://anoyi.com
        filters:
        - AddRequestHeader=X-Request-Foo, Bar

AddRequestHeader 结合 Path 路由，再添加 Header 信息，示例配置

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://anoyi.com
        predicates:
        - Path=/foo/{segment}
        filters:
        - AddRequestHeader=X-Request-Foo, Bar-{segment}

🐟 AddResponseHeader GatewayFilter Factory

输入两个参数：Header Name、Value，下游请求完成后在 Response 添加 Header 信息，示例配置：

spring:
  cloud:
    gateway:
      routes:
      - id: add_response_header_route
        uri: https://anoyi.com
        filters:
        - AddResponseHeader=X-Response-Foo, Bar

🐟DedupeResponseHeader GatewayFilter Factory

输入两个参数：Header Name、Strategy【可选】，Header Name 可以多个，用空格隔开，示例配置：

spring:
  cloud:
    gateway:
      routes:
      - id: dedupe_response_header_route
        uri: https://anoyi.com
        filters:
        - DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin

如上所示，当下游和 Spring Cloud Gateway 都设置跨域时，将在 Response Header 中移除重复的 Access-Control-Allow-Credentials 和 Access-Control-Allow-Origin。

strategy 可设置的值以及配置方式如下：

RETAIN_FIRST：保留第一个值【默认】
RETAIN_LAST：保留最后一个值
RETAIN_UNIQUE：保留所有唯一值，以它们第一次出现的顺序保留

spring:
  cloud:
    gateway:
      routes:
      - id: dedupe_response_header_route
        uri: https://anoyi.com
        filters:
        - DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin, RETAIN_LAST

具体可以参考：Spring Cloud Gateway - 过滤法则 - 简书 (jianshu.com)

4.自定义过滤器

自定义全局GlobalFilter

@Component //必须加，必须加，必须加
public class MyLogGateWayFilter implements GlobalFilter,Ordered
{
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain)
    {
        System.out.println("time:"+new Date()+"\t 执行了自定义的全局过滤器: "+"MyLogGateWayFilter"+"hello");

        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        if (uname == null) {
            System.out.println("****用户名为null，无法登录");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder()
    {
        return 0;
    }
}

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

gateway

新一代网关