SpringCloud微服务网关Gateway怎么创建

1. 引言

在微服务架构中，网关（Gateway）是一个非常重要的组件，它负责处理所有进入系统的请求，并将这些请求路由到相应的微服务。Spring Cloud Gateway 是 Spring Cloud 生态系统中的一个子项目，它提供了一个简单而有效的方式来构建 API 网关。本文将详细介绍如何使用 Spring Cloud Gateway 创建一个微服务网关。

2. Spring Cloud Gateway 简介

Spring Cloud Gateway 是基于 Spring 5、Spring Boot 2 和 Project Reactor 构建的 API 网关。它旨在为微服务架构提供一种简单而有效的方式来路由请求、处理跨域、限流、熔断、重试等功能。Spring Cloud Gateway 的主要特点包括：

• 动态路由：可以根据请求的路径、方法、头信息等动态路由到不同的微服务。
• 过滤器：可以在请求到达目标服务之前或之后执行一些操作，如添加请求头、修改请求体等。
• 限流：可以对请求进行限流，防止系统被过多的请求压垮。
• 熔断：可以在目标服务不可用时，自动熔断请求，防止雪崩效应。
• 重试：可以在请求失败时自动重试。

3. 创建 Spring Cloud Gateway 项目

3.1 环境准备

在开始之前，确保你已经安装了以下工具：

• JDK 1.8 或更高版本
• Maven 3.x 或更高版本
• IntelliJ IDEA 或其他 IDE

3.2 创建 Spring Boot 项目

首先，我们需要创建一个 Spring Boot 项目。你可以使用 Spring Initializr 来快速生成项目。

1. 打开 Spring Initializr。
2. 选择以下配置：
   • Project: Maven Project
   • Language: Java
   • Spring Boot: 2.5.0 或更高版本
   • Group: com.example
   • Artifact: gateway
   • Name: gateway
   • Package Name: com.example.gateway
   • Packaging: Jar
   • Java Version: 8
3. 在 Dependencies 中添加以下依赖：
   • Spring Cloud Gateway
   • Spring Boot Actuator（可选，用于监控和管理）
4. 点击 Generate 按钮下载项目。

3.3 导入项目

下载完成后，解压项目并导入到你的 IDE 中。项目结构如下：

gateway
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── example
│   │   │           └── gateway
│   │   │               └── GatewayApplication.java
│   │   └── resources
│   │       ├── application.properties
│   │       └── static
│   │       └── templates
│   └── test
│       └── java
│           └── com
│               └── example
│                   └── gateway
└── pom.xml

3.4 配置 Spring Cloud Gateway

在 application.properties 文件中，我们可以配置 Spring Cloud Gateway 的基本属性。以下是一个简单的配置示例：

server.port=8080

spring.application.name=gateway

# 配置路由规则
spring.cloud.gateway.routes[0].id=service1
spring.cloud.gateway.routes[0].uri=http://localhost:8081
spring.cloud.gateway.routes[0].predicates[0]=Path=/service1/**

spring.cloud.gateway.routes[1].id=service2
spring.cloud.gateway.routes[1].uri=http://localhost:8082
spring.cloud.gateway.routes[1].predicates[0]=Path=/service2/**

在这个配置中，我们定义了两个路由规则：

• service1：所有以 /service1/** 开头的请求都会被路由到 http://localhost:8081。
• service2：所有以 /service2/** 开头的请求都会被路由到 http://localhost:8082。

3.5 启动项目

在 GatewayApplication.java 文件中，添加 @EnableDiscoveryClient 注解以启用服务发现功能（如果你使用了服务发现组件如 Eureka、Consul 等）。

package com.example.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {

    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class, args);
    }

}

然后，运行 GatewayApplication 类启动项目。

4. 动态路由配置

在实际项目中，我们通常不会将路由规则硬编码在配置文件中，而是通过服务发现组件动态获取服务实例。Spring Cloud Gateway 支持与 Eureka、Consul 等服务发现组件集成。

4.1 集成 Eureka

首先，在 pom.xml 中添加 Eureka 客户端依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

然后，在 application.properties 中配置 Eureka 服务器地址：

eureka.client.service-url.defaultZone=http://localhost:8761/eureka/

接下来，修改路由配置，使用服务名称代替具体的 URI：

spring.cloud.gateway.routes[0].id=service1
spring.cloud.gateway.routes[0].uri=lb://SERVICE1
spring.cloud.gateway.routes[0].predicates[0]=Path=/service1/**

spring.cloud.gateway.routes[1].id=service2
spring.cloud.gateway.routes[1].uri=lb://SERVICE2
spring.cloud.gateway.routes[1].predicates[0]=Path=/service2/**

在这里，lb://SERVICE1 表示使用负载均衡的方式路由到 SERVICE1 服务。

4.2 集成 Consul

如果你使用的是 Consul 作为服务发现组件，可以在 pom.xml 中添加 Consul 客户端依赖：

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

然后，在 application.properties 中配置 Consul 服务器地址：

spring.cloud.consul.host=localhost
spring.cloud.consul.port=8500

路由配置与 Eureka 类似，使用服务名称代替具体的 URI：

spring.cloud.gateway.routes[0].id=service1
spring.cloud.gateway.routes[0].uri=lb://SERVICE1
spring.cloud.gateway.routes[0].predicates[0]=Path=/service1/**

spring.cloud.gateway.routes[1].id=service2
spring.cloud.gateway.routes[1].uri=lb://SERVICE2
spring.cloud.gateway.routes[1].predicates[0]=Path=/service2/**

5. 过滤器配置

Spring Cloud Gateway 提供了丰富的过滤器功能，可以在请求到达目标服务之前或之后执行一些操作。以下是一些常用的过滤器示例。

5.1 添加请求头

你可以在请求到达目标服务之前，添加一些自定义的请求头。例如：

spring.cloud.gateway.routes[0].filters[0]=AddRequestHeader=X-Request-Foo, Bar

这个配置会在请求头中添加 X-Request-Foo: Bar。

5.2 修改请求路径

你可以修改请求的路径，例如将 /service1/foo 修改为 /foo：

spring.cloud.gateway.routes[0].filters[0]=RewritePath=/service1/(?<segment>.*), /$\{segment}

5.3 限流

Spring Cloud Gateway 支持基于 Redis 的限流功能。首先，在 pom.xml 中添加 Redis 依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
</dependency>

然后，在 application.properties 中配置 Redis 服务器地址：

spring.redis.host=localhost
spring.redis.port=6379

接下来，配置限流过滤器：

spring.cloud.gateway.routes[0].filters[0]=RequestRateLimiter=10, 20, #{@userKeyResolver}

这个配置表示每秒最多允许 10 个请求，令牌桶容量为 20。userKeyResolver 是一个自定义的限流键解析器，你可以根据需要实现。

6. 监控和管理

Spring Cloud Gateway 集成了 Spring Boot Actuator，可以通过 HTTP 端点监控和管理网关。首先，在 pom.xml 中添加 Actuator 依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

然后，在 application.properties 中配置 Actuator 端点：

management.endpoints.web.exposure.include=*

启动项目后，你可以访问以下端点：

• /actuator/gateway/routes：查看所有路由信息。
• /actuator/gateway/globalfilters：查看所有全局过滤器。
• /actuator/gateway/routefilters：查看所有路由过滤器。

7. 总结

本文详细介绍了如何使用 Spring Cloud Gateway 创建一个微服务网关。我们从项目创建、路由配置、动态路由、过滤器配置、限流、监控和管理等方面进行了讲解。Spring Cloud Gateway 提供了丰富的功能和灵活的配置方式，能够满足大多数微服务架构的需求。希望本文能帮助你快速上手 Spring Cloud Gateway，并在实际项目中应用它。