Spring Cloud Gateway笔记

Spring Cloud Gateway是什么

• Spring Cloud出品的网关
• 底层是Netty、Reactor、WebFlux

Spring Cloud Gateway优点

性能强劲

• 是第一代网关Zuul1.x的1.6倍!
  zuul-and-gateway-linkerd/
• 功能强大
• 内置了很多实用功能，比如转发、监控、限流等
• 设计优雅，易扩展

Spring Cloud Gateway缺点

• 依赖Netty与Webflux ，有一定的适应成本
• Reactive编程模型，而非Servlet编程模型
• 不能在Servlet容器下工作，也不能构建成WAR包
• 不支持Spring Boot 1.x

核心概念

Route(路由)

Spring Cloud Gateway的基础元素，可简单理解成一条转发的规则。包含: ID、目标URL、Predicate集合以及Filter集合。

Predicate(谓词)

即java.util.function.Predicate，Spring Cloud Gateway使用Predicate实现路由的匹配条件。

Filter(过滤器)

修改请求以及响应

使用Gateway

1. 引入pom依赖

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

2. 添加配置

server:
  port: 8500
  
spring:
  application:
    name: mall-gateway
    gateway:
      discovery:
        locator:
          #让gateway从服务发现组件找到微服务，并反向代理
          enabled: true

可以看到，已经成功转发到mall-web-order服务接口

转发规律

• 访问${GATEWAY_URL}/{微服务X}/** 会转发到微服务X的/**路径

路由谓词工厂详解

下面开始学习Spring Cloud Gateway中内置的谓词工厂，包括：

谓词工厂
After
Before
Between
Cookie
Header
Host
Method
Path
Query
RemoteAddr

路由配置的两种形式

路由到指定URL

spring:
  cloud:
    gateway:
      routes:
      - id: {唯一标识}
        uri: http://www.baidu.com

表示访问 GATEWAY_URL/** 会转发到 http://www.baidu.com/**

这段配置不能直接使用，需要和下面的Predicate配合使用才行。

路由到服务发现组件上的微服务

spring:
  cloud:
    gateway:
      routes:
      - id: {唯一标识}
        # lb://表示从服务发现组件上找到指定微服务
        uri: lb://ms-user

表示访问 GATEWAY_URL/** 会转发到 ms-user 微服务的 /**

谓词工厂详解

下面正式探讨路由谓词工厂。Spring Cloud Gateway提供了十来种路由谓词工厂。为网关实现灵活的转发提供了基石。

After

示例：

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当请求时的时间After配置的时间时，才会转发到指定的微服务
            # 目前配置不会进该路由配置，所以返回404
            # 将时间改成 < now的时间，则访问localhost:8500/** -> mall-web-order/**
            - After=2020-12-20T06:06:06+08:00[Asia/Shanghai]

技巧：时间可使用 System.out.println(ZonedDateTime.now()); 打印，然后即可看到时区。例如：2019-08-10T16:50:42.579+08:00[Asia/Shanghai]

Before

示例：

spring:
  cloud:
    gateway:
      routes:
        - id: before_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当请求时的时间Before配置的时间时，才会转发到指定的微服务
            # 目前配置不会进该路由配置，所以返回404
            # 将时间改成 < now的时间，则访问localhost:8500/** -> mall-web-order/**
            - Before=2020-10-20T06:06:06+08:00[Asia/Shanghai]

Between

示例：

spring:
  cloud:
    gateway:
      routes:
        - id: between_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当请求时的时间Between配置的时间时，才会转发到指定的微服务
            # 因此，访问localhost:8500/** -> mall-web-order/**
            - Between=2020-10-20T06:06:06+08:00[Asia/Shanghai], 2020-10-31T06:06:06+08:00[Asia/Shanghai]

Cookie

spring:
  cloud:
    gateway:
      routes:
        - id: cookie_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当带有名为somecookie，并且值符合正则ch.p的Cookie时,才会转发到指定的微服务
            # 如Cookie满足条件，则访问http://localhost:8500/** -> mall-web-order/**
            - Cookie=somecookie, ch.p

Header

spring:
  cloud:
    gateway:
      routes:
        - id: header_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当带有名为X-Request-Id，并且值符合正则\d+的Header时，才会转发到指定的微服务
            - Header=X-Request-Id, \d+

Host

spring:
  cloud:
    gateway:
      routes:
        - id: host_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当名为Host的Header符合**.somehost.org或**.anotherhost.org时，才会转发到指定的微服务
            - Host=**.somehost.org,**.anotherhost.org

Method

spring:
  cloud:
    gateway:
      routes:
        - id: method_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当HTTP请求方法是GET时，才会转发到指定的微服务
            - Method=GET

Path

spring:
  cloud:
    gateway:
      routes:
        - id: path_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当访问路径是/mall/*或者/mall/**，才会转发到指定的微服务
            # segment是一个特殊的占位符，单层路径匹配
            - Path=/mall/{segment},/mall/**

Query

示例1：

spring:
  cloud:
    gateway:
      routes:
        - id: query_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当请求带有token的参数，才会转发到用户微服务
            - Query=token

示例2：

spring:
  cloud:
    gateway:
      routes:
        - id: query_route
          uri: lb://mall-web-order
          predicates:
            # 当且仅当请求带有名为foo的参数，且参数值符合正则ba.，才会转发到用户微服务
            # eg. 访问http://localhost:8500/mall/api/killgoodsSpec/detail?id=25&baz=baz 
            - Query=foo, ba.

RemoteAddr

spring:
  cloud:
    gateway:
      routes:
        - id: remoteaddr_route
          uri: lb://mall-web-order
          predicates:
            # 请求IP是192.168.1.1/24网段，例如192.168.1.10，才会转发到用户微服务
            - RemoteAddr=192.168.1.1/24

过滤器工厂详解

过滤工厂