九、网关(Gateway)

上一代网关zuul 1.X：https://github.com/Netflix/zuul/wiki

当前网关gateway：https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/

一、概述简介

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

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

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

　　Spring Cloud Gateway 使用的Webflux中的reactor-netty响应式编程组件，底层使用了Netty通讯框架。

　　SpringCloud Gateway的功能作用：反向代理、鉴权、流量控制、熔断、日志监控。

1.1、微服务架构中网关的使用位置

1.2、有了Zuul了怎么又出来了gateway

　　zuul2.0一直迟迟不发布

　　一方面因为Zuul1.0已经进入了维护阶段，而且Gateway是SpringCloud团队研发的，值得信赖。而且很多功能Zuul都没有用起来也非常的简单便捷。Gateway是基于异步非阻塞模型上进行开发的，性能方面不需要担心，虽然Netflix早就发布了最新的Zuul 2.x,但是Spring Cloud貌似没有整合计划，而且Netflix相关组件都宣布进入维护期。多方面考虑Gateway是很理想的网关选择。

　　SpringCloud Gateway具有如下特性：

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

1.3、SpringCloud Gateway与Zuul的区别

　　在SpringCloud finchley正式版之前，SpringCloud推荐的网关是Netflix提供的Zuul;

1. Zuul 1.x是一个基于阻塞I/O的API Gateway
2. Zuul 1.x基于Servlet2.5使用阻塞架构它不支持任何长连接（如 WebSocket）Zuul的设计模式和Nginx较像，每次I/O操作都是从工作线程中选择一个执行。请求线程被阻塞到工作线程完成，但是差别是Nginx用C++实现，Zuul用Java实现，而JVM本身会有第一次加载较慢的情况，使得Zuul的性能相对较差。
3. Zuul 2.x理念更先进，想基于Netty非阻塞和支持长连接，但是Spring Cloud目前还没有整合。Zuul 2.x的性能较Zuul 1.x有较大提示。在性能方面，根据官方提供的基准测试，Spring Cloud Gateway的RPS（每秒请求数）是Zuul 1.x的1.6倍。
4. SpringCloud Gateway建立在 Spring Framework 5,Project Reactor和Spring Boot 2.0之上，使用非阻塞API
5. SpringCloud Gateway还支持WebSocket,并且与Spring紧密集成拥有更好的开发体验。

　　Zuul1.x模型；Srpingcloud中所集成的Zuul版本，采用的是Tomcat容器，使用的是传统的Servlet IO处理模型。Servlet的生命周期

容器启动时构造servlet对象并调用servlet的init()方法。
容器运行时接受请求，并为每个请求分配一个线程（一般从线程池中获取空闲线程）然后调用Service().
容器关闭时调用servlet destory()销毁servlet。

　　上述模式的缺点：

　　servlet是一个简单的网络IO模型，当请求进入Servlet 容器时，servlet容器就会为其绑定一个线程，在并发不高的场景下这种模型是适用的。但是一旦高并发（用Jemeter压）线程数量就会上涨，而线程资源代价是昂贵的（上下文切换，内存消耗大）严重影响请求的处理时间。在一些简单业务场景下，不希望为每一个request分配一个线程，只需要1个或者几个线程就能应对极大并发的请求，这种业务场景下servlet模型没有优势。

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

二、Gateway的三大核心

2.1、Route(路由)

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

2.2、Predicate（断言）

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

2.3、Filter(过滤)

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

2.4、总体

　　Web请求，通过一些匹配条件，定位到真正的服务节点，并在这个转发过程的前后，进行一些精细化控制。

　　predicate就是我们的匹配条件，而filter，就可以理解为一个无所不能的拦截器，有了这两个元素，再加上目标url，就可以实现一个具体的路由了。

三、Gateway工作流程

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

四、案例

　　Gateway网关路由有两种配置方式

在配置文件yml中配置
代码中注入RouteLocator的Bean

4.1、yml方式配置路由

　　需求：之前cloud-provider-payment8001的controller的访问地址 get/lb；我们目前不想暴露8001端口，希望在8001外面套一层9527；9527网关做路由映射。

新建Spring Boot 的Module名称：cloud-gateway-gateway9527
pom.xml添加如下依赖

<dependencies>
  <!--新增gateway-->
  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
  </dependency>

  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
  </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>

编写application.yml

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

        - id: payment_routh2
          uri: http://localhost:8001
          predicates:
            - Path=/payment/lb/**     #断言,路径相匹配的进行路由


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

主启动类

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

测试

　　启动7001 + 启动8001（cloud-provider-payment8001）+启动9527网关

　　添加网关前访问：http://localhost:8001/payment/get/31

　　添加网关后访问：http://localhost:9527/payment/get/31

4.2、代码注入配置路由

　　代码中注入RouteLocator的Bean

/**
 * 配置一个id为 path_route_jdy的路由规则，当访问地址http://localhost:9527/u/jdy1022/时
 * 自动转发到地址https://home.cnblogs.com/u/jdy1022/
 *
 */
@Configuration
public class gatewayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();

        routes.route("path_route_jdy",
                r -> r.path("/u/jdy1022/")
                        .uri("https://home.cnblogs.com/u/jdy1022/")).build();

        return routes.build();
    }
}

五、通过微服务名动态路由

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

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

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

        - id: payment_routh2
         # uri: http://localhost:8001
          uri: lb://cloud-payment-service
          predicates:
            - Path=/payment/lb/**       #断言,路径相匹配的进行路由


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

　　一个eureka7001+两个服务提供者8001/8002

　　http://localhost:9527/payment/lb

　　8001/8002两个端口切换

六、Predicate的使用

6.1、Route Predicate Factories这个是什么？

　　Spring Cloud Gateway将路由作为Spring WebFluxHandlerMapping基础架构的一部分进行匹配。Spring Cloud Gateway包括许多内置的路由 predicate 工厂。所有这些 predicate 都与HTTP请求的不同属性匹配。您可以将多个路由 predicate 工厂与逻辑and语句结合使用。

6.2、常用的Route Predicate

(1)、After Route Predicate

　　该Predicate匹配在指定日期时间之后发生的请求。以下示例配置了路由后谓词：

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: https://example.org
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]

//获取上面的时间串
ZonedDateTime zonedDateTime = ZonedDateTime.now();
System.out.println(zonedDateTime);
//2021-05-10T20:28:03.324+08:00[Asia/Shanghai]

(2)、Before Route Predicate

　　该Predicate匹配在指定日期时间之前发生的请求。以下示例配置了路由后谓词：

spring:
  cloud:
    gateway:
      routes:
      - id: before_route
        uri: https://example.org
        predicates:
        - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

(3)、Between Route Predicate

　　该Predicate匹配在指定日期时间之间发生的请求。以下示例配置了路由后谓词：

spring:
  cloud:
    gateway:
      routes:
      - id: between_route
        uri: https://example.org
        predicates:
        - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]

(4)、Cookie Route Predicate

spring:
  cloud:
    gateway:
      routes:
      - id: cookie_route
        uri: https://example.org
        predicates:
        - Cookie=username,jdy

Cookie Route Predicate需要两个参数，一个是Coookie name,一个是正则表达式，路由规则会通过获取对应的 Cookie name值和正则表达式去匹配，如果匹配上就会执行路由，如果没有匹配上则不执行。

不带cookies访问curl http://localhost:9527/payment/lb
带上cookies访问curl http://localhost:9527/payment/lb –cookie “username=jdy”

(5)、Header Route Predicate

　　两个参数，一个属性名称和一个正则表达式，属性值和正则表达式匹配则执行。

spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: https://example.org
        predicates:
        - Header=X-Request-Id, \d+ # 请求头中要有X-Request-Id属性并且值为整数的正则表达式

　　curl http://localhost:9527/payment/lb -H “X-Request-Id:123”

(6)、After Route Predicate

　　Host Route Predicate接受一组参数，一组匹配的域名列表，这个模板是一个ant分隔的模板，用.号作为分隔符。它通过参数中的主机地址作为匹配规则。

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: https://example.org
        predicates:
        - Host=**.jdy.com

　　curl http://localhost:9527/payment/lb -H “Host:jdy.com”

(7)、After Route Predicate

spring:
  cloud:
    gateway:
      routes:
      - id: method_route
        uri: https://example.org
        predicates:
        - Method=GET,POST

　　curl http://localhost:9527/payment/lb -H “Method:get”

　　或者curl http://localhost:9527/payment/lb ,默认是get请求

(8)、After Route Predicate

　　只有访问指定路径,才进行路由

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: https://example.org
        predicates:
        - Path=/payment/lb/**

　　curl http://localhost:9527/payment/lb

(9)、After Route Predicate

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: https://example.org
        predicates:
        - Query=username, \d+ #要有参数名称并且是正整数才能路由

　　curl http://localhost:9527/payment/lb?username=2

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

七、Filter的使用

7.1、是什么

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

7.2、Spring Cloud Gateway的Filter

生命周期两个
- pre 在业务逻辑之前
- post 在业务逻辑之后
种类
- GatewayFilter单一
- GlobalFilter全局

7.3、常用的GatewayFilter

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

        - id: payment_routh2
         # uri: http://localhost:8001
          uri: lb://cloud-payment-service
          filter:
            - AddRequestParameter=X-Request-Id,1024 #过滤器工厂会在匹配的请求头加上一对请求头，名称为X-Request-Id值为1024
          predicates:
            - Path=/payment/lb/**       #断言,路径相匹配的进行路由
            #- Cookie=username,jdy
            #- Header=X-Request-Id, \d+ # 请求头中要有X-Request-Id属性并且值为整数的正则表达式
            # - Host=**.jdy.com
            # - Method=GET
            # - Path=/payment/lb/**
            - Query=username, \d+ #要有参数名称并且是正整数才能路由

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

7.4、自定义过滤器

自定义全局GlobalFilter，两个主要接口介绍impiemerts GlobalFilter ，Ordered

能干嘛

全局日志记录
统一网关鉴权

@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("username");
        if(StringUtils.isEmpty(username)){
            log.info("*****用户名为Null 非法用户,(┬＿┬)");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);//给一个回应
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

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

　　测试 http://localhost:9527/payment/lb?uname=z3

本文链接：https://www.cnblogs.com/jdy1022/p/14681194.html