SpringCloud GateWay网关怎么配置

Spring Cloud Gateway 是 Spring Cloud 生态系统中的一个 API 网关服务，它基于 Spring 5、Spring Boot 2 和 Project Reactor 构建，旨在为微服务架构提供一种简单而有效的方式来路由请求、处理跨域、限流、熔断等操作。本文将详细介绍如何配置 Spring Cloud Gateway。

1. 引入依赖

首先，在你的 Spring Boot 项目中引入 Spring Cloud Gateway 的依赖。你可以在 pom.xml 文件中添加以下依赖：

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

如果你使用的是 Spring Cloud 的 BOM（Bill of Materials），你还需要在 dependencyManagement 中添加 Spring Cloud 的版本管理：

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>2021.0.1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

2. 基本配置

Spring Cloud Gateway 的核心配置是通过 application.yml 或 application.properties 文件来完成的。以下是一个简单的配置示例：

spring:
  cloud:
    gateway:
      routes:
        - id: service1_route
          uri: http://localhost:8081
          predicates:
            - Path=/service1/**
        - id: service2_route
          uri: http://localhost:8082
          predicates:
            - Path=/service2/**

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

• service1_route：当请求路径匹配 /service1/** 时，请求将被转发到 http://localhost:8081。
• service2_route：当请求路径匹配 /service2/** 时，请求将被转发到 http://localhost:8082。

3. 路由断言（Predicates）

路由断言用于匹配请求的条件。Spring Cloud Gateway 提供了多种内置的断言工厂，例如 Path、Host、Method、Header 等。以下是一些常用的断言配置示例：

spring:
  cloud:
    gateway:
      routes:
        - id: host_route
          uri: http://localhost:8081
          predicates:
            - Host=**.example.com
        - id: method_route
          uri: http://localhost:8082
          predicates:
            - Method=GET
        - id: header_route
          uri: http://localhost:8083
          predicates:
            - Header=X-Request-Id, \d+

• Host：匹配请求的 Host 头信息。
• Method：匹配请求的 HTTP 方法。
• Header：匹配请求的 Header 信息。

4. 过滤器（Filters）

过滤器用于在请求被路由之前或之后对请求进行处理。Spring Cloud Gateway 提供了多种内置的过滤器工厂，例如 AddRequestHeader、AddResponseHeader、RewritePath 等。以下是一些常用的过滤器配置示例：

spring:
  cloud:
    gateway:
      routes:
        - id: add_header_route
          uri: http://localhost:8081
          filters:
            - AddRequestHeader=X-Request-Id, 12345
        - id: rewrite_path_route
          uri: http://localhost:8082
          predicates:
            - Path=/service2/**
          filters:
            - RewritePath=/service2/(?<segment>.*), /$\{segment}

• AddRequestHeader：在请求头中添加一个 Header。
• RewritePath：重写请求路径。

5. 全局过滤器（Global Filters）

全局过滤器会应用到所有的路由上。你可以通过实现 GlobalFilter 接口来创建自定义的全局过滤器。以下是一个简单的全局过滤器示例：

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
public class CustomGlobalFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 在这里添加自定义的过滤逻辑
        System.out.println("Custom Global Filter");
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return -1; // 过滤器的执行顺序，数值越小优先级越高
    }
}

6. 限流配置

Spring Cloud Gateway 支持基于 Redis 的限流功能。你可以通过以下配置来启用限流：

spring:
  cloud:
    gateway:
      routes:
        - id: rate_limit_route
          uri: http://localhost:8081
          predicates:
            - Path=/service1/**
          filters:
            - name: RequestRateLimiter
              args:
                redis-rate-limiter.replenishRate: 10
                redis-rate-limiter.burstCapacity: 20
                redis-rate-limiter.requestedTokens: 1

在这个配置中，我们使用了 RequestRateLimiter 过滤器来限制每秒最多 10 个请求，突发容量为 20 个请求。

7. 跨域配置

Spring Cloud Gateway 支持跨域资源共享（CORS）配置。你可以通过以下配置来启用跨域支持：

spring:
  cloud:
    gateway:
      globalcors:
        cors-configurations:
          '[/**]':
            allowedOrigins: "*"
            allowedMethods:
              - GET
              - POST
              - PUT
              - DELETE
            allowedHeaders: "*"
            allowCredentials: true
            maxAge: 3600

在这个配置中，我们允许所有来源的请求，并允许 GET、POST、PUT 和 DELETE 方法。

8. 动态路由

Spring Cloud Gateway 支持动态路由配置。你可以通过实现 RouteDefinitionLocator 接口来动态加载路由配置。以下是一个简单的动态路由示例：

import org.springframework.cloud.gateway.route.RouteDefinition;
import org.springframework.cloud.gateway.route.RouteDefinitionLocator;
import reactor.core.publisher.Flux;

@Component
public class CustomRouteDefinitionLocator implements RouteDefinitionLocator {

    @Override
    public Flux<RouteDefinition> getRouteDefinitions() {
        // 在这里动态加载路由配置
        RouteDefinition routeDefinition = new RouteDefinition();
        routeDefinition.setId("dynamic_route");
        routeDefinition.setUri(URI.create("http://localhost:8081"));
        routeDefinition.setPredicates(List.of(new PredicateDefinition("Path=/dynamic/**")));
        return Flux.just(routeDefinition);
    }
}

9. 监控与健康检查

Spring Cloud Gateway 集成了 Spring Boot Actuator，你可以通过 Actuator 端点来监控网关的健康状况和路由信息。首先，确保在 pom.xml 中引入 Actuator 依赖：

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

然后，在 application.yml 中启用 Actuator 端点：

management:
  endpoints:
    web:
      exposure:
        include: "*"

你可以通过访问 /actuator/gateway/routes 来查看当前的路由配置。

10. 总结

Spring Cloud Gateway 是一个功能强大的 API 网关，它提供了丰富的路由、过滤、限流、跨域等功能。通过本文的介绍，你应该已经掌握了如何配置 Spring Cloud Gateway 的基本功能。在实际项目中，你可以根据需求进一步定制和扩展网关的功能，以满足复杂的业务场景。

希望本文对你有所帮助，祝你在使用 Spring Cloud Gateway 的过程中取得成功！