Spring Cloud Gateway-路由谓词工厂详解（Route Predicate Factories）
# Spring Cloud Gateway-路由谓词工厂详解（Route Predicate Factories）
TIPS
本文基于Spring Cloud Greenwich SR2编写，兼容Spring Cloud Finchley及更高版本。
这一节来详细探讨Spring Cloud Gateway的路由谓词工厂 （Route Predicate Factories），路由谓词工厂的作用是：符合Predicate的条件，就使用该路由的配置，否则就不管。 只要掌握这一句，掌握路由谓词工厂就比较轻松了。
TIPS
Predicate是Java 8提供的一个函数式编程接口。
本文探讨了Spring Cloud Gateway中内置的谓词工厂，包括：
| 谓词工厂 |
|---|
| After |
| Before |
| Between |
| Cookie |
| Header |
| Host |
| Method |
| Path |
| Query |
| RemoteAddr |
# 路由配置的两种形式
先来探讨Spring Cloud Gateway路由配置的两种姿势：
# 路由到指定URL
# 示例1：通配
spring:
cloud:
gateway:
routes:
- id: {唯一标识}
uri: http://www.itmuch.com
1
2
3
4
5
6
2
3
4
5
6
表示访问 GATEWAY_URL/** 会转发到 http://www.itmuch.com/**
TIPS
这段配置不能直接使用，需要和下面的Predicate配合使用才行。
# 示例2：精确匹配
spring:
cloud:
gateway:
routes:
- id: {唯一标识}
uri: http://www.itmuch.com/spring-cloud/spring-cloud-stream-pan-ta/
1
2
3
4
5
6
2
3
4
5
6
表示访问 GATEWAY_URL/spring-cloud/spring-cloud-stream-pan-ta/ 会转发到 http://www.itmuch.com/spring-cloud/spring-cloud-stream-pan-ta/
TIPS
这段配置不能直接使用，需要和下面的Predicate配合使用才行。
# 路由到服务发现组件上的微服务
# 示例1：通配
spring:
cloud:
gateway:
routes:
- id: {唯一标识}
uri: lb://user-center
1
2
3
4
5
6
2
3
4
5
6
表示访问 GATEWAY_URL/** 会转发到 user-center 微服务的 /**
TIPS
这段配置不能直接使用，需要和下面的Predicate配合使用才行。
# 示例2：精确匹配
spring:
cloud:
gateway:
routes:
- id: {唯一标识}
uri: lb://user-center/shares/1
1
2
3
4
5
6
2
3
4
5
6
表示访问 GATEWAY_URL/shares/1 会转发到 user-center 微服务的 /shares/1
TIPS
这段配置不能直接使用，需要和下面的Predicate配合使用才行。
# 谓词工厂详解
下面正式探讨路由谓词工厂。Spring Cloud Gateway提供了十来种路由谓词工厂。为网关实现灵活的转发提供了基石。
# After
示例：
spring:
cloud:
gateway:
routes:
- id: after_route
uri: lb://user-center
predicates:
# 当且仅当请求时的时间After配置的时间时，才会转发到用户微服务
# 目前配置不会进该路由配置，所以返回404
# 将时间改成 < now的时间，则访问localhost:8040/** -> user-center/**
# eg. 访问http://localhost:8040/users/1 -> user-center/users/1
- After=2030-01-20T17:42:47.789-07:00[America/Denver]
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
TIPS
- 技巧：时间可使用
System.out.println(ZonedDateTime.now());打印，然后即可看到时区。例如：2019-08-10T16:50:42.579+08:00[Asia/Shanghai]- 时间格式的相关逻辑：
- 默认时间格式：org.springframework.format.support.DefaultFormattingConversionService#addDefaultFormatters
- 时间格式注册：org.springframework.format.datetime.standard.DateTimeFormatterRegistrar#registerFormatters
# Before
示例：
spring:
cloud:
gateway:
routes:
- id: before_route
uri: lb://user-center
predicates:
# 当且仅当请求时的时间Before配置的时间时，才会转发到用户微服务
# 目前配置不会进该路由配置，所以返回404
# 将时间改成 > now的时间，则访问localhost:8040/** -> user-center/**
# eg. 访问http://localhost:8040/users/1 -> user-center/users/1
- Before=2018-01-20T17:42:47.789-07:00[America/Denver]
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# Between
示例：
spring:
cloud:
gateway:
routes:
- id: between_route
uri: lb://user-center
predicates:
# 当且仅当请求时的时间Between配置的时间时，才会转发到用户微服务
# 因此，访问localhost:8040/** -> user-center/**
# eg. 访问http://localhost:8040/users/1 -> user-center/users/1
- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2027-01-21T17:42:47.789-07:00[America/Denver]
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Cookie
示例：
spring:
cloud:
gateway:
routes:
- id: cookie_route
uri: lb://user-center
predicates:
# 当且仅当带有名为somecookie，并且值符合正则ch.p的Cookie时，才会转发到用户微服务
# 如Cookie满足条件，则访问http://localhost:8040/** -> user-center/**
# eg. 访问http://localhost:8040/users/1 -> user-center/users/1
- Cookie=somecookie, ch.p
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Header
spring:
cloud:
gateway:
routes:
- id: header_route
uri: lb://user-center
predicates:
# 当且仅当带有名为X-Request-Id，并且值符合正则\d+的Header时，才会转发到用户微服务
# 如Header满足条件，则访问http://localhost:8040/** -> user-center/**
# eg. 访问http://localhost:8040/users/1 -> user-center/users/1
- Header=X-Request-Id, \d+
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Host
spring:
cloud:
gateway:
routes:
- id: host_route
uri: lb://user-center
predicates:
# 当且仅当名为Host的Header符合**.somehost.org或**.anotherhost.org时，才会转发用户微服务
# 如Host满足条件，则访问http://localhost:8040/** -> user-center/**
# eg. 访问http://localhost:8040/users/1 -> user-center/users/1
- Host=**.somehost.org,**.anotherhost.org
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Method
spring:
cloud:
gateway:
routes:
- id: method_route
uri: lb://user-center
predicates:
# 当且仅当HTTP请求方法是GET时，才会转发用户微服务
# 如请求方法满足条件，访问http://localhost:8040/** -> user-center/**
# eg. 访问http://localhost:8040/users/1 -> user-center/users/1
- Method=GET
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Path
spring:
cloud:
gateway:
routes:
- id: path_route
uri: lb://user-center
predicates:
# 当且仅当访问路径是/users/*或者/some-path/**，才会转发用户微服务
# segment是一个特殊的占位符，单层路径匹配
# eg. 访问http://localhost:8040/users/1 -> user-center/users/1
- Path=/users/{segment},/some-path/**
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
TIPS
建议大家看下这一部分的官方文档，里面有个segment编程技巧。比较简单，留个印象。
https://cloud.spring.io/spring-cloud-static/Greenwich.SR2/single/spring-cloud.html#_path_route_predicate_factory1
# Query
示例1：
spring:
cloud:
gateway:
routes:
- id: query_route
uri: lb://user-center
predicates:
# 当且仅当请求带有baz的参数，才会转发到用户微服务
# eg. 访问http://localhost:8040/users/1?baz=xx -> user-center的/users/1
- Query=baz
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
示例2：
spring:
cloud:
gateway:
routes:
- id: query_route
uri: lb://user-center
predicates:
# 当且仅当请求带有名为foo的参数，且参数值符合正则ba.，才会转发到用户微服务
# eg. 访问http://localhost:8040/users/1?baz=baz -> user-center的/users/1?baz=baz
- Query=foo, ba.
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# RemoteAddr
示例：
spring:
cloud:
gateway:
routes:
- id: remoteaddr_route
uri: lb://user-center
predicates:
# 当且仅当请求IP是192.168.1.1/24网段，例如192.168.1.10，才会转发到用户微服务
# eg. 访问http://localhost:8040/users/1 -> user-center的/users/1
- RemoteAddr=192.168.1.1/24
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
TIPS
建议大家看下这一部分的官方文档，有个小编程技巧。比较简单，留个印象。
https://cloud.spring.io/spring-cloud-static/Greenwich.SR2/single/spring-cloud.html#_remoteaddr_route_predicate_factory1
# 相关代码
Last Updated: 2023/02/14, 18:02:00