八、网关Gateway

旧城等待， 2023-05-21 15:13 12阅读 0赞

### 文章目录 ###

*  一、Gateway介绍
 *  二、Gateway的使用
 *   *  2.1. 入门
     *  2.2 通过微服务名实现动态路由
     *  2.3 Predicate的使用
     *  2.4 Filter 的使用

# 一、Gateway介绍 #

**① Getway 简介**

由于`Netflix`在`zull`、`zull2`的推出出现问题，`SpringCloud`推出了自己的网关`GeteWay`。

`Gateway`是`Spring Cloud`的一个全新项目，基于`Spring 5.0`\+`Spring Boot 2.0`和`Project Reactor`等技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的`API`路由管理方式。

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

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

**② Gateway 作用**

1.  反向代理
2.  鉴权
3.  流量控制
4.  熔断
5.  日志监控  
    ![微服务架构网关的位置][20200417135440428.png]

**③ Gateway 三大核心概念**

1.  `Route`（路由）  
    路由是构建网关的基本模块，它由`ID`，目标`URI`，一系列的断言和过滤器组成，如果断言为`true`则匹配该路由。
2.  `Predicate`（断言）  
    参考`JAVA8`的`java.util.function.Predicate`开发人员可以匹配`HTTP`请求中的所有内容（例如请求头和请求参数），如果请求与断言相匹配则进行路由
3.  Filter（过滤）  
    指的是`Spring`框架中`GatewayFilter`的实例，使用过滤器，可以在请求被路由前或之后对请求进行修改  
    ![Gateway核心概念][Gateway]  
    `web`请求通过一些匹配条件，定位到真正的服务节点，并在这个转发过程的前后，进行一些细化控制。  
    `pridicate`就是我们的匹配条件；而`filter`，就可以理解为一个无所不能的拦截器。有了这两个元素，再加上目标`url`，就可以实现一个具体的路由了。

**④ Gateway 流程**  
![Gateway流程][Gateway 1]  
客户端向`Spring Cloud Gateway`发出请求。然后在`Gateway Handler Mapping`中找到与请求相匹配的路由，将其发送到`GatewayWeb Handler`。

`Handler`再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。  
过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前( `pre`)或之后(`post` )执行业务逻辑。

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

**核心逻辑：路由转发+执行过滤器链**

# 二、Gateway的使用 #

## 2.1. 入门 ##

① 新建一个项目`cloud-gateway9527`，添加`Gateway`的依赖：

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

② 我们不想暴露8001项目的端口，因此在9527做路由映射，有两种路由映射方式：

**yml 配置**

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

**编码**

@Configuration
    public class GatewayConfig { 
        @Bean
        public RouteLocator customRouteLocator(RouteLocatorBuilder builder) { 
            RouteLocatorBuilder.Builder routes = builder.routes();
            routes.route("/payment_route2",
                    route -> route.path("/payment/discovery/**")
                            .uri("http://localhost:8001")
            );
            return routes.build();
        }
    }

③ 经测试，这两种方式均可行：  
![gateway测试][gateway]

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

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

需要注意的是`uri`的协议为`lb`，表示启用`Gateway`的负载均衡功能。修改`uri`即可：

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

## 2.3 Predicate的使用 ##

`Gateway`将路由匹配作为`Spring WebFlux HandlerMapping`基础架构的一部分。`Gateway`包括许多内置的`Route Predicate`工厂，如下图。所有这些`Predicate`都与`HTTP`请求的不同属性匹配。多个`Route Predicate`工厂可以进行组合。

`Gateway`创建`Route`对象时，使用`Route Predicate Factory`创建`Predicate`对象，`Predicate`对象可以赋值给`Route`。所有的 `Route Predicate`都对应着`HTTP`请求的不同属性。可以通过`and`相互组合。

**常用的`Route Predicate Factory`**:  
![Predicate的使用][Predicate]

**① After/Before/Between**

设置请求生效时间/失效时间，时间格式为`java8`新出的`java.time.ZonedDateTime`。

...
    predicates:
      - Path=/payment/discovery/** #路径相匹配的进行路由
      - After=2020-04-17T20:28:54.492+08:00[Asia/Shanghai]
      #- Before=2020-04-17T20:28:54.492+08:00[Asia/Shanghai]
      #- Between=2020-04-16T20:28:54.492+08:00[Asia/Shanghai], 2020-04-17T20:28:54.492+08:00[Asia/Shanghai]

**② Cookie/Header/HOST**

`Cookie Route Predicate`需要两个参数，一个是`Cookie name` ，一个是正则表达式。路由规则通过获取对应的`Cookie name`值和正则表达式去匹配。

路由规则通过`Header`去匹配。

路由规则通过`Host`去匹配。

...
    predicates:
      - Path=/payment/discovery/**
      - Cookie=username,zzyy
      - Header=X-Request-Id, \d+ #请求头要有X-Request-Id属性，并且值为正数
      - Host=**.ctj.com

其他`Route Predicate Factory`参考[官网][Link 1]。

**总结：`Predicate`就是为了实现一组匹配原则，让请求过来找到对应的`Route`进行处理**

## 2.4 Filter 的使用 ##

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

`Gateway`内置了多种路由过滤器，他们都由`GatewayFilter`的工厂 类来产生。其生命周期有两种：`pre`(业务逻辑执行之前)和`post`(业务逻辑执行之后)。种类有两种：`GatewayFilter`和`GlobalFilter`。  
![在这里插入图片描述][20200417220314759.png]  
使用`GatewayFilter`：

例：该`AddRequestHeader` `GatewayFilter`工厂需要`name`和`value`参数。它将`X-Request-red:blue`标头添加到所有匹配请求的下游请求的标头中。

spring:
      cloud:
        gateway:
          routes:
          - id: add_request_header_route
            uri: https://example.org
            filters:
            - AddRequestHeader=X-Request-red, blue

具体参考： [官网][Link 2]

**自定义 GlobalFilter**

作用：

1.  全局日志记录
2.  统一网关鉴权，可以结合`Spring Security`完成对用户的认证授权

用户校验实现代码：

@Component
    @Slf4j
    public class MyLogGatewayFilter implements GlobalFilter, Ordered { 
    
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { 
            log.info("******用户验证开始: " + new Date());
            String uname = exchange.getRequest().getQueryParams().getFirst("uname");
            if(uname == null) { 
                log.info("******非法用户******");
                exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
                return exchange.getResponse().setComplete();
            }
            log.info("******用户验证成功******");
            return chain.filter(exchange);
        }
    
        /** * 加载过滤器的顺序，数据越小，优先级越高 * @return int */
        @Override
        public int getOrder() { 
            return 0;
        }
    }

访问`http://localhost:9527/payment/discovery`日志打印，请求并且被拦截：  
![拦截打印日志][20200417221459714.png]  
访问`http://localhost:9527/payment/discovery?uname=a`日志打印，请求被放行：  
![在这里插入图片描述][20200417221804917.png]

[20200417135440428.png]: /images/20230521/ffd91caebec54f0984f3fab12bf62987.png
[Gateway]: /images/20230521/73fb1e7f537e4c5ba71bc7037ecbbf67.png
[Gateway 1]: /images/20230521/ac916659d7e9400882c79b5e5dbdc8fa.png
[gateway]: /images/20230521/c95c740742d84e308029fe724cc250c2.png
[Predicate]: /images/20230521/034c8dac41ec4a65b6594297e1c152c9.png
[Link 1]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.2.RELEASE/reference/html/#gateway-request-predicates-factories
[20200417220314759.png]: /images/20230521/d252728f4b584912a2f6b40cde063dd7.png
[Link 2]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.2.RELEASE/reference/html/
[20200417221459714.png]: /images/20230521/4eec9acd9e554f30af3b3ea9487ce3af.png
[20200417221804917.png]: /images/20230521/88a7d02c21104f69b7b7fe87b1cbc6df.png