四、整合微服务网关 Spring Cloud Gateway

最新推荐文章于 2024-06-25 15:58:55 发布

老徐··

最新推荐文章于 2024-06-25 15:58:55 发布

阅读量627

点赞数

分类专栏： spring colud

本文链接：https://blog.csdn.net/m0_38075227/article/details/118015394

版权

本文详细介绍了微服务网关的重要性和Spring Cloud Gateway的使用。通过Spring Cloud Gateway，我们可以解决传统无网关模式的弊端，如客户端直接访问服务接口带来的复杂性和认证问题。文章阐述了Spring Cloud Gateway的组成部分，包括路由、谓词和过滤器，并通过实践步骤展示了如何整合和配置Spring Cloud Gateway。此外，还探讨了为何不使用nginx作为API网关的原因，并讲解了自定义过滤器和全局过滤器的实现。

摘要由CSDN通过智能技术生成

上一篇:三、整合分布式配置中心 Spring Cloud Config

一、微服务网关

介于客户端和服务器之间的中间层，所有外部请求都会先经过微服务网关

二、为什么需要微服务网关

1、传统无网关访问的访问模式（客户端直接访问服务接口）的弊端

在这里插入图片描述

复杂性 ---- 客户端完成一个业务可能需要调用多个微服务接口，然而分布式微服务可能对应多个不同的ip与端口

访问方式不友好 – 某些服务可能使用了并不友好的协议，如使用RPC和AMQP等只适合内部使用的协议

认证复杂 ----- 每个微服务需要独立认证

跨域处理困难

重构困难-------如果后期需要服务拆分或者服务合并，这种模式的实施将会极为困难

2、基于网关的访问模式（类似于面向对象中的门面模式）

在这里插入图片描述

使用网关可以针对性的解决传统访问模式的弊端：

减少客户端对微服务的交互次数，降低客户端与服务端的耦合度
易于认证，只需要在网关统一认证
便于监控，可以在网关收集交互数据进行监控
便于重构，因为客户端对微服务的访问路径及端口都是统一而少量的

思考：为什么不用nginx直接作为网关呢？

nginx作为负载均衡的利刃确实可以带来很多的集约化便利，但是它的主要着力点是对ip及端口的统一转发及分配，而不是api。本文介绍的微服务网关主要着力于微服务api的负载均衡和代理，如果使用nginx作为api网关，nginx需要为每一个api做代理配置，这个数量级是很高的，维护起来十分困难，微服务网关必须可以做到api前缀适配和路由转发功能，所以nginx并不适合作为api网关。

除此之外，网关还提供了负载均衡，限流降级等服务，有利于优化系统性能，分散压力。

三、微服务网关Spring Cloud Gateway

目前，市面上比较常用的微服务网关解决方案主要是Nginx+ Lua、Kong、Spring Cloud Zuul，Spring Cloud Gateway等，其中Spring Cloud Gateway是Spring Cloud后期研发用于取待Zuul的一个网关组件，具有路由转发、权限校验、限流控制等功能。

1、Spring Cloud Gateway的组成

Route(路由) ------------ 网关的基本组件对象，指向一个api/服务，定义了一个id，一个目标uri，一组谓词和一组过滤器，如果谓词匹配为真，则匹配路由
Predicate(谓词) ------- 作为匹配路由的先行条件，是一个Java 8 Function Predicate,允许开发人员匹配HTTP请求的任何信息
Filter(过滤器) ---------- 特定工程构建的Spring Framework GatewayFilter 的实例，用于在发送下游请求之前或之后处理请求与响应

2、Gateway的谓词（Predicate）

谓词工厂	谓词配置写法	谓词意义
After Route Predicate Factory	predicates:- After=2017-01-20T17:42:47.789-07:00[America/Denver]	允许匹配指定日期时间之后发生的请求
Before Route Predicate Factory	predicates:- Before=2019-01-20T17:42:47.789-07:00[America/Denver]	允许匹配指定日期时间之前发生的请求
Between Route Predicate Factory	predicates:- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2019-01-21T17:42:47.789-07:00[America/Denver]	允许匹配datetime1之后和datetime2之前发生的请求。datetime1必须在datetime2之前
Cookie Route Predicate Factory	predicates:- Cookie=chocolate, ch.p	允许匹配具有指定名称的cookie的请求
Header Route Predicate Factory	predicates:- Header=X-Request-Id, \d+	接收2个参数，一个header中的名称和一个正则表达式。允许匹配含有指定名称的header且其值符合正则表达式的请求
Host Route Predicate Factory	predicates:- Host=**.somehost.org	接收一个参数：主机名模式。该模式是一种 Ant 样式模式作为分隔符。允许匹配与该模式匹配的主机头部
Method Route Predicate Factory	predicates:- Method=GET	允许匹配指定请求方式的请求
Path Route Predicate Factory	predicates:- Path=/foo/{segment}	允许匹配指定路径前缀的请求
Query Route Predicate Factory	predicates:- Query=baz	接收2个参数: 一个必须的参数和一个可选的表达式。允许匹配请求参数中包含了指定参数的请求
RemoteAddr Route Predicate Factory	predicates: - RemoteAddr=192.168.1.1/24	允许匹配指定ip规则的请求

3、Gateway的过滤器（Filter）

gateway过滤器的生命周期与其作用范围有关，其生命周期只有两个：“pre” 和 “post”。“pre”和 “post” 分别会在请求被执行前调用和被执行后调用

Spring Cloud Gateway的源码包Filter中包含三个接口：GatewayFilterChain，GatewayFilter，GlobalFilter

GatewayFilterChain-----网关过滤链表接口，用于过滤器的链式调用

GatewayFilter----- 网关路由过滤器，有且只有一个方法filter，执行当前过滤器，并在此方法中决定过滤器链表是否继续往下执行。需要通过spring.cloud.route.filter在路由上配置或通过spring.cloud.default-filter将该过滤器作为全局过滤器

在这里插入图片描述

GlobalFilter----请求业务以及路由的URI转换为真实业务服务的请求地址的核心过滤器，不需要配置，模式系统初始化时加载，并作用在每个路由上。

在这里插入图片描述

四、Spring Cloud Gateway的工作原理

在这里插入图片描述

①客户端向网关发送请求
②网关映射处理匹配谓词+匹配路由通过后，将请求转交到网关Web处理程序
③网关Web处理程序请求通过一系列过滤器处理后发送到指定代理服务
④指定代理服务处理完业务响应同样经过一系列过滤器处理后返回给客户端

五、实践整合Spring Cloud Gateway

1、第一步：在父工程下创建网关服务工程：springcloud-gateway

并引入依赖spring-cloud-starter-gateway

<!--微服务网关组件依赖-->
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

<!--健康检查监控-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

注意：spring-cloud-starter-gateway依赖使用的netty+webflux实现,已经是个网络工程，不要加入web依赖，否则会报错

完整POM文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>com.springcloud</artifactId>
        <groupId>com.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.gateway</groupId>
    <artifactId>spring-cloud-gateway</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <!--微服务网关组件依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <!--健康检查监控-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!--配置中心客户端-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-client</artifactId