gateway网关的断言(predicate)和过滤(filter)

- 日理万妓 2022-09-10 01:18 404阅读 0赞

### 文章目录 ###

*  1、GateWay路由断言工厂
 *   *  1.1 After Route Predicate Factory
     *  1.2 Before Route Predicate Factory
     *  1.3 Between Route Predicate Factory
     *  1.4 Cookie Route Predicate Factory
     *  1.5 Header Route Predicate Factory
     *  1.6 Host Route Predicate Factory
     *  1.7 Method Route Predicate Factorty
     *  1.8 Path Route Predicate Factory
     *  1.9 Query Route Predicate Factory
     *  1.10 RemoteAddr Route Predicate Factory
     *  1.11 Weight Route Predicate Factory
 *  2、Gateway过滤器工厂
 *   *  2.1 AddRequestParameter GatewayFilter
     *  2.2 The AddRequestHeader GatewayFilter Factory
     *  2.3 The AddResponseHeader GatewayFilter Factory
     *  2.4 StripPath GatewayFilter
     *  2.5 PrefixPath GatewayFilter
 *  3、通过网关提供web路径查看路由详细规则
 *  4、自定义网关全局filter

# 1、GateWay路由断言工厂 #

Spring Cloud Gateway包括许多内置的路由断言(Route Predicate)工厂，所有这些Predicate都与HTTP请求的不同属性匹配。多个Route Predicate工厂可以进行组合。  
官方文档：[https://docs.spring.io/spring-cloud-gateway/docs/2.2.9.RELEASE/reference/html/\#gateway-request-predicates-factories][https_docs.spring.io_spring-cloud-gateway_docs_2.2.9.RELEASE_reference_html_gateway-request-predicates-factories]

## 1.1 After Route Predicate Factory ##

在指定时间之后的请求会匹配该路由，具体代码如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16]  
上述代码的意思是只有在2021-09-01 21:53:53时间之后的请求才会匹配该路由。

## 1.2 Before Route Predicate Factory ##

在指定时间之前的请求会匹配该路由，具体代码如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 1]  
只有在2021-09-01 21:57:57时间之前的请求才会匹配该路由。

## 1.3 Between Route Predicate Factory ##

在指定时间区间内的请求会匹配该路由，具体代码如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 2]  
只有在2021-09-01 21:50:53到2021-09-01 22:01:53时间段内的请求才会匹配该路由。

## 1.4 Cookie Route Predicate Factory ##

带有指定Cookie的请求会匹配该路由，具体代码如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 3]  
cookie的值可用正则表达式匹配：  
![在这里插入图片描述][bbcf5e5544f8400690972bed7b03afef.png]  
上述意思是字母或者数字组成的值都可以被路由匹配。

## 1.5 Header Route Predicate Factory ##

带有指定请求头的请求会匹配该路由  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 4]  
这个可以用postman工具或者curl命令测试：

curl http://localhost:7979/product/list -H "X-Request-Id:12"

或者：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 5]  
结果：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 6]

## 1.6 Host Route Predicate Factory ##

带有指定Host的请求会匹配该路由，具体代码如下：

spring:
      cloud:
        gateway:
          routes:
          - id: host_route
            uri: https://example.org
            predicates:
            - Host=**.somehost.org,**.anotherhost.org

使用curl工具发送带有请求有为Host:www.anotherhost.org的请求可以匹配该路由：

curl http://localhost:9201/user/1 -H "Host:Www.anotherhost.org"

## 1.7 Method Route Predicate Factorty ##

发送指定方法的请求会匹配该路由，具体代码如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 7]  
上述代码意思是：get请求的方法才可以匹配该路由。

## 1.8 Path Route Predicate Factory ##

发送指定路径的请求会匹配该路由，具体代码如下：

spring:
      cloud:
        gateway:
          routes:
          - id: path_route
            uri: https://example.org
            predicates:
            - Path=/red/{ segment},/blue/{ segment}

使用curl工具发送/red/1 或者/blue/1 路径请求可以匹配该路由，具体如下：

curl http://localhost:8080/red/1
    curl http://localhost:8080/blue/1

## 1.9 Query Route Predicate Factory ##

带指定查询参数的请求可以匹配该路由：

spring:
      cloud:
        gateway:
          routes:
          - id: query_route
            uri: https://example.org
            predicates:
            - Query=green

使用curl工具发送带green=1查询参数的请求可以匹配该路由：

http://localhost:9201/hello?green=1

## 1.10 RemoteAddr Route Predicate Factory ##

从指定远程地址发起的请求可以匹配该路由：

spring:
      cloud:
        gateway:
          routes:
          - id: remoteaddr_route
            uri: https://example.org
            predicates:
            - RemoteAddr=192.168.1.1/24

使用curl工具从192.168.1.1发起请求可以匹配该路由：

curl http://localhost:9201/hello

## 1.11 Weight Route Predicate Factory ##

使用权重来路由相应请求，以下代码表示有80%的请求会被路由到weighthigh.org、20%会被路由到weightlow.org。

spring:
      cloud:
        gateway:
          routes:
          - id: weight_high
            uri: https://weighthigh.org
            predicates:
            - Weight=group1, 8
          - id: weight_low
            uri: https://weightlow.org
            predicates:
            - Weight=group1, 2

# 2、Gateway过滤器工厂 #

路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应。Spring Cloud Gateway内置了多种路由过滤器，由GatewayFilter的工厂类禅城。下面介绍常用路由过滤器的用法。  
官方文档：[https://docs.spring.io/spring-cloud-gateway/docs/2.2.9.RELEASE/reference/html/\#gatewayfilter-factories][https_docs.spring.io_spring-cloud-gateway_docs_2.2.9.RELEASE_reference_html_gatewayfilter-factories]

## 2.1 AddRequestParameter GatewayFilter ##

AddRequestParameter GatewayFilter是给请求添加参数的过滤器，具体代码如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 8]  
以上配置回对请求添加color=blue的请求参数，通过curl工具使用以下命令进行测试：

curl http://localhost:7979/product/list

相当于发起如下请求：

curl http://localhost:8799/product/list?color=blue

## 2.2 The AddRequestHeader GatewayFilter Factory ##

用来给当前路由对象的所有请求加入指定请求头信息(键和值)  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 9]  
我们可以在服务被调用方打印携带的头信息：  
![在这里插入图片描述][66936709ab4848beb54e140e04ea1796.png]  
![在这里插入图片描述][281dd6d7da214ec09fbf9bf79acf3c31.png]

## 2.3 The AddResponseHeader GatewayFilter Factory ##

响应加入指定的头信息  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 10]  
使用portman发送`http://localhost:7979/product/list`请求之后，查看头信息：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 11]

## 2.4 StripPath GatewayFilter ##

StripPath GatewayFilter是对指定数量的路径前缀进行去除的过滤器。

spring:
      cloud:
        gateway:
          routes:
          - id: nameRoot
            uri: http：//localhost:8080
            predicates:
            - Path=/user-service/**
            filters:
            - StripPrefix=1

以上配置会把以/user-service/开头的请求的路径去除两位，可以利用curl工具使用以下命令进行测试：

curl http://localhost:9201/user-service/a/user/1

相当于发起如下请求：

curl http://localhost:8080/user/1

## 2.5 PrefixPath GatewayFilter ##

与StripPrefix过滤器恰好相反，PrefixPath GatewayFilter是回对原有路径进行增加操作的过滤器：

spring:
      cloud:
        gateway:
          routes:
          - id: prefixpath_route
            uri: http://localhost:8080
            predicates:
             - Method=GET 
            filters:
            - PrefixPath=/user

以上配置回对所有GET请求添加/user路径前缀，可以利用curl工具使用如下命令进行测试：

curl http://localhost:9201/1

相当于发起如下请求：

curl http://localhost:8080/user/1

> 更多的过滤器请查看官网。

# 3、通过网关提供web路径查看路由详细规则 #

查看网关路由规则详细路径必须在网关配置文件中暴露当前路径

management:
      endpoints:
        web:
          exposure:
            include: "*" #开启所有web端点暴露

访问：`http://localhost:7979/actuator/gateway/routes`  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_17_color_FFFFFF_t_70_g_se_x_16]

# 4、自定义网关全局filter #

package com.baizhi.filters;
    
    import org.springframework.cloud.gateway.filter.GatewayFilterChain;
    import org.springframework.cloud.gateway.filter.GlobalFilter;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.Ordered;
    import org.springframework.http.server.reactive.ServerHttpRequest;
    import org.springframework.http.server.reactive.ServerHttpResponse;
    import org.springframework.web.server.ServerWebExchange;
    import reactor.core.publisher.Mono;
    
    /** * 自定义网关全局filter */
    @Configuration
    public class CustomerGlobalFilter  implements GlobalFilter,Ordered { 
    
        //类似javaweb的doFilter
        //exchange ：request response 封装了request response
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { 
            //httprequest对象
            ServerHttpRequest request = exchange.getRequest();
            //httpresponse对象
            ServerHttpResponse response = exchange.getResponse();
            System.out.println("经过全局Filter处理......");
    
    
            Mono<Void> filter = chain.filter(exchange); //放行filter继续向后执行
            System.out.println("响应回来filter的处理......");
            return filter;
        }
    
    
        /** * @return int数字：用来指定filter执行顺序 默认顺序按照自然数字进行排序 * -1 在所有filter执行之前执行 */
        @Override
        public int getOrder() { 
            return 0;
        }
    }

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 12]  
从下面控制台的打印情况来看，每次请求都会经过全局过滤器。  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_14_color_FFFFFF_t_70_g_se_x_16]

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

[https_docs.spring.io_spring-cloud-gateway_docs_2.2.9.RELEASE_reference_html_gateway-request-predicates-factories]: https://docs.spring.io/spring-cloud-gateway/docs/2.2.9.RELEASE/reference/html/#gateway-request-predicates-factories
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/cde7588657984a3e9e0e76695352dc52.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220829/46e852acb5e041329186321e5ad14363.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220829/7bff17a3f3ea4ea7b82f1d4516e326d8.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 3]: /images/20220829/ca059994145d4bd1bb3cd7c03f268884.png
[bbcf5e5544f8400690972bed7b03afef.png]: /images/20220829/3da0ba85d5554a8d99bcf66319f35fd2.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 4]: /images/20220829/862bd3f59c924b17b54ff3dbe5e8bb90.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 5]: /images/20220829/84012ae596264a459f0d7ac77631266b.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 6]: /images/20220829/cb4f68859734471f8d7d8e103b52b8f8.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 7]: /images/20220829/e2e4be063cb7453eb0ee780f94ee66bd.png
[https_docs.spring.io_spring-cloud-gateway_docs_2.2.9.RELEASE_reference_html_gatewayfilter-factories]: https://docs.spring.io/spring-cloud-gateway/docs/2.2.9.RELEASE/reference/html/#gatewayfilter-factories
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 8]: /images/20220829/bd3de9511ac44ea78892f15e72057473.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 9]: /images/20220829/b4c2557c4162471fa28a7098a0ba9db3.png
[66936709ab4848beb54e140e04ea1796.png]: /images/20220829/c45499f6a03042b79466e4e27487305c.png
[281dd6d7da214ec09fbf9bf79acf3c31.png]: /images/20220829/4bdc481690a04e5e91f62df3b508dd4f.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 10]: /images/20220829/b616ffd09e3c418c95d382c49ca597cd.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 11]: /images/20220829/ae062fad02f946a281f7e3015641b3dd.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_17_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/2d8d6990faa843789514f4262a8e3680.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_20_color_FFFFFF_t_70_g_se_x_16 12]: /images/20220829/bcfca9eb97da42b5b64031bf1a8fc102.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5Yir5Zui562Jc2h55ZOl5Y-R6IKy_size_14_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/7d5aa818ec7b47aab86836dae611b44e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUzNzI0_size_16_color_FFFFFF_t_70_pic_center_pic_center]: /images/20220829/7ca0dc8e76f9423b91642f8674e5037d.png