SpringCloud学习笔记【十一】服务网关Spring Cloud Gateway

目录

• SpringCloud Gateway概述
  • 是什么？
  • 有哪些特性？
• 三大概念
• 工作流程
• Gateway服务搭建
  • 创建模块，引入依赖
  • 编写yml
  • 主启动类
  • 测试启动
• Gateway的网关配置方式
  • yml配置
  • 注入RouteLocator的Bean
• 配置动态路由
• Route Predicate Factories
  • 举个例子
  • 完整版列举
• Filter
  • 自定义过滤器
• 源码下载

SpringCloud Gateway概述

是什么？

Spring Cloud Gateway is an intelligent and programmable router based on Project Reactor.

官网：https://spring.io/projects/spring-cloud-gateway

在云架构中运行着众多客户端和服务端，API网关的存在提供了保护和路由消息，隐藏服务，限制负载等等功能。

Spring Cloud Gateway提供了一个在Spring生态系统之上构建的API网关，包括：Spring 5，Spring Boot 2和Project Reactor。 Spring Cloud Gateway旨在提供一种简单而有效的方法来对API进行路由，提供精准控制。

为了提升网关的性能，Spring Cloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。

SpringCloud Gateway的目标是：提供统一的路由方式且基于FilterChain的方式提供网关基本的功能，例如：安全，监控/指标，弹性，限流等等。

有哪些特性？

• 基于SpringFramework5，ProjectReactor和SpringBoot2.0进行构建
• 能够匹配任何任何请求属性
• 可以对路由指定Predicates和Filters
• 集成断路器
• 集成Spring Cloud服务发现
• 易于编写的Predicates和Filters
• 支持请求限流
• 支持路径重写

三大概念

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

断言：参考Java8的java.util.function.Predicate，开发人员可以匹配HTTP请求中的所有内容，例如请求头或请求参数，如果请求与断言相匹配则进行路由。

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

一个web请求，通过一些匹配条件，定位到真正的服务节点，在这个转发的过程中，进行一些精细化的控制。

• predicate就是匹配条件
• filter就是拦截器
• predicate + filter + 目标uri实现路由route

工作流程

下图总体上描述了Spring Cloud Gateway的工作流程：

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

2. 如果Gateway Handler Mapping确定请求与路由匹配，则将其发送到Gateway Web Handler。

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

4. 过滤器由虚线分隔的原因是，过滤器可以在发送代理请求之前或之后执行逻辑。

核心：路由转发+过滤器链

Gateway服务搭建

创建模块，引入依赖

引入spring-cloud-starter-gateway核心组件，其次，这个服务本身也许要注册进Eureka，因此引入spring-cloud-starter-netflix-eureka-client。

        <!--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>

注意：不能引入spring-boot-starter-web依赖

编写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          #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/**         # 断言，路径相匹配的进行路由

        - id: payment_routh2 #payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001          #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
            #- After=2020-02-21T15:51:37.485+08:00[Asia/Shanghai]
            #- Cookie=username,zzyy
            #- Header=X-Request-Id, d+  # 请求头要有X-Request-Id属性并且值为整数的正则表达式

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

这段yml配置内容比较多：

• 确定该服务的端口号9527。
• 确定了application.name为cloud-gateway。
• 开启从注册中心动态创建路由的功能，利用微服务名进行路由。
• 定义了两段路由，每段路由标明：id，uri和Predicate。
• 将该服务注册进eureka的服务列表。

主启动类

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

测试启动

依次启动7001注册中心，8001服务和9527网关服务，访问localhost:7001/

由于网关的存在，我们可以访问：http://localhost:9527/payment/1，能够成功访问到8001服务的接口。

Gateway的网关配置方式

yml配置

我们之前已经配置过了：

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

注入RouteLocator的Bean

@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {

        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();

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

        return routes.build();
    }
}

配置动态路由

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

server:
  port: 9527

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

        - id: payment_routh2 #payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
            #- After=2020-02-21T15:51:37.485+08:00[Asia/Shanghai]
            #- Cookie=username,zzyy
            #- Header=X-Request-Id, d+  # 请求头要有X-Request-Id属性并且值为整数的正则表达式

访问localhost:9527/payment/lb，根据获取到的服务的路由地址，动态切换路由。

Route Predicate Factories

https://docs.spring.io/spring-cloud-gateway/docs/2.2.5.RELEASE/reference/html/#gateway-request-predicates-factories

Spring Cloud Gateway matches routes as part of the Spring WebFlux HandlerMapping infrastructure. Spring Cloud Gateway includes many built-in route predicate factories. All of these predicates match on different attributes of the HTTP request. You can combine multiple route predicate factories with logical and statements.

SpringCloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。

Spring Cloud Gateway包括许多内置的Route Predicate工厂，所有这些Predicate都与HTTP请求的不同属性匹配，多个RoutePredicate工厂可以进行组合。

SpringCloud Gateway创建Route对象时，使用RoutePredicateFactory创建Predicate对象，Predicate对象可以赋值给Route。

你可以通过and逻辑组合多种route predicate factories。举几个例子：

举个例子

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/**         # 断言，路径相匹配的进行路由
            - Before=2020-11-26T21:27:26.256+08:00[Asia/Shanghai]

        - id: payment_routh2 #payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名
          #uri: http://localhost:8001          #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
            - After=2020-11-25T22:42:23.608+08:00[Asia/Shanghai]
            - Cookie=username,hyh

cookie可以通过curl命令测试：

$ curl http://localhost:9527/payment/lb --cookie "username=hyh"

header测试：

$ http://localhost:9527/payment/lb --H "X-Request-Id:123"

完整版列举

        predicates:
        - Before=2017-01-20T17:42:47.789-07:00[America/Denver]  # 在..之前可以匹配
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]   # 在..之后可以匹配
        - Between=xxx,xxx										# 在..之间可以匹配
        - Cookie=chocolate, ch.p								# 带cookie
        - Header=X-Request-Id, d+								# 规定header
        - Host=**.somehost.org,**.anotherhost.org				# 规定host
        - Method=GET,POST										# 规定请求方法
        - Path=/red/{segment},/blue/{segment}					# 规定请求路径
        - Query=green											# 规定请求参数
        - RemoteAddr=192.168.1.1/24								# 规定remoteAddr
        
        # 将80%的流量转到weighthigh.org，20%转到weightlow.org
      - id: weight_high
        uri: https://weighthigh.org
        predicates:
        - Weight=group1, 8
      - id: weight_low
        uri: https://weightlow.org
        predicates:
        - Weight=group1, 2

Filter

Route filters allow the modification of the incoming HTTP request or outgoing HTTP response in some manner. Route filters are scoped to a particular route. Spring Cloud Gateway includes many built-in GatewayFilter Factories.

路由过滤器允许以某种方式修改传入的HTTP请求或传出的HTTP响应。

路由过滤器适用于特定路由。

Spring Cloud Gateway包括许多内置的GatewayFilter工厂，感兴趣可以查看官网。

自定义过滤器

@Slf4j
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("================come in myGlobalFilter" + new Date() + "==================");
        String name = exchange.getRequest().getQueryParams().getFirst("name");
        if (name == null || name.length() == 0) {
            log.info("=======================非法用户,name为null==============================");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        log.info("=======welcome! name =  " + name + "=======================");
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

源码下载

本系列文章为《尚硅谷SpringCloud教程》的学习笔记【版本稍微有些不同，后续遇到bug再做相关说明】，主要做一个长期的记录，为以后学习的同学提供示例，代码同步更新到Gitee：https://gitee.com/tqbx/spring-cloud-learning，并且以标签的形式详细区分每个步骤，这个系列文章也会同步更新。