【Spring Cloud】之 Gateway

电玩女神 2022-12-13 15:26 177阅读 0赞

# 一、Gateway 简介 #

--------------------

### 1、Gateway 是什么 ###

Cloud 全家桶中有个很重要的组件就是网关，在 1.x 版本中都是采用的 Zuul 网关；但在 2.x 版本中，Zuul 的升级一直跳票，Spring Cloud 最后自己研发了一个网关替代 Zuul，一句话总结就是：Gateway 是原 Zuul 1.x 版的替代。更多介绍参考官网文档：[https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/][https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html]

![在这里插入图片描述][20201012174040821.png_pic_center]

Gateway 是在 Spring 生态系统之上构建的 API 网关服务，基于 Spring 5，Spring Boot 2 和 Project Reactor 等技术，旨在提供一种简单而有效的方式来对 API 进行路由管理，以及提供统一的路由方式且基于 Filter 链的方式提供了网关基本功能，例如：**反向代理、鉴权、流量控制、熔断、日志监控**等。

在 Spring Cloud 2.0 以上版本中，没有的新版本的 Zuul 2.0 以上最新高性能版本进行集成，仍然还是使用的 Zuul 1.x 非 Reactor 模式的老版本，而未来提升网关的性能，SpringCloud Gateway 是基于 WebFlux 框架实现的，而 WebFlux 框架底层则使用了高性能的 Reactor 模式通信框架 Netty。

微服务架构中网关所处的位置如图：

![在这里插入图片描述][20201012174102220.png_pic_center]

### 2、Zuul 和 Gateway ###

**为什么选择 Gateway**

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

Gateway 是基于异步非阻塞模型上进行开发的，性能方面不需要担心。虽然 Netflix 早就发布了最新的 Zuul 2.x 版本，但 Spring Cloud 貌似没有整合计划，而且 Netflix 组件都宣布进入维护期，不知前景如何？

多方面综合考虑，Gateway 是很理想的网关选择。

**SpringCloud Gateway 的特性**

*  基于 Spring Framework 5，Project Reactor 和 Spring Boot 2.0 进行构建；
 *  动态路由：能够匹配任何请求属性；
 *  可以对路由指定 Predictate（断言）和 Filter（过滤器）；
 *  集成 Hystrix 的断路器功能；
 *  集成 Spring Cloud 服务发现功能；
 *  易于编写的 Predictate（断言）和 Filter（过滤器）；
 *  请求限流功能；
 *  支持路径重写。

**Gateway 模型**

Gateway 模型使用的是 WebFlux：

传统的 Web 框架，比如说：Struts2，SpringMVC 等都是基于 Servlet API 与 Servlet 容器基础之上运行的。但是，在 Servlet 3.1 之后有了异步非阻塞的支持，而 WebFlux 是一个典型的非阻塞异步的框架，它的核心是基于 Reactor 的相关 API 实现的。相对于传统的 Web 框架来说，它可以运行在诸如 Netty、Undertow 以及支持 Servlet 3.1 的容器上。非阻塞式 + 函数式编程（Spring 5 必须使用 Java 8）。

Spring WebFlux 是 Spring 5.0 引入的新的响应式框架，区别于 Spring MVC，它不需要依赖 Servlet API，它是完全异步非阻塞的，并且基于 Reactor 来实现响应式流规范。更多资料参考官网：[https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html\#spring-webflux][https_docs.spring.io_spring_docs_current_spring-framework-reference_web-reactive.html_spring-webflux]

### 3、Gateway 三大核心概念 ###

*  Route(路由)：路由是构建网关的基本模块，它由 ID、目标 URI 等一系列的断言和过滤器组成，如断言为 true 则匹配该路由
 *  Predicate(断言)：参考的是 Java8 的 java.util.function.Predicate，开发人员可以匹配 HTTP 请求中的所有内容(例如请求头或请求参数)，如果请求与断言相匹配则进行路由
 *  Filter(过滤)：指的是 Spring 框架中 GatewayFilter 的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改

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

### 4、Gateway 工作流程 ###

参考官网上的流程图：

![在这里插入图片描述][20201012174117951.png_pic_center]

客户端向 Spring Cloud Gateway 发出请求，然后在 Gateway Handler Mapping 中找到与请求向匹配的路由，将其发送到 Gateway Web Handler。

Handler 再通过制定的过滤器链来讲请求发送到我们实际的服务执行业务逻辑，然后返回。

过滤器之间用虚线分开是因为 过滤器可能会在发送代理请求之前（“pre”）或之后（“post”）执行业务逻辑。

Filter 在 “pre” 类型的过滤器可以做参数校验、前线校验、流量监控、日志输出、协议转换等，在 post 类型的过滤器中可以做相应内容、响应头的修改、日志的输出、流量监控等有着非常重要的作用。

整个工作流程的核心逻辑是：**路由转发 + 执行过滤器链**

# 二、Gateway 的使用 #

--------------------

### 1、整合 Gateway 组件 ###

引入 Gateway 依赖包：

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

在 YML 配置文件中添加网关路由配置：

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

当然除了在配置文件中配置网关路由外还可以通过在代码中注入 RouteLocator 的 Bean 来添加路由规则：

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;
    
    @Configuration
    public class GateWayConfig { 
        @Bean
        public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) { 
            RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
    
            // 添加百度国外新闻路由规则
            routes.route("path_route_news",
                    r -> r.path("/guonei")
                         .uri("http://news.baidu.com/guonei")).build();
    
            return routes.build();
        }
    }

### 2、动态路由 ###

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

修改相应的 YML 配置文件：

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

需要注意的是 uri 的协议 lb，表示启用 Gateway 的负载均衡功能，lb://serverName 是 spring cloud gatway 在微服务中自动为我们创建的负载均衡 uri。

### 3、Predicate 断言 ###

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

Spring Cloud Gateway 创建 Route 对象时，使用 RoutePredictateFactory 创建 Predictate 对象，Predictate 对象可以赋值给 Route。

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

常用的 Route Predicate：

*  After Route Predicate
 *  Before Route Predicate
 *  Between Route Predicate
 *  Cookie Route Predicate
 *  Header Route Predicate
 *  Host Route Predicate
 *  Method Route Predicate
 *  Path Route Predicate
 *  Query Route Predicate
 *  RemoteAddr Route Predicate
 *  Weight Route Predicate

具体用法可以参考官网：[https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/\#gateway-request-predicates-factories][https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html_gateway-request-predicates-factories]

### 4、Filter 过滤器 ###

Spring Cloud Gateway 内置了多种路由过滤器，他们都由 GatewayFilter 的工厂类来生产。路由过滤器可用于修改进入的 HTTP 请求和返回的 HTTP 相应，路由过滤器只能通过指定路由进行使用。

Filter 的生命周期包含两种：

*  Pre
 *  Post

种类也包含两种：

*  GatewayFilter：参考官网资料：[https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/\#gatewayfilter-factories][https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html_gatewayfilter-factories]
 *  GlobalFilter：参考官网资料：[https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/\#global-filters][https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html_global-filters]

常用的 GatewayFilter 为 AddRequestParameter：

spring:
      cloud:
        gateway:
    	  routes:
            - id: payment_routh  			   # 路由的ID，没有固定规则但要求唯一，建议配合服务名
              uri: lb://cloud-payment-service 	# 匹配后提供服务的路由地址
              filters:
              	- AddRequestParameter=X-Request-Id, 1024 # 过滤器工厂会在匹配的请求头加上一对请求头
              predicates:
                - Path=/payment/get/**          # 断言，路径相匹配的进行路由

**自定义过滤器**

我们可以通过自定义全局 GlobalFilter 来记录全局日志记录、统一网关鉴权等，实现方式主要是实现 GlobalFilter 和 Ordered 这两个接口：

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;
    
    @Component
    @Slf4j
    public class MyLogGateWayFilter implements GlobalFilter, Ordered { 
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { 
            log.info("----- come in MyLogGateWayFilter: "+new Date());
    
            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);
        }
    
        @Override
        public int getOrder() { 
            return 0;
        }
    }

[https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/
[20201012174040821.png_pic_center]: /images/20221123/3d218fab59dd4d8d98d0d0e20c7255a4.png
[20201012174102220.png_pic_center]: /images/20221123/b1953014b53f497eb7db64a9fe6353ff.png
[https_docs.spring.io_spring_docs_current_spring-framework-reference_web-reactive.html_spring-webflux]: https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html#spring-webflux
[20201012174117951.png_pic_center]: /images/20221123/e121ea1531524efcbb45e44983b07be7.png
[https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html_gateway-request-predicates-factories]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#gateway-request-predicates-factories
[https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html_gatewayfilter-factories]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#gatewayfilter-factories
[https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html_global-filters]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#global-filters