Spring Boot Gateway 從入門到精通全面指南

更新時(shí)間：2025年09月26日 10:44:07 作者：Rysxt

Spring Cloud Gateway 作為微服務(wù)架構(gòu)中的重要組件,提供了強(qiáng)大而靈活的路由與過濾功能,通過本教程,您應(yīng)該已經(jīng)了解了如何集成 Spring Cloud Gateway、如何配置路由規(guī)則以及如何利用其豐富的功能來滿足各種業(yè)務(wù)需求,感興趣的朋友跟隨小編一起看看吧

一、Spring Cloud Gateway 簡(jiǎn)介

Spring Cloud Gateway 是基于 Spring 5、Project Reactor 和 Spring Boot 2 構(gòu)建的 API 網(wǎng)關(guān)，旨在為微服務(wù)架構(gòu)提供一種簡(jiǎn)單而有效的路由管理方式。它取代了 Netflix Zuul，提供了更高效和更強(qiáng)大的網(wǎng)關(guān)解決方案。

核心特點(diǎn)：

??反應(yīng)式編程模型??：基于 Project Reactor 的非阻塞高性能處理
??路由管理??：支持靈活的路由匹配規(guī)則
??過濾器機(jī)制??：提供全局和局部過濾器處理請(qǐng)求和響應(yīng)
??易于擴(kuò)展??：可通過自定義過濾器和路由器擴(kuò)展功能

二、Spring Cloud Gateway 核心概念

1. 三大核心組件

??Route（路由）??：網(wǎng)關(guān)的基本構(gòu)建塊，定義了請(qǐng)求路徑與服務(wù)之間的映射關(guān)系
??Predicate（斷言）??：Java 8 的 Predicate，用于匹配 HTTP 請(qǐng)求中的任何內(nèi)容（如 headers 或參數(shù)）
??Filter（過濾器）??：可以在請(qǐng)求被路由前后修改請(qǐng)求和響應(yīng)的組件

2. 工作流程

客戶端向 Spring Cloud Gateway 發(fā)出請(qǐng)求
如果 Gateway Handler Mapping 中找到與請(qǐng)求相匹配的路由，將其發(fā)送到 Gateway Web Handler
Handler 再通過指定的過濾器鏈來將請(qǐng)求發(fā)送到我們實(shí)際的服務(wù)執(zhí)行業(yè)務(wù)邏輯，然后返回

三、Spring Boot 項(xiàng)目中集成 Gateway

1. 添加依賴

在 Maven 項(xiàng)目的 pom.xml 文件中添加以下依賴：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
    <version>4.3.0</version> <!-- 版本號(hào)根據(jù)實(shí)際情況選擇 -->
</dependency>

對(duì)于 Gradle 項(xiàng)目，在 build.gradle 中添加：

implementation 'org.springframework.cloud:spring-cloud-starter-gateway:2.2.6.RELEASE'

2. 啟用網(wǎng)關(guān)

在 Spring Boot 應(yīng)用程序的入口類上，通常不需要特殊注解，因?yàn)?Spring Cloud Gateway 會(huì)自動(dòng)配置。但如果你使用的是較新版本，可能需要確保有 @SpringBootApplication 注解：

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

四、Spring Cloud Gateway 的 YML 配置詳解

Spring Cloud Gateway 的路由配置主要通過 application.yml 或 application.properties 文件完成。下面詳細(xì)介紹 YML 配置文件的規(guī)則與使用。

1. 基本路由配置結(jié)構(gòu)

spring:
  cloud:
    gateway:
      routes:
        - id: route_id              # 路由的唯一標(biāo)識(shí)符，必須唯一
          uri: http://example.com   # 目標(biāo)服務(wù)的URI
          predicates:               # 斷言列表，用于匹配請(qǐng)求
            - Path=/example/**      # 示例斷言：匹配以/example/開頭的路徑
          filters:                  # 過濾器列表，用于處理請(qǐng)求和響應(yīng)
            - StripPrefix=1         # 示例過濾器：去除路徑中的第一層前綴

2. 配置項(xiàng)詳細(xì)說明

2.1 路由 (Routes)

routes 是一個(gè)路由配置的數(shù)組，每個(gè)路由包含以下主要屬性：

??id?? (必需): 路由的唯一標(biāo)識(shí)符，用于標(biāo)識(shí)和引用該路由
??uri?? (必需): 請(qǐng)求最終要被轉(zhuǎn)發(fā)的目標(biāo)地址
- 可以是普通的 HTTP/HTTPS URL，如 http://example.com
- 也可以使用服務(wù)發(fā)現(xiàn)機(jī)制，如 lb://SERVICE-NAME (負(fù)載均衡)
??predicates?? (可選): 斷言數(shù)組，用于判斷請(qǐng)求是否符合路由條件
??filters?? (可選): 過濾器數(shù)組，用于在請(qǐng)求轉(zhuǎn)發(fā)前后進(jìn)行處理
??order?? (可選): 路由的優(yōu)先級(jí)，數(shù)字越小優(yōu)先級(jí)越高

2.2 斷言 (Predicates)

斷言用于匹配 HTTP 請(qǐng)求中的各種條件，常用的斷言類型包括：

??Path?? - 路徑匹配

predicates:
  - Path=/api/**           # 匹配以/api/開頭的路徑

??Method?? - HTTP 方法匹配

predicates:
  - Method=GET,POST        # 匹配 GET 或 POST 請(qǐng)求

??Header?? - 請(qǐng)求頭匹配

predicates:
  - Header=X-Request-Id, \d+  # 匹配包含 X-Request-Id 頭且值為數(shù)字的請(qǐng)求

??Query?? - 查詢參數(shù)匹配

predicates:
  - Query=name, \d+        # 匹配包含 name 參數(shù)且值為數(shù)字的請(qǐng)求

??Host?? - 主機(jī)名匹配

predicates:
  - Host=**.example.com    # 匹配主機(jī)名為任意子域名.example.com 的請(qǐng)求

??Before/After/Between?? - 時(shí)間匹配

predicates:
  - Before=2023-01-01T00:00:00+08:00[Asia/Shanghai]  # 在指定時(shí)間之前匹配
  - After=2023-01-01T00:00:00+08:00[Asia/Shanghai]   # 在指定時(shí)間之后匹配
  - Between=2023-01-01T00:00:00+08:00[Asia/Shanghai], 2023-12-31T23:59:59+08:00[Asia/Shanghai]

??Cookie?? - Cookie 匹配

predicates:
  - Cookie=chocolate, ch.p  # 匹配包含名為 chocolate 且值匹配正則 ch.p 的 Cookie

2.3 過濾器 (Filters)

過濾器用于在請(qǐng)求轉(zhuǎn)發(fā)前后進(jìn)行處理，分為兩種類型：

??GatewayFilter?? - 單個(gè)路由的過濾器
??GlobalFilter?? - 全局過濾器，應(yīng)用于所有路由

常用過濾器配置：

??StripPrefix?? - 去除路徑前綴

filters:
  - StripPrefix=1           # 去除路徑中的第一層前綴

例如，請(qǐng)求 /api/service1/test，配置 StripPrefix=1 后，轉(zhuǎn)發(fā)路徑為 /service1/test

??RewritePath?? - 重寫路徑

filters:
  - RewritePath=/api/(?<segment>.*), /$\{segment}  # 將 /api/xxx 重寫為 /xxx

??AddRequestHeader?? - 添加請(qǐng)求頭

filters:
  - AddRequestHeader=X-Request-Foo, Bar  # 添加請(qǐng)求頭 X-Request-Foo: Bar

??AddResponseHeader?? - 添加響應(yīng)頭

filters:
  - AddResponseHeader=X-Response-Foo, Bar  # 添加響應(yīng)頭 X-Response-Foo: Bar

??PrefixPath?? - 添加路徑前綴

filters:
  - PrefixPath=/mypath  # 為所有請(qǐng)求路徑添加前綴 /mypath

??RequestRateLimiter?? - 請(qǐng)求限流

filters:
  - name: RequestRateLimiter
    args:
      redis-rate-limiter.replenishRate: 10   # 每秒允許的請(qǐng)求數(shù)
      redis-rate-limiter.burstCapacity: 20   # 每秒最大允許的請(qǐng)求數(shù)
      key-resolver: "#{@userKeyResolver}"    # 限流鍵解析器

2.4 服務(wù)發(fā)現(xiàn)與負(fù)載均衡

當(dāng)與 Spring Cloud DiscoveryClient (如 Eureka、Nacos) 集成時(shí)，可以使用服務(wù)發(fā)現(xiàn)功能：

spring:
  cloud:
    gateway:
      routes:
        - id: service_route
          uri: lb://SERVICE-NAME       # lb 表示負(fù)載均衡，SERVICE-NAME 是注冊(cè)的服務(wù)名
          predicates:
            - Path=/service/**
          filters:
            - StripPrefix=1

??lb://SERVICE-NAME??：使用負(fù)載均衡器將請(qǐng)求轉(zhuǎn)發(fā)到名為 SERVICE-NAME 的服務(wù)實(shí)例
??discovery.locator.enabled=true??：?jiǎn)⒂梅?wù)發(fā)現(xiàn)定位器，允許通過服務(wù)名動(dòng)態(tài)路由

3. 完整配置示例

下面是一個(gè)綜合性的配置示例，展示多種配置組合：

spring:
  cloud:
    gateway:
      # 啟用服務(wù)發(fā)現(xiàn)
      discovery:
        locator:
          enabled: true           # 啟用服務(wù)發(fā)現(xiàn)
          lower-case-service-id: true  # 服務(wù)ID使用小寫
      # 全局CORS配置
      globalcors:
        cors-configurations:
          '[/**]':
            allowedOrigins: "*"   # 允許所有源
            allowedMethods: "*"   # 允許所有HTTP方法
            allowedHeaders: "*"   # 允許所有請(qǐng)求頭
      # 路由配置
      routes:
        # 路由1：靜態(tài)路徑路由
        - id: order_service_route
          uri: lb://order-service  # 使用負(fù)載均衡轉(zhuǎn)發(fā)到order-service
          predicates:
            - Path=/api/order/**   # 匹配以/api/order/開頭的路徑
          filters:
            - StripPrefix=2        # 去除前兩級(jí)路徑，如/api/order/ → /
            - AddRequestHeader=X-Gateway-Header, GatewayValue  # 添加請(qǐng)求頭
        # 路由2：基于Header的路由
        - id: version_route
          uri: lb://user-service
          predicates:
            - Path=/api/user/**
            - Header=X-API-Version, v1  # 僅當(dāng)請(qǐng)求頭X-API-Version為v1時(shí)匹配
          filters:
            - RewritePath=/api/user/(?<segment>.*), /v1/$\{segment}  # 重寫路徑
        # 路由3：基于查詢參數(shù)的路由
        - id: query_route
          uri: http://example.com
          predicates:
            - Path=/query/**
            - Query=token, \d+  # 必須包含token參數(shù)且為數(shù)字
          filters:
            - StripPrefix=1
        # 路由4：自定義白名單路由（不需要認(rèn)證）
        - id: whitelist_route
          uri: http://backend-service
          predicates:
            - Path=/auth/login, /auth/register, /public/**
          filters:
            - StripPrefix=1
# 自定義白名單配置（可選，通過代碼實(shí)現(xiàn)）
ignore:
  whites:
    - /auth/login
    - /auth/register
    - /**/v2/api-docs
    - /public/**

4. 通過代碼配置路由

除了通過 YML 文件配置路由，還可以通過 Java 代碼配置，提供更高的靈活性：

@Configuration
public class GatewayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
            .route("path_route", r -> r.path("/get")
                .uri("http://httpbin.org"))
            .route("host_route", r -> r.host("*.myhost.org")
                .uri("http://httpbin.org"))
            .route("rewrite_route", r -> r.host("*.rewrite.org")
                .filters(f -> f.rewritePath("/foo/(?<segment>.*)", "/${segment}"))
                .uri("http://httpbin.org"))
            .route("hystrix_route", r -> r.path("/hystrix")
                .filters(f -> f.hystrix(config -> config.setName("mycmd").setFallbackUri("forward:/fallback")))
                .uri("http://httpbin.org"))
            .route("custom_filter_route", r -> r.path("/api/test/**")
                .filters(f -> f.rewritePath("/api/test/(?<segment>.*)", "/${segment}")
                    .filter(new CustomFilter()))
                .uri("lb://project-test"))
            .build();
    }
    // 自定義過濾器示例
    @Component
    public static class CustomFilter implements GatewayFilter {
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
            // 自定義過濾邏輯
            System.out.println("Custom Filter executed");
            return chain.filter(exchange);
        }
    }
}

五、高級(jí)配置與功能

1. 負(fù)載均衡

通過使用 lb://SERVICE-NAME 格式的 URI，Spring Cloud Gateway 可以與服務(wù)發(fā)現(xiàn)組件（如 Eureka、Nacos）集成，實(shí)現(xiàn)負(fù)載均衡：

spring:
  cloud:
    gateway:
      routes:
        - id: service_route
          uri: lb://SERVICE-NAME
          predicates:
            - Path=/service/**

確保在項(xiàng)目中集成了服務(wù)發(fā)現(xiàn)客戶端，如 Eureka 或 Nacos。

2. 全局過濾器

全局過濾器應(yīng)用于所有路由，常用于實(shí)現(xiàn)全局性的功能，如鑒權(quán)、日志記錄等。創(chuàng)建一個(gè)全局過濾器：

@Component
public class CustomGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 在請(qǐng)求處理前執(zhí)行的邏輯
        System.out.println("Global Pre Filter executed");
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {
            // 在請(qǐng)求處理后執(zhí)行的邏輯
            System.out.println("Global Post Filter executed");
        }));
    }
    @Override
    public int getOrder() {
        return -1; // 過濾器的執(zhí)行順序，數(shù)值越小優(yōu)先級(jí)越高
    }
}

3. 限流

使用 RequestRateLimiter 過濾器實(shí)現(xiàn)請(qǐng)求限流，通常與 Redis 配合使用：

spring:
  cloud:
    gateway:
      routes:
        - id: rate_limit_route
          uri: http://example.com
          predicates:
            - Path=/rate-limit/**
          filters:
            - name: RequestRateLimiter
              args:
                redis-rate-limiter.replenishRate: 10     # 每秒允許的請(qǐng)求數(shù)
                redis-rate-limiter.burstCapacity: 20     # 每秒最大允許的請(qǐng)求數(shù)
                key-resolver: "#{@userKeyResolver}"      # 限流鍵解析器，需在代碼中定義

需要在代碼中定義 key-resolver Bean，例如基于用戶 ID 限流：

@Bean
KeyResolver userKeyResolver() {
    return exchange -> Mono.just(exchange.getRequest().getQueryParams().getFirst("user"));
}

4. 熔斷與重試

結(jié)合 Resilience4j 或 Hystrix 實(shí)現(xiàn)熔斷和重試機(jī)制：

spring:
  cloud:
    gateway:
      routes:
        - id: circuit_breaker_route
          uri: http://example.com
          predicates:
            - Path=/circuit-breaker/**
          filters:
            - name: CircuitBreaker
              args:
                name: myCircuitBreaker
                fallbackUri: forward:/fallback

六、日志監(jiān)控與運(yùn)維

1. 日志功能

Spring Cloud Gateway 提供了豐富的日志功能，可以記錄請(qǐng)求和響應(yīng)的詳細(xì)信息，幫助進(jìn)行故障排查和性能優(yōu)化：

??控制臺(tái)日志??：默認(rèn)情況下，網(wǎng)關(guān)會(huì)將請(qǐng)求和響應(yīng)信息輸出到應(yīng)用日志中
??文件日志??：配置日志框架（如 Logback、Log4j2）將日志輸出到文件
??集成 ELK??：將日志發(fā)送到 Elasticsearch、Logstash 和 Kibana 進(jìn)行集中管理和分析

2. 監(jiān)控工具

使用監(jiān)控工具對(duì)網(wǎng)關(guān)的性能和流量進(jìn)行實(shí)時(shí)監(jiān)控和統(tǒng)計(jì)：

??Spring Boot Actuator??：提供健康檢查、指標(biāo)監(jiān)控等功能
??Prometheus + Grafana??：集成 Prometheus 收集指標(biāo)，使用 Grafana 進(jìn)行可視化展示
??Micrometer??：與應(yīng)用性能監(jiān)控系統(tǒng)（如 Atlas、Datadog、New Relic）集成

七、最佳實(shí)踐與常見問題

1. 最佳實(shí)踐

??合理設(shè)計(jì)路由規(guī)則??：根據(jù)業(yè)務(wù)需求設(shè)計(jì)清晰、簡(jiǎn)潔的路由規(guī)則，避免過于復(fù)雜的斷言組合
??使用服務(wù)發(fā)現(xiàn)??：與注冊(cè)中心集成，實(shí)現(xiàn)動(dòng)態(tài)路由和負(fù)載均衡，提高系統(tǒng)的彈性和可擴(kuò)展性
??實(shí)施安全策略??：通過過濾器實(shí)現(xiàn)鑒權(quán)、防止 SQL 注入、XSS 等安全措施
??監(jiān)控與日志??：實(shí)施全面的日志記錄和監(jiān)控，及時(shí)發(fā)現(xiàn)和解決問題
??性能優(yōu)化??：利用緩存、限流和熔斷機(jī)制，保障網(wǎng)關(guān)的高可用性和高性能

2. 常見問題

??路由不生效??：檢查路由的 predicates 是否正確匹配請(qǐng)求，確保 id 唯一，配置無誤
??性能瓶頸??：合理配置線程池和連接數(shù)，使用異步非阻塞模型，避免阻塞操作
??服務(wù)不可用??：確保后端服務(wù)正常運(yùn)行，與注冊(cè)中心集成正確，負(fù)載均衡策略合適
??跨域問題??：通過 globalcors 配置正確處理跨域請(qǐng)求，或通過過濾器自定義跨域策略

八、總結(jié)

Spring Cloud Gateway 作為微服務(wù)架構(gòu)中的重要組件，提供了強(qiáng)大而靈活的路由與過濾功能。通過本教程，您應(yīng)該已經(jīng)了解了如何集成 Spring Cloud Gateway、如何配置路由規(guī)則以及如何利用其豐富的功能來滿足各種業(yè)務(wù)需求。

YML 配置文件是配置 Spring Cloud Gateway 路由的主要方式，通過合理配置 routes、predicates 和 filters，可以實(shí)現(xiàn)復(fù)雜的路由邏輯和請(qǐng)求處理。同時(shí)，結(jié)合服務(wù)發(fā)現(xiàn)、負(fù)載均衡、限流、熔斷等高級(jí)功能，可以構(gòu)建高可用、高性能的微服務(wù)網(wǎng)關(guān)。

在實(shí)際項(xiàng)目中，建議根據(jù)具體業(yè)務(wù)需求，結(jié)合 Spring Cloud Gateway 的擴(kuò)展能力，定制適合的路由與過濾策略，并通過監(jiān)控與日志功能，確保網(wǎng)關(guān)的穩(wěn)定運(yùn)行與高效性能。

到此這篇關(guān)于Spring Boot Gateway 從入門到精通全面指南的文章就介紹到這了,更多相關(guān)Spring Boot Gateway教程內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

Spring Boot Gateway 從入門到精通全面指南

目錄

一、Spring Cloud Gateway 簡(jiǎn)介

核心特點(diǎn)：

二、Spring Cloud Gateway 核心概念

1. 三大核心組件

2. 工作流程

三、Spring Boot 項(xiàng)目中集成 Gateway

1. 添加依賴

2. 啟用網(wǎng)關(guān)

四、Spring Cloud Gateway 的 YML 配置詳解

1. 基本路由配置結(jié)構(gòu)

2. 配置項(xiàng)詳細(xì)說明

2.1 路由 (Routes)

2.2 斷言 (Predicates)

2.3 過濾器 (Filters)

2.4 服務(wù)發(fā)現(xiàn)與負(fù)載均衡

3. 完整配置示例

4. 通過代碼配置路由

五、高級(jí)配置與功能

1. 負(fù)載均衡

2. 全局過濾器

3. 限流

4. 熔斷與重試

六、日志監(jiān)控與運(yùn)維

1. 日志功能

2. 監(jiān)控工具

七、最佳實(shí)踐與常見問題

1. 最佳實(shí)踐

2. 常見問題

八、總結(jié)

相關(guān)文章

最新評(píng)論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

Spring Boot Gateway 從入門到精通全面指南

目錄

一、Spring Cloud Gateway 簡(jiǎn)介

核心特點(diǎn)：

二、Spring Cloud Gateway 核心概念

1. 三大核心組件

2. 工作流程

三、Spring Boot 項(xiàng)目中集成 Gateway

1. 添加依賴

2. 啟用網(wǎng)關(guān)

四、Spring Cloud Gateway 的 YML 配置詳解

1. 基本路由配置結(jié)構(gòu)

2. 配置項(xiàng)詳細(xì)說明

2.1 路由 (Routes)

2.2 斷言 (Predicates)

2.3 過濾器 (Filters)

2.4 服務(wù)發(fā)現(xiàn)與負(fù)載均衡

3. 完整配置示例

4. 通過代碼配置路由

五、高級(jí)配置與功能

1. 負(fù)載均衡

2. 全局過濾器

3. 限流

4. 熔斷與重試

六、日志監(jiān)控與運(yùn)維

1. 日志功能

2. 監(jiān)控工具

七、最佳實(shí)踐與常見問題

1. 最佳實(shí)踐

2. 常見問題

八、總結(jié)

相關(guān)文章

最新評(píng)論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

一、Spring Cloud Gateway 簡(jiǎn)介

二、Spring Cloud Gateway 核心概念

三、Spring Boot 項(xiàng)目中集成 Gateway

五、高級(jí)配置與功能

六、日志監(jiān)控與運(yùn)維

七、最佳實(shí)踐與常見問題

八、總結(jié)