11.Cloud Gateway路由网关

1、概述简介

1.SpringCloud Gateway是什么？

  服务网关还可以用Zuul网关，但是Zuul网关由于一些维护问题，所以这里我们学习Gateway网关，SpringCloud全家桶里有个很重要的组件就是网关， 在1.x的版本中都是采用Zuul网关；但在2.x版本中，Zuul的升级一直跳票，SpringCloud最后自己研发了一个网关代替Zuul，也就是说SpringCloud Gateway是原Zuul1.x版的替代品。SpringCloud Gateway是在Spring生态系统之上构建的API网关服务，基于Spring5，SpringBoot2和Project Reactor等技术。Gateway旨在提供一种简单而有效的方式来对API进行路由，以及提供一些强大的过滤功能，例如熔断、限流、重试等。

  SpringCloud Gateway作为SpringCloud生态系统中的网关，目的是替代Zuul，在SpringCloud2.0以上版本中，没有对新版本的Zuul2.0以上最新高新能版本进行集成，仍然使用的是Zuul 1.x非Reactor模式的老版本。而为了提升网关的性能，SpringCloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。

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

2.SpringCloud Gateway能做什么？

  反向代理、鉴权、流量控制、熔断、日志监控等等。SpringCloud Gateway具有如下特性：

  基于Spring Framework 5， Project Reactor和SpringBoot 2.x进行构建；

  动态路由：能够匹配任何请求属性；

  可以对路由指定Predicate（断言）和Filter（过滤器）；

  集成Hystrix的熔断器功能；

  集成SpringCloud服务发现功能；

  请求限流功能；

  支持路径重写等待。

3. 在整个微服务架构中，网关的位置
   
     可以看到网关是所有微服务的入口。

4. SpringCloud Gateway 与 Zuul的区别

  在SpringCloud Finchley正式版以前，SpringCloud推荐的网关是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 的性能较Zull 1.x有很大提升。根据官方提供的基准测试，SpringCloud Gateway的RPS（每秒请求数）是Zuul的1.6倍。

  SpringCloud Gateway基于Spring Framework 5， Project Reactor和SpringBoot 2.x进行构建，使用非阻塞API，还支持WebSocket。

2、核心概念

1. 路由 Route

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

2. 断言 Predicate

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

3. 过滤器 Filter

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

  总结：客户当发送Web请求，通过一些匹配条件，定位到真正的服务节点，并在这个转发过程的前后，进行一些精细化的控制，而断言就是这些匹配调教，过滤器可以理解为一个无所不能的拦截器，用来实现这些精细化的控制，有了断言和过滤器，再加上目标的URI，就可以实现一个具体的路由。

3、网关工作流程

  客户端向Spring Cloud Gateway发出请求。如果网关处理程序映射（Gateway Handler Mapping）确定请求与路由匹配，则将其发送到网关Web处理程序（Gateway Web Handler）。该处理程序通过特定于请求的过滤器链来运行请求。过滤器器由虚线分隔的原因是，过滤器可以在发送代理请求之前和之后运行逻辑。所有“前置”过滤器逻辑均被执行。然后发出代理请求。发出代理请求后，将运行“后置”过滤器逻辑。图中虚线左边的对应于前置过滤器，虚线右边的对应于后置过滤器。

  前置过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等；后置过滤器可以做响应内容、响应头的修改、日志的输出、流量监控等。SpringCloud Gateway的核心逻辑其实就是路由转发和执行过滤器链。

4、入门配置

1.新建Module：cloud-gateway-gateway9527作为网关微服务，在网关模块的POM文件在服务注册中心必要的依赖以外还需要引入SpringCloud Gateway的依赖（版本号已经在父工程中统一配置），需要注意的是，网关微服务不需要引入Web启动器，不然会报错

2.POM

<?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>cloud2020</artifactId>
        <groupId>com.atguigu.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-gateway-gateway9527</artifactId>
    <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.atguigu.springcloud</groupId>
            <artifactId>cloud-api-common</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.主启动类

package com.atguigu.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

/**
 * @author java_boy
 * @create 2021-03-03 20:57
 */
@SpringBootApplication
@EnableEurekaClient
public class GateWayMain9527 {
    public static void main(String[] args) {
        SpringApplication.run(GateWayMain9527.class,args);
    }
}

4.YML
  以9527端口，服务名为cloud-gateway将自己注册进Eureka服务注册中心；

  设定9527网关要对服务提供方提供的8001端口微服务进行路由处理，我们不想暴露8001端口，希望在8001端口外面套上一层网关的9527端口，在8001微服务中有如下的两个服务：

@GetMapping("/payment/get/{id}")
public CommonResult getPaymentById(@PathVariable("id") Long id);

@GetMapping("/payment/lb")
public String getPaymentLB();

  为了配置对上面两个服务的路由，我们修改9527网关微服务的配置文件application.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/**         # 断言，路径相匹配的进行路由
            #- 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
  client: #服务提供者provider注册进eureka服务列表内
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

  在路由routes中我们配置了两个路由，一个是针对8001的getPaymentById服务，另一个是针对8001的getPaymentLB服务，然后我们分别启动Eureka服务注册中心、服务提供方8001微服务、9527网关微服务。我们发现，在添加网关前，我们需要通过 http://localhost:8001/payment/get/4 来访问服务提供方的服务，但是现在不仅访问提供服务方可以访问其服务，我们通过访问网关也可以访问到服务提供方的微服务：

  这样的话用网关对微服务进行路由访问，就可以不再对外暴露微服务的真实地址，而是统一暴露为网关的地址。

  SpringCloud Gateway的网关路由有两种配置方式，一种就是上面通过配置文件application.yml进行网关路由配置，还可以在代码中注入RouteLocator的Bean进行配置，下面实现用编码的方式，实现通过9527网关对百度新闻的访问。

  非配置文件，编码方式实现SpringCloud Gateway的路由配置

  在9527网关微服务中编写如下的配置类：

package com.atguigu.springcloud.config;

import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author java_boy
 * @create 2021-03-03 22:20
 */
@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();
    }
}

  上面的配置类注入RouteLocator的Bean，其配置的一个id为"path_route"的路由，当访问地址http://localhost:9527/guonei 时，该路由会将访问自动转发到 http://news.baidu.com/guonei ：

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

  在上面的yml配置文件中，我们把路由地址写死了，这明显应该是程序中避免的。所以更好的方式是通过微服务名来实现动态路由。

  默认情况下Gateway会根据注册中心注册的服务列表，以注册中心上微服务名为路径创建动态路由进行转发，从而实现动态路由的功能。为了演示SpringCloud Gateway实现的动态路由，我们启用服务提供方集群，使8001/8002微服务都启动，让CLOUD-PAYMENT-SERVICE服务对应于两个具体服务实例：

  为了实现网关根据微服务名对服务进行动态路由，需要在网关微服务配置文件中开启从注册中心动态创建路由的功能，添加如下配置：

spring:
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true #开启从注册中心动态创建路由的功能，利用微服务名进行路由

  然后将原来配置文件中写死的路由地址改为注册中心的服务名：

uri: lb://cloud-payment-service #匹配后提供服务的路由地址

  然后通过网关我们访问CLOUD-PAYMENT-SERVICE服务，可以看到网关同之前用过的Ribbon一样，可以实现动态路由，可以看出其默认的负载均衡算法也是轮询负载均衡：

6、Predicate

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

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

  SpringCloud Gateway创建Route对象时，使用RoutePredicateFactory创建Predicate对象，Predicate对象可以赋值给Route。SpringCloud Gateway包括许多内置的Route Predicate Factories。

  所有这些谓词都匹配HTTP请求的不同属性。多种谓词工厂可以组合，并通过逻辑and。

  1.有哪几种?

  2.举例:After、Before、Between
  9527的yml 配置：

predicates:
  - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
  - After=2021-03-04T13:31:47.739+08:00[Asia/Shanghai]

  如何获得时间串串？

  替换成这个时间，并往后调一小时

- After=2021-03-04T14:35:47.739+08:00[Asia/Shanghai]

  只有在这个点之后才能被访问，否则是false，不能访问。那我们来看一下访问情况

  After是在时间之后，Before是在时间之前，Between是在之间，需要传两个时间，就不详细写了
  3.Cookie

  修改yml：

predicates:
  - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
  - After=2021-03-04T13:35:47.739+08:00[Asia/Shanghai]
  - Cookie=username,zzyy

  重启9527，使用curl 命令测试（curl是postman 图形化界面的命令），启动 cmd命令界面，不带cookie访问：

  404 not found不让访问，再来看带cookie：

  这样，时间上匹配且带着cookie就能访问了。
  4.Header

  修改 yml

predicates:
  - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
  #- After=2021-03-04T14:35:47.739+08:00[Asia/Shanghai]
  #- Cookie=username,zzyy
  - Header=X-Request-Id, \d+  # 请求头要有X-Request-Id属性并且值为整数的正则表达式

  重启9527，使用curl 命令测试

  5.Host

  修改yml

predicates:
  - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
  #- After=2021-03-04T14:35:47.739+08:00[Asia/Shanghai]
  #- Cookie=username,zzyy
  #- Header=X-Request-Id, \d+  # 请求头要有X-Request-Id属性并且值为整数的正则表达式
  - Host=**.atguigu.com

  重启，测试

  6.Method

  只有请求方法是GET方法才允许访问
  7.Path

predicates:
  - Path=/payment/lb/**         # 断言，路径相匹配的进行路由

  8.Query

  修改ym

predicates:
  - Path=/payment/lb/**         # 断言，路径相匹配的进行路由
  - Query=username, \d+  #要有参数名username并且值还要整数才能路由

  重启，测试

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

7、自定义过滤器

  SpringCloud Gateway中自定义过滤器要是实现两个接口org.springframework.cloud.gateway.filter.GlobalFilter 和org.springframework.core.Ordered，前者实现了全局过滤器，而后者规定了过滤器的执行顺序，该顺序数字越小，过滤器越先被执行。下面编写具体的过滤器并实现上面两个接口的方法：

package com.atguigu.springcloud.filter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.Date;

/**
 * @author java_boy
 * @create 2021-03-04 15:08
 */
@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("——————————————全局过滤器：" + new Date());
        //获得uname属性
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        //如果不包含该属性，则过滤器对请求进行拦截
        if (uname == null) {
            log.info("——————————————用户名为null，非法用户");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    /**
     * 加载过滤器的顺序，数字越小优先级越高
     * @return
     */
    @Override
    public int getOrder() {
        return 3;
    }
}

  这里需要注意的是，在getOrder()方法中，为了保证过滤器可拓展，尽量不要用0/1 这种拓展性不够好的数字，用0/1会使该自定义过滤器几乎永远先被执行，然后我们对服务进行访问我们可以发现，当我们包含请求参数uname时，可以正常访问，如果不含该请求参数，则访问无法正常进行。