GateWay

本专栏学习内容来自尚硅谷周阳老师的视频

有兴趣的小伙伴可以点击视频地址观看

概述

SpringCloud Gateway 是 Spring Cloud 的一个全新项目，基于 Spring 5.0+Spring Boot 2.0 和 Project Reactor 等技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 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 链的方式提供了网关基本的功能，例如：安全，监控/指标，和限流。

三大核心概念

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

• Predicate(断言)：参考的是Java8的java.util.function.Predicate

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

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

GateWay工作流程

借用官网的一张图和介绍，应该没有能比官网讲的更清楚的了

入门配置

先搭建服务，无需启动类，只需要注册到Eureka就行

pom文件

<dependencies>
   <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>
   <dependency><!-- 引入自己定义的api通用包，可以使用Payment支付Entity -->
      <groupId>com.yellowstar.springcloud</groupId>
      <artifactId>cloud-api-commons</artifactId>
      <version>1.0-SNAPSHOT</version>
   </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>

配置文件

server:
  port: 9527
  
eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

主启动类

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

通过配置文件配置

接下来我们想实现一个功能，平时都是通过http://localhost:8001/payment/lb来访问8001支付服务，现在我们不想把真实地址暴露，想通过9527进行代理

修改配置文件

加上关于gateway配置即可

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

通过Bean配置

除了配置文件配置的方式以外，我们还可以通过代码中注入RouteLocator的Bean来进行配置

现在的需求是通过9527服务，代理到https://news.sina.com.cn/china

这样我们就可以通过localhost:9527/china来访问新浪新闻啦

@Configuration
public class GateWayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder){
        RouteLocatorBuilder.Builder routes = builder.routes();
        routes.route("news_sina_china",r -> r
                .path("/china") // 等同于predicates 访问路径localhost:9527/china
                .uri("https://news.sina.com.cn/china/")); //实际访问路径
        return routes.build();
    }
}

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

无论是通过配置文件还是Bean方式配置网关转发地址时，我们都是讲地址写死的，不利于扩展，包括在微服务的架构下，往往都需要实现负载均衡，那么就需要实现动态路由。

修改配置文件

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

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true # 开启从服务中心动态创建路由功能，实现动态路由
      routes:
        - id: payment_route 
#          uri: http://localhost:8001 
          uri: lb://CLOUD-PAYMENT-SERVICE # 匹配后提供服务的路由地址 lb表示负载均衡
          predicates:
            - Path=/payment/get/**
        - id: payment_route2 
#          uri: http://localhost:8001 
          uri: lb://CLOUD-PAYMENT-SERVICE # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/** 

Predicate的使用

概念

简单通俗来讲，这就是一个断言的作用，例如之前使用的Path=/payment/get/** 作用是：只要收到路径为/payment/get/**的请求，都将他转发到http://localhost:8001 下对应的请求（这里为了方便理解，就不使用服务名称来做路由地址）

而除了通过路径匹配之外，GateWay还为我们提供了多种匹配方式，详细可见 中文文档

使用

官方例子很多，咱们挑几个来学习一下

After

After 路由谓词工厂需要一个参数，即一个日期时间（这是一个java ZonedDateTime）。这个谓词匹配发生在指定日期时间之后的请求。

例如以下配置，表示该请求必须发生在2023年4月19日9点之后才能正常访问

spring:
  cloud:
    gateway:
      routes:
        - id: payment_route2 # 路由的id，没有固定规则但是要求唯一，建议配合服务名
          uri: http://localhost:8001 # 匹配后提供服务的路由地址
          predicates:
            - After=2023-04-19T09:00:00.000+08:00[Asia/Shanghai]

Cookie

Cookie 路由谓词工厂接受两个参数，即 cookie name 和一个 regexp（这是一个Java正则表达式）。这个谓词匹配具有给定名称且其值符合正则表达式的cookie。

例如以下配置，表示该请求cookie中必须带有username=yellowstar才能正常访问

spring:
  cloud:
    gateway:
      routes:
        - id: payment_route2 # 路由的id，没有固定规则但是要求唯一，建议配合服务名
          uri: http://localhost:8001 # 匹配后提供服务的路由地址
          predicates:
            - Cookie=username, yellowstar

Query

Query 路由谓词工厂需要两个参数：一个必需的 param 和一个可选的 regexp（这是一个Java正则表达式）。下面的例子配置了一个 query 路由谓词。

例如以下配置，表示该请求必须带有参数id为正数才能正常访问

spring:
  cloud:
    gateway:
      routes:
        - id: payment_route2 # 路由的id，没有固定规则但是要求唯一，建议配合服务名
          uri: http://localhost:8001 # 匹配后提供服务的路由地址
          predicates:
            - Query=id,\d+

Filter的使用

概念

路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应，路由过滤器只能指定路由进行使用。

Spring Cloud Gateway 内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生。

他与Predicate最大的不同在于可以修改HTTP请求和返回的HTTP响应，而Predicate只能进行匹配。

使用

官方的过滤器有很多，咱们就不一一介绍，有需要的同学可以查看 中文文档

咱们具体来讲讲自定义过滤器的使用，实际开发中也是自定义用的居多。

自定义过滤器要实现两个接口

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String username = exchange.getRequest().getQueryParams().getFirst("username");
        if (username == null) {
            log.error("用户名不存在");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

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

如果我们带有参数访问则可以成功，反之回报我们定的错误码