SpringCloud 2.x学习笔记：14、Spring Cloud Gateway路由断言工厂（Greenwich版本）

本是古典何须时尚 2022-01-09 23:13 232阅读 0赞

### 1、Predicate断言 ###

gateway-predicate模块的pom.xml

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.cntaiping.tpa</groupId>
        <artifactId>gateway-predicate</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
        <name>gateway-predicate</name>
        <description>Demo project for Spring Boot</description>
    
        <parent>
            <groupId>com.cntaiping.tpa</groupId>
            <artifactId>gateway</artifactId>
            <version>1.0-SNAPSHOT</version>
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-gateway</artifactId>
            </dependency>
        </dependencies>
    
    </project>

### 2、 After路由断言 ###

After Route Predicate Factory，可配置一个UTC时间格式的时间参数，当请求进来的当前时间在路由断言工厂之后会成功匹配，才交给 router去处理。否则则报错，不通过路由。

server:
      port: 7012
    spring:
      profiles:
        active: query_route
    
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: after_route
            uri: http://httpbin.org:80/get
            predicates:
            - After=2017-01-20T17:42:47.789-07:00[America/Denver]
    #        - After=2018-04-1T17:42:47.789-07:00[Asia/Shanghai]
      profiles: after_route

package com.cntaiping.tpa.gatewaypredicate;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class GatewayPredicateApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(GatewayPredicateApplication.class, args);
        }
    
    }

配置spring.profiles.active:after\_route指定了程序的spring的启动文件为after\_route文件。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70]

[http://localhost:7012/][http_localhost_7012]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 1]

- After=2020-01-20T17:42:47.789-07:00[America/Denver]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 2]

### 3、 Between路由断言 ###

Between路由断言工厂接受两个参数，datetime1和datetime2。该谓词匹配发生在datetime1与datetime2之间请求。

---
    spring:
      cloud:
        gateway:
          routes:
          - id: between_route
            uri: http://httpbin.org/get
            predicates:
            - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2019-01-21T17:42:47.789-07:00[America/Denver]
      profiles: between_route

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 3]

- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2019-01-21T17:42:47.789-07:00[America/Denver]

- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2020-01-21T17:42:47.789-07:00[America/Denver]

### 4、 Header路由断言 ###

Header由断言工厂接受两个参数，头名称和正则表达式。这个谓词与给定名称的头匹配，该值与正则表达式匹配。  
Header Route Predicate Factory需要2个参数，一个是header名，另外一个header值，该值可以是一个正则表达式。当此断言匹配了请求的header名和值时，断言通过，进入到router的规则中去。

---
    spring:
      cloud:
        gateway:
          routes:
          - id: header_route
            uri: http://httpbin.org/get
            predicates:
            - Header=X-Request-Id, \d+
      profiles: header_route

当请求的Header中有X-Request-Id的header名，且header值为数字时，请求会被路由到配置的 uri.  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 4]

curl -H 'X-Request-Id:1' localhost:7012

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 5]

如果在请求中没有带上X-Request-Id的header名，并且值不为数字时，请求就会报404，路由没有被正确转发。  
![在这里插入图片描述][20190621091408864.png]

### 5、 Cookie路由断言 ###

Cookie路由断言工厂接受两个参数：一个时cookie名字，另一个时值，可以为正则表达式。它用于匹配请求中，带有该名称的cookie和cookie匹配正则表达式的请求。

---
    spring:
      cloud:
        gateway:
          routes:
          - id: cookie_route
            uri: http://httpbin.org:80/get
            predicates:
            - Cookie=flag, ch.p
      profiles: cookie_route

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 6]

curl -H Cookie:flag=chip localhost:7012

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 7]

### 6、 Host 路由断言 ###

Host路由断言工厂接受一个参数：需要一个参数即hostname。它可以使用. \* 等去匹配host。这个参数会匹配请求头中的host的值，一致，则请求正确转发。

---
    spring:
      cloud:
        gateway:
          routes:
          - id: host_route
            uri: http://httpbin.org:80/get
            predicates:
            - Host=**.hadron.cn
      profiles: host_route

请求头中含有Host为hadron.cn的请求将会被路由转发转发到配置的uri。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 8]

curl -H Host:www.hadron.cn localhost:7012

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 9]

### 7、 Method 路由断言 ###

Method路由断言工厂接受一个参数：HTTP方法来匹配。

---
    spring:
      cloud:
        gateway:
          routes:
          - id: method_route
            uri: http://httpbin.org:80/post
            predicates:
            - Method=POST
      profiles: method_route

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 10]

curl -XPOST localhost:7012
    curl localhost:7012

![在这里插入图片描述][20190621095344995.png]  
![在这里插入图片描述][20190621095324127.png]

### 8、 Path 路由断言 ###

Path路由断言工厂接受一个参数：采用Spring PathMatcher 模式。

---
    spring:
      cloud:
        gateway:
          routes:
          - id: path_route
            uri: http://httpbin.org
            predicates:
            - Path=/foo/{segment}
      profiles: path_route

请求路径满足/foo/\{segment\}的请求将会匹配并被路由，比如/foo/1 、/foo/bar的请求，将会命中匹配，并成功转发。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 11]  
请注意，`curl http://localhost:7012/foo/1`已经请求成功(结果含有HTML标签)，返回结果是服务器没有这个值。而`curl http://localhost:7012/fee/1`请求拒绝。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 12]

### 9、 Query路由断言 ###

Query路由断言工厂接受两个参数：一个必需的参数(param)和一个可选的表达式(regexp)。

---
    spring:
      cloud:
        gateway:
          routes:
          - id: query_route
            uri: http://httpbin.org:80/get
            predicates:
            - Query=flag
      profiles: query_route

这个路由将匹配如果请求包含一个flag查询参数。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 13]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 14]

### 10、RemoteAddr路由断言 ###

RemoteAddr路由断言工厂支持通过设置某个 ip 区间号段的请求才会路由，接受 cidr 符号(IPv4 或 IPv6 )字符串的列表(最小大小 1)

---
    spring:
      cloud:
        gateway:
          routes:
          - id: remoteaddr_route
            uri: http://httpbin.org:80/get
            predicates:
            - RemoteAddr=10.17.36.1/24
      profiles: remoteaddr_route

这个路由将匹配请求的远程地址为10.17.36网段，例如，我的本地机地址是10.17.36.27。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 15]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 16]

### 11、组合使用 ###

---
    spring:
      cloud:
        gateway:
          routes:
          - id: group_route
            uri: http://httpbin.org
            predicates:
            - Host=**.httpbin.com
            - Header=X-Request-Id, \d+
            - Cookie=name, chengyuqiang
            - After=2019-06-20T00:00:00+08:00[Asia/Shanghai]
      profiles: group_route

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 17]

curl localhost:7012 -H "X-Request-Id:520" -H "Host:www.httpbin.com" --cookie "name=chengyuqiang"

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 18]

### 12、完整的pom.xml ###

server:
      port: 7012
    
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: after_route
            uri: http://httpbin.org/get
            predicates:
            - After=2020-01-20T17:42:47.789-07:00[America/Denver]
            #- After=2018-04-1T17:42:47.789-07:00[Asia/Shanghai]
      profiles: after_route
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: between_route
            uri: http://httpbin.org/get
            predicates:
            - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2020-01-21T17:42:47.789-07:00[America/Denver]
      profiles: between_route
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: header_route
            uri: http://httpbin.org/get
            predicates:
            - Header=X-Request-Id, \d+
      profiles: header_route
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: cookie_route
            uri: http://httpbin.org:80/get
            predicates:
            - Cookie=flag, ch.p
      profiles: cookie_route
    
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: host_route
            uri: http://httpbin.org:80/get
            predicates:
            - Host=**.hadron.cn
      profiles: host_route
    
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: method_route
            uri: http://httpbin.org:80/get
            predicates:
            - Method=get
      profiles: method_route
    
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: path_route
            uri: http://httpbin.org
            predicates:
            - Path=/foo/{segment}
      profiles: path_route
    
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: query_route
            uri: http://httpbin.org:80/get
            predicates:
            - Query=flag
      profiles: query_route
    
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: remoteaddr_route
            uri: http://httpbin.org:80/get
            predicates:
            - RemoteAddr=10.17.36.1/24
      profiles: remoteaddr_route
    
    ---
    spring:
      cloud:
        gateway:
          routes:
          - id: group_route
            uri: http://httpbin.org
            predicates:
            - Host=**.httpbin.com
            - Header=X-Request-Id, \d+
            - Cookie=name, chengyuqiang
            - After=2019-06-20T00:00:00+08:00[Asia/Shanghai]
      profiles: group_route

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70]: /images/20220109/2dbca4685d1d432f86d5738bffa9a34e.png
[http_localhost_7012]: http://localhost:7012/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 1]: /images/20220109/02ab868b09504a739f2a89132c05b233.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 2]: /images/20220109/799c9c81089f45ca96ed7ad8e9c6b1aa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 3]: /images/20220109/4d0bf45eac094b4591721bcca72f4fcf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 4]: /images/20220109/eef4234b1fb54f018fc5c4ef8fe8e3c8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 5]: /images/20220109/b362825197d34315a9355fdec028216f.png
[20190621091408864.png]: /images/20220109/1cffee4b111f4a2581a74b67195ae421.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 6]: /images/20220109/ead5e04c1abb42aebd7c39ff991f659a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 7]: /images/20220109/dac3db54fea24daf892e35200fab745a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 8]: /images/20220109/037337d6c2084cb4826535e3960aed68.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 9]: /images/20220109/a0dc55f3008c445ba06354b521434a95.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 10]: /images/20220109/8be6dea383864965a09fc6d0d4476dcd.png
[20190621095344995.png]: /images/20220109/a5d5f953355144eba3e47b4ca8089725.png
[20190621095324127.png]: /images/20220109/39b23b59134241d5ae824e5c0146d20d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 11]: /images/20220109/f215314161914de29d854aa264b6f7d8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 12]: /images/20220109/2bcb3b31eef84d3dac84e9fcbe90daf9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 13]: /images/20220109/ff689d8f2439474982d078e89925952c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 14]: /images/20220109/2fd399cb594240f589b45d5c55820dc6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 15]: /images/20220109/28dd4b4a500d4ea2ade395672bb9dea8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 16]: /images/20220109/112c14e6fe824529a1e8799b38d150d1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 17]: /images/20220109/d0da24a4f92b4c64b6fb51c658737734.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXVxaWFuZw_size_16_color_FFFFFF_t_70 18]: /images/20220109/dfd5adbc2f4748a18243de50cb4e2d56.png