SpringCloud Gateway中斷言路由和過濾器的使用詳解
一、Gateway概念
Spring Cloud Gateway（簡稱 Gateway）是一個(gè)基于 Spring WebFlux 的 API 網(wǎng)關(guān)解決方案，旨在為微服務(wù)架構(gòu)中的客戶端提供路由、負(fù)載均衡、認(rèn)證、限流、監(jiān)控等功能。
它作為微服務(wù)架構(gòu)中的流量入口，通常位于客戶端和后端微服務(wù)之間，處理來自客戶端的請求并將其路由到相應(yīng)的服務(wù)。
主要特性：
- 路由功能：Spring Cloud Gateway 可以根據(jù)請求的不同特征（如路徑、方法、頭部、參數(shù)等）將請求路由到不同的微服務(wù)。
- 負(fù)載均衡：支持與服務(wù)注冊中心（如 Eureka）集成，能夠?qū)⒘髁糠职l(fā)到多個(gè)實(shí)例，以實(shí)現(xiàn)負(fù)載均衡。
- 過濾器：提供了豐富的過濾器功能，可以在請求和響應(yīng)的生命周期中進(jìn)行定制化處理。例如，身份認(rèn)證、日志記錄、限流等。
- 反向代理：可以將請求轉(zhuǎn)發(fā)給后端服務(wù)，實(shí)現(xiàn)反向代理功能。
- 高可用和可擴(kuò)展性：通過與 Spring Cloud 配合使用，Spring Cloud Gateway 能夠在微服務(wù)架構(gòu)中提供高可用和擴(kuò)展性支持。
- 監(jiān)控：可以與 Spring Boot Actuator 集成，提供請求和響應(yīng)的監(jiān)控功能，幫助開發(fā)人員監(jiān)控系統(tǒng)的健康狀況和性能。
二、基本路由
路由是將客戶端請求發(fā)送到后端服務(wù)的主要組件。它定義了請求的匹配規(guī)則以及請求將被轉(zhuǎn)發(fā)到的目標(biāo)（即URI）。每個(gè)路由都具有一個(gè)id、uri以及predicates。
id：每個(gè)路由的唯一標(biāo)識(shí)符。uri：路由轉(zhuǎn)發(fā)的目標(biāo)URI。對于lb://協(xié)議，它指向服務(wù)注冊中心（如Eureka）中的服務(wù)，表示請求將被轉(zhuǎn)發(fā)到注冊的服務(wù)。predicates：定義了路由的匹配條件，決定哪些請求將被此路由處理。
spring:
cloud:
gateway:
routes:
- id: order-route
uri: lb://service-order
predicates:
- Path=/api/order/**三、斷言
斷言（Predicates） 用于根據(jù)請求的各種屬性來匹配路由，它們是路由的核心部分。
斷言支持不同的匹配條件，如路徑、請求方法、請求頭等。通過不同的請求模式來匹配對應(yīng)的微服務(wù)。
3.1在Spring Cloud Gateway的配置中，斷言有兩種寫法
- 長寫法：指定完整的斷言語法，明確標(biāo)明斷言的類型。
spring:
cloud:
gateway:
routes:
- id: order-route
uri: lb://service-order
predicates:
- name: Path
args:
pattern: /api/order/**- 短寫法：是斷言的簡化寫法，直接使用斷言類型的簡潔形式。
spring:
cloud:
gateway:
routes:
- id: order-route
uri: lb://service-order
predicates:
- Path=/api/order/**系統(tǒng)內(nèi)置斷言（Predicates）
Spring Cloud Gateway 提供了很多內(nèi)置的斷言類型，用來處理各種請求匹配需求。常用的斷言類型包括：
這張圖展示了Spring Cloud Gateway中常用的路由斷言（Predicates）及其相關(guān)參數(shù)說明。斷言是路由配置的重要組成部分，它們用來判斷請求是否滿足特定條件，以決定是否將請求轉(zhuǎn)發(fā)到目標(biāo)服務(wù)。
每種斷言都允許通過指定參數(shù)來對請求進(jìn)行詳細(xì)匹配。
3.2自定義斷言
我們通過繼承 AbstractRoutePredicateFactory 類，創(chuàng)建了一個(gè)名為 VipRoutePredicateFactory 的類，實(shí)現(xiàn)了自定義的路由斷言邏輯，示例代碼如下：
import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.apache.commons.lang3.StringUtils;
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;
/**
* 自定義路由斷言工廠
*/
@Component
public class VipRoutePredicateFactory extends AbstractRoutePredicateFactory<VipRoutePredicateFactory.Config> {
public VipRoutePredicateFactory() {
super(Config.class); // 傳入Config類
}
@Override
public List<String> shortcutFieldOrder() {
// 返回配置類中的字段順序
return Arrays.asList("param", "value");
}
@Override
public Predicate<ServerWebExchange> apply(Config config) {
return new GatewayPredicate() {
@Override
public boolean test(ServerWebExchange serverWebExchange) {
// 獲取請求
ServerHttpRequest request = serverWebExchange.getRequest();
// 從請求的查詢參數(shù)中獲取 'param' 對應(yīng)的值
String first = request.getQueryParams().getFirst(config.param);
// 比較查詢參數(shù)的值與配置中的 'value' 是否匹配
return StringUtils.isNotBlank(first) && first.equals(config.value);
}
};
}
// 配置類
public static class Config {
private String param; // 查詢參數(shù)名稱
private String value; // 查詢參數(shù)期望的值
// Getter和Setter方法
public String getParam() {
return param;
}
public void setParam(String param) {
this.param = param;
}
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
}
}VipRoutePredicateFactory 類
- 該類繼承自
AbstractRoutePredicateFactory，實(shí)現(xiàn)了自定義斷言工廠的功能。 AbstractRoutePredicateFactory是 Spring Cloud Gateway 提供的基礎(chǔ)類，用于創(chuàng)建自定義的路由斷言。- 我們將
Config.class作為構(gòu)造函數(shù)的參數(shù)傳遞給父類，表示我們會(huì)用Config類來存儲(chǔ)斷言所需的配置參數(shù)。
shortcutFieldOrder() 方法
- 這個(gè)方法返回一個(gè)
List<String>，用于定義配置類中字段的順序。 - 在這個(gè)例子中，
param和value的順序決定了用戶在配置時(shí)，param和value應(yīng)該以這個(gè)順序出現(xiàn)。 - Spring Cloud Gateway 使用
shortcutFieldOrder()方法來生成簡潔的 YAML 配置。
spring:
cloud:
gateway:
routes:
- id: vip-route
uri: https://example.com
predicates:
- name: Vip(RoutePredicateFactory)//vip是斷言工廠名前綴
args:
param: q
value: testapply(Config config) 方法
- 這個(gè)方法用于應(yīng)用自定義斷言的邏輯，接收
Config類的實(shí)例作為參數(shù)。 Config類包含了路由斷言所需的參數(shù)（param和value）。- 該方法返回一個(gè)
Predicate<ServerWebExchange>，用于對每個(gè)請求進(jìn)行斷言判斷。
這里的 Predicate<ServerWebExchange> 表示一個(gè)函數(shù)，它接收一個(gè) ServerWebExchange（表示當(dāng)前請求），并返回一個(gè)布爾值，表示該請求是否匹配該斷言。
test(ServerWebExchange serverWebExchange) 方法
- 在這個(gè)方法中，我們實(shí)際執(zhí)行請求的匹配邏輯。首先通過
serverWebExchange.getRequest()獲取當(dāng)前請求對象。接著，我們從請求的查詢參數(shù)中獲取與config.param對應(yīng)的值，存儲(chǔ)在first變量中。 - 然后，我們檢查
first是否為空，并與config.value進(jìn)行比較。如果它們相等，并且查詢參數(shù)不為空，我們返回true，表示路由匹配成功；否則返回false，表示路由不匹配。
Config 類
Config類是一個(gè)靜態(tài)類，用來存儲(chǔ)自定義斷言需要的配置參數(shù)。這里有兩個(gè)字段：param表示查詢參數(shù)的名稱，value表示查詢參數(shù)的期望值。用戶通過配置文件傳入這兩個(gè)參數(shù)。Config類的作用是封裝從配置文件中讀取的參數(shù)，并通過@Validated等注解進(jìn)行驗(yàn)證
四、過濾器
過濾器（Filters） 是用于在請求和響應(yīng)過程中執(zhí)行特定操作的機(jī)制。它們是在路由決策之前或之后執(zhí)行的，可以對請求進(jìn)行修改（如添加頭部、修改請求體）或響應(yīng)進(jìn)行處理（如修改響應(yīng)內(nèi)容、記錄日志等）。
過濾器的使用大致可以分為兩種類型：前置過濾器（pre-filter）和后置過濾器（post-filter）。前置過濾器在請求到達(dá)目標(biāo)服務(wù)之前執(zhí)行，后置過濾器則在響應(yīng)返回客戶端之前執(zhí)行。
過濾器主要用于以下目的：
- 請求和響應(yīng)的修改。
- 安全性（如身份驗(yàn)證）。
- 負(fù)載均衡和限流。
- 請求日志和性能監(jiān)控。
4.1基本的過濾器使用步驟
添加依賴： 需要在pom.xml文件中加入Spring Cloud Gateway的依賴：
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>創(chuàng)建過濾器： 可以通過實(shí)現(xiàn)GatewayFilter接口來創(chuàng)建自定義過濾器。Spring Cloud Gateway提供了GatewayFilter接口和GlobalFilter接口，分別用于處理特定路由和全局的請求過濾。
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Component
public class MyCustomFilter implements GatewayFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 在請求處理之前執(zhí)行的邏輯
System.out.println("請求被過濾： " + exchange.getRequest().getURI());
// 執(zhí)行后續(xù)過濾器鏈
return chain.filter(exchange);
}
}注冊過濾器： 自定義過濾器可以通過注入GatewayFilter的方式注冊到Spring的上下文中?？梢詫⑦^濾器注入到@Configuration中，或者直接使用@Component注解讓其自動(dòng)注冊。
配置路由過濾器： 在路由配置中，可以為某個(gè)特定的路由設(shè)置過濾器。
spring:
cloud:
gateway:
routes:
- id: my_route
uri: http://httpbin.org:80
predicates:
- Path=/get
filters:
- name: RequestHeaderToRequestUri
args:
name: X-Request-Id4.2全局過濾器使用步驟
全局過濾器是應(yīng)用于所有路由請求的過濾器，它們在請求到達(dá)目標(biāo)服務(wù)之前和響應(yīng)返回時(shí)都會(huì)被執(zhí)行。全局過濾器對于記錄日志、身份驗(yàn)證等場景非常有用。
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Component
public class LoggingGlobalFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 記錄請求的URL
String path = exchange.getRequest().getURI().getPath();
System.out.println("Request Path: " + path);
// 繼續(xù)處理鏈中的下一個(gè)過濾器
return chain.filter(exchange);
}
}4.3自定義過濾器使用步驟
Spring Cloud Gateway允許開發(fā)者創(chuàng)建自定義過濾器。
自定義過濾器有兩種類型：
GatewayFilter：只能作用于單個(gè)路由。GlobalFilter：作用于所有路由。
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.http.HttpStatus;
import reactor.core.publisher.Mono;
@Component
public class LoggingGlobalFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 獲取請求的路徑
String path = exchange.getRequest().getURI().getPath();
// 記錄請求的路徑
System.out.println("Request Path: " + path);
// 向請求中添加一個(gè)自定義的請求頭
exchange.getRequest().mutate()
.header("X-Request-ID", "Request-" + System.currentTimeMillis()) // 設(shè)置一個(gè)自定義請求頭
.build();
// 繼續(xù)處理請求
return chain.filter(exchange)
.doOnTerminate(() -> {
// 記錄響應(yīng)結(jié)束時(shí)的日志
System.out.println("Request " + path + " processed.");
});
}
}LoggingGlobalFilter 實(shí)現(xiàn)了 GlobalFilter 接口：
該過濾器會(huì)應(yīng)用于所有的請求，不管是哪個(gè)路由請求都會(huì)執(zhí)行這個(gè)過濾器的邏輯。
filter() 方法：
- 在這個(gè)方法中，首先我們通過
exchange.getRequest().getURI().getPath()獲取當(dāng)前請求的路徑。 - 然后，我們通過
System.out.println()打印日志，記錄下請求的路徑。 - 接著，我們使用
mutate()方法修改請求，添加了一個(gè)自定義的請求頭X-Request-ID，其值為當(dāng)前時(shí)間戳（這樣可以在日志中唯一標(biāo)識(shí)每個(gè)請求）。 - 最后，通過
chain.filter(exchange)將請求繼續(xù)傳遞給下一個(gè)過濾器鏈
4.4過濾器的執(zhí)行順序
Spring Cloud Gateway的過濾器按以下順序執(zhí)行：
- 請求過濾器：請求從客戶端進(jìn)入網(wǎng)關(guān)后，過濾器鏈會(huì)逐個(gè)執(zhí)行請求過濾器。
- 過濾器執(zhí)行順序是鏈?zhǔn)降模?code>GlobalFilter ->
GatewayFilter
- 過濾器執(zhí)行順序是鏈?zhǔn)降模?code>GlobalFilter ->
- 響應(yīng)過濾器：請求被轉(zhuǎn)發(fā)到目標(biāo)服務(wù)，響應(yīng)返回時(shí)，再次按鏈?zhǔn)綀?zhí)行響應(yīng)過濾器。
4.5常用過濾器
Spring Cloud Gateway提供了一些內(nèi)置的過濾器，可以直接使用。例如：
AddRequestHeader：添加請求頭部。AddResponseHeader：添加響應(yīng)頭部。RemoveRequestHeader：刪除請求頭部。RemoveResponseHeader：刪除響應(yīng)頭部。SetPath：修改請求路徑。RewritePath：重寫路徑。
添加請求頭的過濾器舉例：
spring:
cloud:
gateway:
routes:
- id: add-header-route
uri: http://localhost:8081
predicates:
- Path=/add-header/**
filters:
- AddRequestHeader=X-Custom-Header, Value總結(jié)
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
- 解決SpringCloud gateway網(wǎng)關(guān)配置MVC攔截器報(bào)錯(cuò)問題
- SpringCloud Gateway 權(quán)限認(rèn)證的實(shí)現(xiàn)
- SpringCloud Zuul和Gateway的實(shí)例代碼(搭建方式)
- SpringCloudGateway路由失效問題
- SpringCloud GateWay動(dòng)態(tài)路由用法
- SpringCloud Gateway路由核心原理解析
- SpringCloud-Gateway網(wǎng)關(guān)的使用實(shí)例教程
- 使用SpringCloud Gateway解決跨域問題
- SpringCloud網(wǎng)關(guān)Gateway功能實(shí)現(xiàn)
相關(guān)文章
Springboot項(xiàng)目全局異常統(tǒng)一處理案例代碼
最近在做項(xiàng)目時(shí)需要對異常進(jìn)行全局統(tǒng)一處理，主要是一些分類入庫以及記錄日志等，因?yàn)轫?xiàng)目是基于Springboot的，所以去網(wǎng)絡(luò)上找了一些博客文檔，然后再結(jié)合項(xiàng)目本身的一些特殊需求做了些許改造，現(xiàn)在記錄下來便于以后查看2023-01-01
這篇文章主要為大家詳細(xì)介紹了java單鏈表使用總結(jié)，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-01-01
這篇文章主要給大家介紹了關(guān)于java讀取zip/jar包中文件的幾種方式,在我們?nèi)粘Ｊ褂弥袎嚎s文件是非常常用的,文中通過示例代碼將java讀取zip/jar包中文件的方法介紹的非常詳細(xì),需要的朋友可以參考下2023-07-07
SpringBoot獲取http數(shù)據(jù)、打印HTTP參數(shù)的4種方式
Java的話本地打斷點(diǎn)可以調(diào)試獲取rest入?yún)?但是在生產(chǎn)環(huán)境可能我們獲取入?yún)ⅲ℉ttp?header/parameter）可能就沒有那么的輕松了,所以本文給大家介紹了SpringBoot獲取http數(shù)據(jù)、打印HTTP參數(shù)的4種方式,需要的朋友可以參考下2024-03-03
java正則表達(dá)式之Pattern與Matcher類詳解
這篇文章主要給大家介紹了關(guān)于java正則表達(dá)式之Pattern與Matcher類的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09
這篇文章主要介紹了Java之MyBatis入門詳解，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-12-12
Java實(shí)現(xiàn)swf圖片轉(zhuǎn)pdf的示例代碼
本文介紹了一種將SWF文件中的多張圖片提取并轉(zhuǎn)換為PDF文件的方法,首先,通過pom依賴提取SWF文件中的圖片,然后將這些圖片轉(zhuǎn)換為PDF格式,整個(gè)過程中,詳細(xì)測試了該方法的可行性和有效性,需要的朋友可以參考下2026-05-05
使用Java實(shí)現(xiàn)PDF轉(zhuǎn)多種圖片格式
在Java開發(fā)中,處理PDF文檔是一項(xiàng)常見任務(wù),很多場景都需要將PDF轉(zhuǎn)換為圖片格式（如PNG、JPG）或矢量圖格式（如SVG）,下面我們就來看看具體實(shí)現(xiàn)方法吧2025-09-09
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)大文本文件拆分，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-05-05
spring cloud gateway轉(zhuǎn)發(fā)服務(wù)報(bào)錯(cuò)的解決
這篇文章主要介紹了spring cloud gateway轉(zhuǎn)發(fā)服務(wù)報(bào)錯(cuò)的解決，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-09-09