风在路上
zdk
2022-11-09
目录

Gateway

Table of Contents generated with DocToc (opens new window)

# Gateway

# 概述简介

Cloud全家桶中有个很重要的组件就是网关。在1.x版本中都是采用的Zuul网关；

但在2.x版本中，Zuul的升级一直跳票，所以SpringCloud自己研发了一个网关替代Zuul，那就是SpringCloud Gateway

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

SpringCloud Gateway是Spring Cloud的一个全新项目，基于Spring 5.0+Spring Boot 2.0和Project Reactor等技术开发的网关，它旨在为微服务架构提供—种简单有效的统一的API路由管理方式。 SpringCloud Gateway 作为Spring Cloud生态系统中的网关，目标是替代Zuul，在Spring Cloud 2.0以上版本中，没有对新版本的Zuul 2.0以上最新高性能版本进行集成，仍然还是使用的Zuul 1.x非Reactor模式的老版本。而为了提升网关的性能，SpringCloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。 Spring Cloud Gateway的目标提供统一的路由方式且基于Filter链的方式提供了网关基本的功能，例如:安全，监控/指标，和限流。

image-20221110143049391

# 特性

Spring Cloud Gateway具有如下特性

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

# 区别

Spring Cloud Gateway 与Zuul的区别

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

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

# Zuul 1.x模型

Springcloud中所集成的Zuul版本，采用的是Tomcat容器，使用的是传统的Servlet IO处理模型。


servlet生命周期由servlet container进行管理。container启动时构造servlet对象并调用servlet init()进行初始化;


container运行时接受请求，并为每个请求分配一个线程（一般从线程池中获取空闲线程）然后调用service()。


container关闭时调用servlet destory()销毁servlet;

image-20221110144241748

上述模式的缺点

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


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

# Gateway异步非阻塞模型

传统的Web框架，比如说: struts2，springmvc等都是基于Servlet APl与Servlet容器基础之上运行的。

但是在Servlet3.1之后有了异步非阻寒的支持。而WebFlux是一个典型非阻塞异步的框架，它的核心是基于Reactor的相关API实现的。相对于传统的web框架来说，它可以运行在诸如Netty,Undertow及支持Servlet3.1的容器上。非阻塞式+函数式编程(Spring5必须让你使用java8)

Spring WebFlux是Spring 5.0引入的新的响应式框架，区别于Spring MVC，它不需要依赖Servlet API，它是完全异步非阻塞的，并且基于Reactor来实现响应式流规范。

# 三大核心概念

# Route(路由)

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

# Predicate(断言)

参考的是Java8的java.util.function.Predicate

开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数)，如果请求与断言相匹配则进行路由

# Filter(过滤)

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

# 总体

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

# Gateway工作流程

image-20221110145645334

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

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

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

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

# 入门配置

# pom

<dependencies>
        <!--        通用的依赖-->
        <dependency>
            <groupId>com.zdk</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </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>
        <!-- eureka 客户端添加的依赖 因为网关作为一种微服务也要注册到注册中心 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
    	<!-- Gateway的依赖 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
    </dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

# yaml

server:
  port: 9527

spring:
  application:
    name: cloud-gateway

eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 启动类

@SpringBootApplication
@EnableEurekaClient
@EnableDiscoveryClient
public class GatewayMain9527 {
    public static void main(String[] args) {
        SpringApplication.run(GatewayMain9527.class, args);
    }
}
1
2
3
4
5
6
7
8

这里Gateway需要移除web的starter，因为web自带的Tomcat不支持异步非阻塞

# 路由yaml配置

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 #路由的ID  没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001 #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/** #断言，路径相匹配的进行路由


eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

启动7001、8001、9527项目后，访问http://localhost:8001/payment/get/1测试，成功，

再将端口切换为网关的9527发现，同样能够正常访问

image-20221110152915522

# 硬编码配置

package com.zdk.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;

/**
 * @Description
 * @Author zdk
 * @Date 2022/11/10 15:33
 */
@Configuration
public class GatewayConfig {
    /**
     * 配置了一个id为guonei_route的路由规则
     * 当访问地址 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("guonei_route",
                r -> r.path("/guonei")
                        .uri("http://news.baidu.com/guonei"));
        return routes.build();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

image-20221110154353882

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

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 #路由的ID  没有固定规则但要求唯一，建议配合服务名
#          uri: http://localhost:8001 #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/** #断言，路径相匹配的进行路由
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

将uri处，协议替换为lb，host替换为服务名，然后开启discovery.locator.enabled=true

启动8001和8002，通过9527访问/payment/get/{id}接口，发现访问成功，且有默认的轮询负载均衡

# Predicate的使用

image-20221110162945746

我们先前在yaml中只使用了Path

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=时间，表示，只有在这个时间之后访问网关，请求才会被转发，否则会404

- After=2022-11-11T16:37:46.518+08:00[Asia/Shanghai]
1

image-20221110164122455

# Before

Before就与After相反了，在之前的才可以

# Between

Between后面接两个时间，用,分割即可

- Cookie=name,exp
1

Cookie Route Predicate需要两个参数，一个是Cookie name，一个是cookie值(值可以是正则表达式)。

路由规则会通过获取对应的Cookie name值和正则表达式去匹配，如果匹配上就会执行路由，如果没有匹配上则不执行

通过cmd命令行curl命令测试

- Cookie=username,zdk
1
curl http://localhost:9527/payment/get/1 # 不带cookie  404
curl http://localhost:9527/payment/get/1 --cookie "username=zdk" #成功
1
2

image-20221110165220192

image-20221110165402003

Header和Cookie是差不多的，参数中，一个是属性名，一个是属性值，属性值可以是正则

- Header=test,\d+  #表示header中要存在一个叫test的，类型是整数的值才能访问
1

测试

curl http://localhost:9527/payment/get/1 # 不带header test  404
curl http://localhost:9527/payment/get/1 -H "test:22" #成功
1
2

image-20221110165904435

# Host

Host用来限制访问的主机

举例

- Host=**.test.com  #如果访问网关的host不满足此规则，则404
1

# Method

Method用来限制请求的方式(GET、POST等)

举例

- Method=GET
1

# Query

Query是要求请求需要带有指定的查询条件，参数中，一个是属性名，一个是属性值，属性值可以是正则

举例

- Query=keywords,zdk
1

# Filter的使用

# 分类

  • GatewayFilter
  • GlobalFilter

# 现有过滤器

参考官网或百度Google

# 自定义全局过滤器

  • 主要实现GlobalFilter和Ordered接口
package com.zdk.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;

/**
 * @Description
 * @Author zdk
 * @Date 2022/11/10 17:12
 */
@Slf4j
@Component
public class MyUserGatewayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("*****GlobalFilter----："+new Date());
        String username = exchange.getRequest().getQueryParams().getFirst("username");
        //这里简单判断一下 如果用户名参数为null就不放行 且给与NOT_ACCEPTABLE状态码并返回
        if (username == null){
            log.info("***用户名为null，非法用户");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

image-20221110172138733

在 GitHub 上编辑此页 (opens new window)
#Gateway
最后更新: 2022/11/10, 17:11:00
Hystrix
Config

← Config→

Theme by Vdoing | Copyright © 2022-2024 zdk | notes
湘ICP备2022001117号-1
川公网安备 51142102511562号
提供加速服务