前言

對應版本3.1.7對應SpringCloud版本2021.0.7

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

一、內置斷言

1.AfterRoutePredicateFactory

作用：判斷當請求時間是否在指定配置時間之后

使用方式

spring.cloud.gateway.routes[0].predicates[0]=After=2019-04-20T17:42:47.789+08:00[Asia/Shanghai]
#也可以用下面的方式配置
#spring.cloud.gateway.routes[0].predicates[0].name=After
#spring.cloud.gateway.routes[0].predicates[0].args.datetime=2019-04-20T17:42:47.789+08:00[Asia/Shanghai]

使用場景：當上線一新服務時在未來某個時間提供服務

兩種配置方式的區(qū)別：

• 第一種便捷方式配置的值是按逗號分隔，再按shortcutFieldOrder方法返回的字段順序最后綁定的配置對象上。
• 第二種配置方式即標準配置方式，會把整個map作為配置對象綁定源
• 區(qū)別就是第一種最多只會綁定指定的字段盡管可能配置類字段有其它字段！

2.BeforeRoutePredicateFactory

作用：與AfterRoutePredicateFactory正好相反，判斷當請求時間是否在指定配置時間之前

使用方式

spring.cloud.gateway.routes[0].predicates[0]=Before=2019-04-20T17:42:47.789+08:00[Asia/Shanghai]

使用場景：指定服務在指定時間以內訪問

3.BetweenRoutePredicateFactory

作用：判斷當請求時間是否在指定配置時間之間

使用方式

spring.cloud.gateway.routes[0].predicates[0].name=Between
#在datetime1后面即請求時間大于該時間
spring.cloud.gateway.routes[0].predicates[0].args.datetime1=2029-04-20T17:42:47.789+08:00[Asia/Shanghai]
#在datetime2前面即請求時間小于該時間
spring.cloud.gateway.routes[0].predicates[0].args.datetime2=2019-04-20T17:42:47.789+08:00[Asia/Shanghai]

使用場景：指定服務在指定時間范圍內訪問

4.CloudFoundryRouteServiceRoutePredicateFactory

作用：判斷請求是否針對 Cloud Foundry 路由服務（通過判斷請求頭中是否有X-CF-Forwarded-Url、X-CF-Proxy-Signature、X-CF-Proxy-Metadata這個三個配置）

使用方式

spring.cloud.gateway.routes[0].predicates[0]=CloudFoundryRouteService

5.CookieRoutePredicateFactory

作用：判斷請求中cookie是否包含指定字段的以及對應的值是否符合指定的模式(正則表達式)

使用方式

# cookie中id的值必須是數(shù)字
spring.cloud.gateway.routes[0].predicates[0]=Cookie=id, \\d+

6.HeaderRoutePredicateFactory

作用：判斷請求頭中是否包含指定字段的以及對應的值是否符合指定的模式(正則表達式)

使用方式

# header中X-Request-Id的值必須是數(shù)字
spring.cloud.gateway.routes[0].predicates[0]=Header=X-Request-Id, \\d+

7.HostRoutePredicateFactory

作用：接收一個參數(shù)，主機名模式。判斷請求的Host是否滿足匹配規(guī)則

使用方式

spring.cloud.gateway.routes[0].predicates[0]=Host=api1.hiboot.cn,api2.hiboot.cn

8.MethodRoutePredicateFactory

作用：判斷請求方法類型是否跟指定的類型匹配

使用方式

#指定路由只接受post和get請求
spring.cloud.gateway.routes[0].predicates[0]=Method=POST,GET

9.PathRoutePredicateFactory

作用：判斷請求的URI部分是否滿足路徑規(guī)則。使用PathContainer解析

使用方式

spring.cloud.gateway.routes[0].predicates[0]=Path=/web/**

10.QueryRoutePredicateFactory

作用： 判斷請求參數(shù)（QueryParams）是否具有給定名稱且值與正則表達式匹配

使用方式

#指定請求參數(shù)age必須是數(shù)字
spring.cloud.gateway.routes[0].predicates[0]=Query=age,\\d+

11.ReadBodyRoutePredicateFactory

作用：讀取請求體并緩存，后續(xù)調用謂詞不需要再次反序列化

使用方式

spring.cloud.gateway.routes[0].predicates[0].name=ReadBody
spring.cloud.gateway.routes[0].predicates[0].args.inClass=java.lang.String
spring.cloud.gateway.routes[0].predicates[0].args.predicate=#{@testRequestBody}

12.RemoteAddrRoutePredicateFactory

作用：判斷請求訪問者的地址是否在指定指定ip/mask內

使用方式

spring.cloud.gateway.routes[0].predicates[0]=RemoteAddr=192.168.1.0/24

使用場景：配置服務只允許指定ip可訪問

13.WeightRoutePredicateFactory

作用：接收一個[組名,權重], 然后對于同一個組內的路由按照權重轉發(fā)

使用方式

spring.cloud.gateway.routes[0].predicates[0]=Weight=group1,1

14.XForwardedRemoteAddrRoutePredicateFactory

作用：判斷是否允許根據(jù)“ X-Forward-For” HTTP標頭過濾請求

使用方式

spring.cloud.gateway.routes[0].predicates[0]=XForwardedRemote=192.168.1.0/24,192.168.4.0/24

使用場景：與反向代理一起使用，例如負載平衡器或Web應用程序防火墻僅當請求來自可信賴的IP地址列表時，才允許該請求反向代理。

二、內置過濾器

1.GlobalFilter

• RemoveCachedBodyFilter
• AdaptCachedBodyGlobalFilter
• NettyWriteResponseFilter
• GatewayMetricsFilter
• RouteToRequestUrlFilter
• ReactiveLoadBalancerClientFilter
• LoadBalancerServiceInstanceCookieFilter
• WebsocketRoutingFilter
• NettyRoutingFilter
• ForwardRoutingFilter

2.GatewayFilter

• AddRequestHeaderGatewayFilterFactory
• MapRequestHeaderGatewayFilterFactory
• AddRequestParameterGatewayFilterFactory
• AddResponseHeaderGatewayFilterFactory
• ModifyRequestBodyGatewayFilterFactory
• DedupeResponseHeaderGatewayFilterFactory
• ModifyResponseBodyGatewayFilterFactory
• CacheRequestBodyGatewayFilterFactory
• PrefixPathGatewayFilterFactory
• PreserveHostHeaderGatewayFilterFactory
• RedirectToGatewayFilterFactory
• RemoveRequestHeaderGatewayFilterFactory
• RemoveRequestParameterGatewayFilterFactory
• RemoveResponseHeaderGatewayFilterFactory
• RequestRateLimiterGatewayFilterFactory
• RewritePathGatewayFilterFactory
• RetryGatewayFilterFactory
• SetPathGatewayFilterFactory
• SecureHeadersGatewayFilterFactory
• SetRequestHeaderGatewayFilterFactory
• SetRequestHostHeaderGatewayFilterFactory
• SetResponseHeaderGatewayFilterFactory
• RewriteResponseHeaderGatewayFilterFactory
• RewriteLocationResponseHeaderGatewayFilterFactory
• SetStatusGatewayFilterFactory
• SaveSessionGatewayFilterFactory
• StripPrefixGatewayFilterFactory
• RequestHeaderToRequestUriGatewayFilterFactory
• RequestSizeGatewayFilterFactory
• RequestHeaderSizeGatewayFilterFactory

三、配置參數(shù)解析模式

1.DEFAULT

配置的默認處理方式 ：如果是便捷配置方式會根據(jù)接口中shortcutFieldOrder方法返回的字段順序注入

例如：spring.cloud.gateway.routes[1].predicates[2]=Header=X-Request-Id, \\d+，則會將Header=X-Request-Id設置name，\\d+設置給regex

	default List<String> shortcutFieldOrder() {
		return Arrays.asList("header", "regexp");
	}

	public static class Config {

		@NotEmpty
		private String header;

		private String regexp;
		...

	}

2.GATHER_LIST

該解析方式的條件必須是一個字段，將配置參數(shù)解析成集合

例如：spring.cloud.gateway.routes[1].predicates[2]=Method=post,get

	default List<String> shortcutFieldOrder() {
		return Arrays.asList("methods");
	}

	public static class Config {

		private HttpMethod[] methods;

		public HttpMethod[] getMethods() {
			return methods;
		}

		public void setMethods(HttpMethod... methods) {
			this.methods = methods;
		}

	}

3.GATHER_LIST_TAIL_FLAG

該解析方式的條件必須是兩個字段，前一個將配置參數(shù)解析成集合，后面一個必須要是Boolean類型數(shù)據(jù)

例如：spring.cloud.gateway.routes[1].predicates[2]=Path=/web/**, false

	default List<String> shortcutFieldOrder() {
		return Arrays.asList("patterns", "matchTrailingSlash");
	}

    public static class Config {

		private List<String> patterns = new ArrayList<>();

		private boolean matchTrailingSlash = true;
        
        ...
	}

總結

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論