SpringCloud-4.服务网关（GateWay）

最新推荐文章于 2024-03-15 05:38:03 发布

UndefinedException

最新推荐文章于 2024-03-15 05:38:03 发布

阅读量380

点赞数

分类专栏： SpringCloud 文章标签： spring cloud gateway java

本文链接：https://blog.csdn.net/weixin_62427168/article/details/126472561

版权

SpringCloud 专栏收录该内容

12 篇文章 2 订阅

订阅专栏

一、基本概念

1.1 什么是GateWay

1.2 GateWay的特性

1.3 GateWay 与 Zuul 的区别

一、基本概念

1.1 什么是GateWay

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 链的方式提供了网关基本的功能，例如：安全，监控/指标，和限流。

在Servlet3.1之后有了异步非阻塞的支持。Spring WebFlux 是 Spring 5.0 引入的新的响应式框架，区别于 SpringMVC，它不需要依赖Servlet API，它是完全异步非阻塞的，并且基于 Reactor 的相关API来实现响应式流规范。

功能：反向代理、鉴权、流量控制、熔断、日志监控......

1.2 GateWay的特性

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

1.3 GateWay 与 Zuul 的区别

1、Zuul 1.x，是一个基于阻塞 I/ O 的 API Gateway ，采用的是Tomcat容器，使用的是传统的Servlet IO处理模型。

采用servlet模型的缺点：

        servlet是一个简单的网络IO模型，当请求进入servlet container时，servlet container就会为其绑定一个线程，在并发不高的场景下这种模型是适用的。但是一旦高并发，线程数量就会上涨，而线程资源代价是昂贵的（上线文切换，内存消耗大）严重影响请求的处理时间。在一些简单业务场景下，不希望为每个request分配一个线程，只需要1个或几个线程就能应对极大并发的请求，这种业务场景下servlet模型没有优势。所以Zuul 1.X是基于servlet之上的一个阻塞式处理模型，即spring实现了处理所有request请求的一个servlet（DispatcherServlet）并由该servlet阻塞式处理。
        2、Zuul 1.x 基于Servlet 2. 5使用阻塞架构，它不支持任何长连接(如 WebSocket)。 Zuul 的设计模式和Nginx较像，每次 I/ O 操作都是从工作线程中选择一个执行，请求线程被阻塞到工作线程完成，但是差别是Nginx 用C++ 实现，Zuul 用 Java 实现，而 JVM 本身会有第一次加载较慢的情况，使得Zuul 的性能相对较差。
        3、Zuul 2.x理念更先进，想基于Netty非阻塞和支持长连接，但SpringCloud目前还没有整合。 Zuul 2.x的性能较 Zuul 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紧密集成拥有更好的开发体验

二、三大核心概念与工作流程

2.1 三大核心概念

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

2.1.1 Route(路由)

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

2.1.2 Predicate(断言)

开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数)，如果请求与断言相匹配则进行路由。（其实就是我们的匹配条件）

2.1.3 Filter(过滤)

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

2.2 工作流程

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

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

三、使用

3.1 基本配置

1. 建Module-cloud-gateway-gateway9527

2.POM

    <dependencies>
        <!--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>
        <!-- 引入自己定义的api通用包，可以使用Payment支付Entity -->
        <dependency>
            <groupId>com.atguigu.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </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>

3.YML

server:
  port: 9527

spring:
  application:
    name: cloud-gateway

eureka:
  instance:
    hostname: cloud-gateway-service
  client: #服务提供者provider注册进eureka服务列表内
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

4.主启动

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

5. 路由映射（比如我们想访问8001端口的provider，但又不希望暴露这个端口）

Yml中添加路由属性：

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

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

6.测试

首先启动 EurekaMain7001、GateWayMain9527、PaymentMain8001

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

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

3.2 通过微服务名进行动态路由

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

假设我们有两个provider：PaymentMain8001、PaymentMain8002

我们需要在GateWay的YML中进一步修改：

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

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

lb://serviceName是spring cloud gateway在微服务中自动为我们创建的负载均衡URL，表示启用Gateway的负载均衡功能

3.3 Predict的使用

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

Predict的类型：

举例：

... ...
predicates:
    - Path=/payment/lb/**

    - After=2020-02-05T15:10:03.685+08:00[Asia/Shanghai]  # 在这个时间之后的请求生效

    - Before=2020-02-05T15:10:03.685+08:00[Asia/Shanghai] # 在这个时间之前的请求生效

    - Between=2020-02-02T17:45:06.206+08:00[Asia/Shanghai],2020-03-25T18:59:06.206+08:00[Asia/Shanghai] #在这两个时间之间的请求生效

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

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

    - Host=**.atguigu.com

    - Method=GET

    - Query=username, \d+  # 要有参数名username并且值还要是整数才能路由

3.4 Filter的使用

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

分类：

按照生命周期：

Pre：请求转发前

Post ：收到响应后

按照种类：

GateWayFilter：配置在具体路由下

GlobalFilter：不需要在配置文件中配置，作用在所有的路由上

使用格式举例：

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

3.5 自定义过滤器

自定义全局GlobalFilter的作用：全局日志记录、统一网关鉴权... ...

需要自定义过滤器类，实现 GlobalFilter,Ordered 接口

@Component
public class MyLogGateWayFilter implements GlobalFilter,Ordered
{
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain){
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");//获取请求参数
        if (uname == null) {
            //名字为空就设置错误响应码然后返回
            System.out.println("****用户名为null，无法登录");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);//设置响应码
            return exchange.getResponse().setComplete();//返回
        }
        return chain.filter(exchange);//名字不为空就继续执行
    }

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

UndefinedException

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
SpringCloud-4.服务网关（GateWay）

自定义全局GlobalFilter的作用：全局日志记录、统一网关鉴权... ...需要自定义过滤器类，实现,Ordered接口@Component{@Override//获取请求参数//名字为空就设置错误响应码然后返回System.out.println("****用户名为null，无法登录");//设置响应码//返回}//名字不为空就继续执行}@Override{return 0;}}
复制链接

扫一扫