服务网关(Gateway)

1、概述

官方网站

①、是什么

Cloud全家桶中有个很重要的组件就是网关，在1.x版本中都是采用的Zuul网关；但在2x版本中，zuul的升级一直跳票，SpringCloud最后自己研发了一个网关替代Zuul,那就是SpringCloud Gateway；SpringCloud Gateway作为Spring Cloud 生态系统中的网关，目标是替代Zuul，在Spring Cloud 2.0以上版本中，没有对新版本的Zuul 2.0以上最新高性能版本进行集成，仍然还是使用的Zuul 1.x非Reactor模式的老版本。而为了提升网关的性能，SpringCloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty

Gateway是在Spring生态系统之上构建的API网关服务，基于Spring 5， Spring Boot 2和 Project Reactor等技术。Gateway旨在提供一种简单而有效的方式来对API进行路由，以及提供一些强大的过滤器功能，例如:熔断、限流、重试等.

②、能干嘛

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

③、微服务架构中，网关在哪儿

④、有Zuul了为什么要选择Gateway

Ⅰ、Zuul2迟迟不发

一方面因为Zuul1.0已经进入了维护阶段，而且Gateway是SpringCloud团队研发的，是亲儿子产品，值得信赖。而且很多功能Zuul都没有用起来也非常的简单便捷。

Gateway是基于异步非阻塞模型上进行开发的，性能方面不需要担心。虽然Netflix早就发布了最新的Zuul 2.x，但Spring Cloud 貌似没有整合计划。而且Netflix相关组件都宣布进入维护期，按照原有的计划，本来是打算出一个Zuul2来代替Zuul的，但是此期间Zuul的核心成员跳槽了，还不是一个，是三个，原因可能是被挖走了，又或是高手之间出现了理念分歧，所以Zuul2就迟迟不发，青黄不接，但是Cloud社区等不了啊，就自己研发了GateWay。

Ⅱ、Gateway的特性

基于Spring Framework 5，Project Reactor和Spring Boot 2.0进行构建

• 动态路由：能够匹配任何请求属性
• 可以对路由指定Predicate （断言）和Filter （过滤器）
• 集成Hystrix的断路器功能
• 集成Spring Cloud服务发现功能
• 易于编写的 Predicate （断言）和Filter （过滤器）
• 请求限流功能
• 支持路径重写。

Ⅲ、两者区别

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

• Zuul 1.x，是一个基于阻塞I/O的API Gateway
• Zuul 1.x基于==Servlet 2.5使用阻塞架构==它不支持任何长连接(如WebSocket) Zuul的设计模式和Nginx较像，每次I/О操作都是从工作线程中选择一个执行，请求线程被阻塞到工作线程完成，但是差别是Nginx用C+＋实现，Zuul用Java实现，而JVM本身会有第—次加载较慢的情况，使得Zuul的性能相对较差。
• Zuul 2.x理念更先进，想基于Netty非阻塞和支持长连接，但SpringCloud目前还没有整合。Zuul 2.x的性能较Zul 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紧密集成拥有更好的开发体验

⑤、Zuul 1.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就会为其绑定一个线程，在并发不高的场景下这种模型是适用的。但是一旦高并发（比如抽风用jmeter），线程数量就会上涨，而线程资源代价是昂贵的（上线文切换，内存消耗大）严重影响请求的处理时间。在一些简单业务场景下，不希望为每个request分配一个线程，只需要1个或几个线程就能应对极大并发的请求，这种业务场景下servlet模型没有优势

所以Zuul 1.X是基于servlet之上的一个阻塞式处理模型，即spring实现了处理所有request请求的一个servlet (DispatcherServlet)并由该servlet阻塞式处理处理。所以Springcloud zuul无法摆脱servlet模型的弊端

⑥、Gateway模型

WebFlux参考文档

WebFlux是一个非阻塞的Web框架，它是Spring5.0所带来的新特性

传统的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来实现响应式流规范。

2、三大核心概念

①、路由Route

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

回顾文章开头的微服务架构中网关的地位的那张图，网关可以将请求转发给服务A,B,C,D，但是到底发给谁也需要遵循对应的路由规则，好比我牙疼，进了医院，挂了口腔科的张大夫号，但是张大夫病号满了怎么办，所以还是要遵循一定的路由匹配规则，才能正确的转发

②、断言Predicate

参考的是Java8的java.util.function.Predicate，返回的就是一个Boolean类型，开发人员可以匹配HTTP请求中的所有内容（例如请求头或请求参数），如果请求与断言相匹配则进行路由，比如我现在挂着河北师大的学生卡要进学校，我现在要进学校，需要判断我到底是不是河北师大的学生，如果是我才能进，不是就不能进

③、过滤Filter

指的是Spring框架中GatewayFilter的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改。对应于断言，我现在进了学校，在进教室的时候，学校规定不能穿拖鞋上课，老师送我一双鞋让我穿上再上，这就叫过滤

④、总结

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

3、Gateway工作流程

贴上官网扒下来的图

解释一下：

客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到GatewayWeb Handler。
Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“pre”)或之后(“post”)执行业务逻辑。而Filter在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等，在“post”类型的过滤器中可以做响应内容、响应头的修改，日志的输出，流量监控等有着非常重要的作用。

核心就是路由转发+执行过滤链

4、入门配置

①、建module

名称我写错了，Gateway是一个单词，不是两个，误用了驼峰命名

②、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>SpringCloudDemo</artifactId>
        <groupId>com.phz.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>GateWay9527</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>
        <dependency>
            <groupId>com.phz.springcloud</groupId>
            <artifactId>CloudAPI</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--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>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

③、YML

server:
  port: 9527

spring:
  application:
    name: gateway

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

④、主启动

/**
 * @author PengHuAnZhi
 * @createTime 2021/2/15 11:39
 * @projectName SpringCloudDemo
 * @className GateWayMain9527.java
 * @description TODO
 */
@SpringBootApplication
@EnableEurekaClient
public class GateWayMain9527 {
    
    
    public static void main(String[] args) {
    
    
        SpringApplication.run(GateWayMain9527.class, args);
    }
}

⑤、配置Gateway路由

以前对于某个服务，我们是不是用到了localhost:8001/payment/get/1这种方式直接访问呀，现在我们需要加一层网关GateWay，访问对应服务端口就应该交给GateWay来帮我们完成，我们调服务的时候直接全部调用9527即可，也可以理解为我不想暴露那么多的服务端口，我只暴露一个9527就可以访问所有的服务

先修改9527配置文件

server:
  port: 9527

spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: get_payment_route # 路由的id,没有规定规则但要求唯一,建议配合服务名
          uri: http://localhost:8001 #匹配后提供服务的路由地址
          predicates: # 断言，路径相匹配的进行路由
            - Path=/payment/get/** #**为通配符，因为我们controller方法中get后面跟查询的id
        - id: insert_payment_route
          uri: http://localhost:8001
          predicates:
            - Path=/payment/insert
        - id: discovery_payment_route
          uri: http://localhost:8001
          predicates:
            - Path=/payment/discovery
        - id: server_port_payment_route
          uri: http://localhost:8001
          predicates:
            - Path=/payment/getServerPort
        - id: timeout_payment_route
          uri: http://localhost:8001
          predicates:
            - Path=/payment/feign/timeout

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

⑥、测试

开启7001，8001，9527可以看到GateWay已经注册进Eureka中了

以前访问8001的get方法

而现在添加了网关再次访问，是不是也成功了。这样一来我们就可以慢慢开始淡化我们的真实网关了

⑦、Gateway的第二种配置方式

Ⅰ、创建config类

/**
 * @author PengHuAnZhi
 * @createTime 2021/2/15 15:15
 * @projectName SpringCloudDemo
 * @className GateWayConfig.java
 * @description TODO
 */
@Configuration
public class GateWayConfig {
    
    

    /**
     * 配置了一个id为route-name的路由规则
     * 当访问地址 http://localhost:9527/guonei时会自动转发到地址： http://news.baidu.com/guonei
     * @param builder
     * @return
     */
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
    
    
        RouteLocatorBuilder.Builder routes = builder.routes();
        routes.route("baidu_guonei_route",
                r -> r.path("/guonei")
                        .uri("http://news.baidu.com/guonei")).build();
        return routes.build();
    }

    @Bean
    public RouteLocator customRouteLocator2(RouteLocatorBuilder builder) {
    
    
        RouteLocatorBuilder.Builder routes = builder.routes();
        routes.route("baidu_guoji_route",
                r -> r.path("/guoji")
                        .uri("http://news.baidu.com/guoji")).build();
        return routes.build();
    }
}

Ⅱ、测试

5、新的问题

基础的入门配置就结束了，回过头来思考思考，我们在配置文件又或是Java代码中将路由规则写死了，且目标URL只有一个，但是微服务中服务一般都是集群，肯定不止一台，这样又冲突了啊，所以就体现了动态路由的必要性，也就是我们希望网关给我们集成负载均衡的功能

①、动态路由的配置

两个地方，discovery.locator.enabled设置为true，然后uri改为lb://服务名，重点是这个lb，uri以lb://开头（lb代表从注册中心获取服务），后面接的就是你需要转发到的服务名称

server:
  port: 9527

spring:
  application:
    name: gateway
  cloud:
    gateway:
    #和静态路由的区别在这儿，新增配置
      discovery:
        locator:
          enabled: true # 开启从注册中心动态创建路由的功能，利用微服务名称进行路由
      routes:
        - id: get_payment_route # 路由的id,没有规定规则但要求唯一,建议配合服务名
          #          uri: http://localhost:8001
          uri: lb://eureka-payment-service #匹配后提供服务的路由地址
          predicates: # 断言，路径相匹配的进行路由
        - id: insert_payment_route
          #路由的URI和以前配置负载均衡一样，直接写服务名就好
          #          uri: http://localhost:8001
          uri: lb://eureka-payment-service
          predicates:
            - Path=/payment/insert
        - id: discovery_payment_route
          #          uri: http://localhost:8001
          uri: lb://eureka-payment-service
          predicates:
            - Path=/payment/discovery
        - id: server_port_payment_route
          #          uri: http://localhost:8001
          uri: lb://eureka-payment-service
          predicates:
            - Path=/payment/getServerPort
        - id: timeout_payment_route
          #          uri: http://localhost:8001
          uri: lb://eureka-payment-service
          predicates:
            - Path=/payment/feign/timeout

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

②、测试

额外开启一个8003模拟集群，可以看到服务都在Eureka中注册成功

测试访问，负载均衡配置成功

6、Predicate

在启动GateWay的时候，我们注意一下控制台

里面有一个熟悉的Path节点，回想我们的配置文件routes节点，名称是一个复数，也就是routes节点下可以配置很多的路由，那么再看predicates，也是个复数，言下之意，也是可以配置很多的断言，在对比这个图来看，是不是意味着图中的节点都是能够配置在predicates节点下呢？

①、概述

官方参考文档

对应控制台中十一个不同的配置

来一波官方解释

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

②、After

看着官网配置直接复制粘贴，好说，但是这个串串是怎么来的呢

- After=2021-02-15T16:20:02.288+08:00[Asia/Shanghai]

其实是可以使用ZonedDateTime对象来生成的，测试代码如下

/**
 * @author PengHuAnZhi
 * @createTime 2021/2/15 16:18
 * @projectName SpringCloudDemo
 * @className Test.java
 * @description TODO
 */
public class Test {
    
    
    @org.junit.Test
    public void test() {
    
    
        ZonedDateTime zonedDateTime = ZonedDateTime.now();
        System.out.println(zonedDateTime);
    }
}

这个配置表示，在这个指定的时间段以后的请求才能被转发，否则拒绝，访问的时候会报404，我觉得有点像某些游戏活动开始时间还没到，但是先一步发布在游戏中，让玩家预览一下的那种。再想想有什么更大的用处呢？那就是秒杀！！

③、Before

看了After后，Before不用说了吧

- Before=2021-02-15T16:20:02.288+08:00[Asia/Shanghai]

④、Between

同样不多解释，仅仅多加一个时间而已

- Between=2021-02-15T16:20:02.288+08:00[Asia/Shanghai],2021-02-15T17:20:02.288+08:00[Asia/Shanghai]

⑤、Cookie

顾名思义，请求需要携带Cookie，否则404

- Cookie=username,phz #模拟需要携带用户名phz的Cookie才能访问

测试一下不带Cookie访问

如何携带Cookie呢？这回我用原始curl命令携带Cookie访问，测试通过

curl http://localhost:9527/payment/getServerPort --cookie "username=phz"

postman中携带Cookie也可以，但是需要进行相关的配置，配置过程中我的拦截器桥一直下载不成功，所以就不演示了，这里重点不在这。

⑥、Head

- Header=X-Request-Id,\d+ #请求头要有 X-Request-Id属性并且值为整数的正则表达式

测试还是curl

curl http://localhost:9527/payment/getServerPort --H "X-Request-Id:1234"

⑦、Host

- Host=**.phz.com

测试

curl http://localhost:9527/payment/getServerPort --H "Host:www.phz.com"

⑧、Method

- Method=GET

GET请求通过，POST不通过

⑨、Path

这个配置我们配置过了，不介绍

⑩、Query

- Query=username，ld+ #要有参数名usernane并且绵还要是整数才能路由

测试

curl http://localhost:9527/payment/getServerPort?username=123

7、Filter

①、概述

来一波官方介绍：路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应，路由过滤器只能指定路由进行使用。Spring Cloud Gateway内置了两种路由过滤器一个是GatewayFilter单一的，另一个是GlobalFilter全局的，他们都由GatewayFilter的工厂类产生，他们的生命周期也是两个，一个pre之前，一个post之后

虽说是两种路由过滤器，但实际由四十一个（31+10），官网放在这儿，自己查：点击跳转，感兴趣一个一个去试试，我们重点放在全局的自定义过滤器上

②、实现全局自定义过滤器

Ⅰ、创建自定义过滤器

需要实现GlobalFilter和Ordered两个接口，并重写两个方法

/**
 * @author PengHuAnZhi
 * @createTime 2021/2/15 17:09
 * @projectName SpringCloudDemo
 * @className MyLogGatewayFilter.java
 * @description TODO
 */
@Component
@Slf4j
public class MyLogGatewayFilter implements GlobalFilter, Ordered {
    
    
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
    
    
        log.info("进入MyLogGatewayFilter过滤器");
        String name = exchange.getRequest().getQueryParams().getFirst("userName");
        if (name == null) {
    
    
            log.info("非法用户");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
    
    
        //设置过滤器的等级，数字越小，等级越高，-2147483648~2147483647
        return 0;
    }
}

Ⅱ、测试

不携带username

携带username

到此为止，Gateway的简单使用就撒花完结了