SpringCloud 组件Gateway服务网关【断言工厂&过滤器工厂】

迷南。 2023-10-02 23:23 15阅读 0赞

**目录**

1：断言工厂

2：过滤器工厂

2.1：路由过滤器的种类

2.2：请求头过滤器

2.3：默认过滤器

2.4：总结

--------------------

### 1：断言工厂 ###

**路由断言工厂Route Predicate Factory**

路由配置包括：

1. 路由id：路由的唯一标示

2. 路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡

**3. 路由断言（predicates）：路由断言，判断请求是否符合要求，符合则转发到路由目的地**

4. 路由过滤器（filters）：路由过滤器，请求或响应做处理

示例：

![9fb59e94a91647e3a16783169069b4f6.png][]

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件

例如Path=/consumer/\*\*是按照路径匹配的一种规则，这个规则是由

`org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory`类来

处理的，像这样的断言工厂在SpringCloudGateway还有十几个:

<table> 
 <thead> 
  <tr> 
   <th><strong>名称</strong></th> 
   <th><strong>说明</strong></th> 
   <th><strong>示例</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>After</td> 
   <td>是某个时间点后的请求</td> 
   <td>- After=2037-01-20T17:42:47.789-07:00[America/Denver]</td> 
  </tr> 
  <tr> 
   <td>Before</td> 
   <td>是某个时间点之前的请求</td> 
   <td>- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]</td> 
  </tr> 
  <tr> 
   <td>Between</td> 
   <td>是某两个时间点之前的请求</td> 
   <td>- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]</td> 
  </tr> 
  <tr> 
   <td>Cookie</td> 
   <td>请求必须包含某些cookie</td> 
   <td>- Cookie=chocolate, ch.p</td> 
  </tr> 
  <tr> 
   <td>Header</td> 
   <td>请求必须包含某些header</td> 
   <td>- Header=X-Request-Id, \d+</td> 
  </tr> 
  <tr> 
   <td>Host</td> 
   <td>请求必须是访问某个host（域名）</td> 
   <td>- Host=<strong>.somehost.org,</strong>.anotherhost.org</td> 
  </tr> 
  <tr> 
   <td>Method</td> 
   <td>请求方式必须是指定方式</td> 
   <td>- Method=GET,POST</td> 
  </tr> 
  <tr> 
   <td>Path</td> 
   <td>请求路径必须符合指定规则</td> 
   <td>- Path=/red/{segment},/blue/**</td> 
  </tr> 
  <tr> 
   <td>Query</td> 
   <td>请求参数必须包含指定参数</td> 
   <td>- Query=name, Jack或者- Query=name</td> 
  </tr> 
  <tr> 
   <td>RemoteAddr</td> 
   <td>请求者的ip必须是指定范围</td> 
   <td>- RemoteAddr=192.168.1.1/24</td> 
  </tr> 
  <tr> 
   <td>Weight</td> 
   <td>权重处理</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

在官方网站的示例中可以找到[Spring Cloud Gateway][]

![2d6000cd363e41c6bbcaecac5926effd.png][]像示例中的Path，用到的是官网中5.8的路由断言工厂的规则

演示一下5.1中的断言工厂中的After规则

**示例1：在2031年之后可访问，那当前时间肯定是不符合时间规则，所以无法通过判断进行了路由跳转，找不到报错404**

![b11b999cbbcd4835ba8eaba935db56bb.png][]

predicates:                      #断言，也就是判断请求是否复合路由规则的条件
              - Path=/consumer/**            #这个是按照路径匹配，只要以/consumer/开头就符合要求
              - After=2031-01-20T17:42:47.789-07:00[Asia/Shanghai]

![6d08684aec274974abb737cf4fda8371.png][]

演示一下5.2中的断言工厂中的Before规则

**示例2：在2031年之前可访问，那当前时间是符合时间规则，即可通过路由的跳转**

![59ada05d44d24ed48a66ec00d6316660.png][]

![5c5af4c6dbf54646ae959662efb32e7c.png][]

**示例3：通过请求参数匹配**

spring:
      cloud:
        gateway:
          routes:
            - id: query
              uri: http://www.czxy.com
              predicates:
                - Query=my,123
    #访问路径，有参数my将转发到www.czxy.com
    http://localhost:10010/?my=123

**PredicateFactory的作用是什么呢？**

断言工厂，读取配置中使用的是哪种断言工厂的规则，而后解析成对应的条件，将来请求进来了进行判断！

**Path=/user/\*\*是什么含义呢？**

判断请求路径是否为user开头的规则条件，只要符合user开头就是符合了条件！

**注意：**

*  各种 Predicates 同时存在于同一个路由时，请求必须同时满足所有的条件才被这个路由匹配。
 *  一个请求满足多个路由的断言条件时，请求只会被首个成功匹配的路由转发

### 2：过滤器工厂 ###

GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：

![7ab040185e8a4bcc987507c77557c9e5.png][]

*  路由过滤器允许以某种方式修改传入的HTTP请求或传出HTTP响应。对请求或者响应进行增强

#### 2.1：路由过滤器的种类 ####

链接：[spring][]

Spring提供了31种不同的路由过滤器工厂，可到官网查看。例如：

![11c1d388d8774a9daffadb8fc9418cea.png][]

<table> 
 <thead> 
  <tr> 
   <th>过滤规则</th> 
   <th>实例</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>PrefixPath</td> 
   <td>- PrefixPath=/app</td> 
   <td>对所有的请求路径添加前缀app</td> 
  </tr> 
  <tr> 
   <td>RedirectTo</td> 
   <td>- RedirectTo=302, <a href="http://czxy.com" title="首页 - 传智专修学院" rel="nofollow">首页 - 传智专修学院</a></td> 
   <td>重定向，配置包含重定向的返回码和地址</td> 
  </tr> 
  <tr> 
   <td>RemoveRequestHeader</td> 
   <td>- RemoveRequestHeader=X-Request-Foo</td> 
   <td>去掉某个请求头信息</td> 
  </tr> 
  <tr> 
   <td>RemoveResponseHeade</td> 
   <td>- RemoveResponseHeader=X-Request-Foo</td> 
   <td>去掉某个响应头信息</td> 
  </tr> 
  <tr> 
   <td>RemoveRequestParameter</td> 
   <td>- RemoveRequestParameter=red</td> 
   <td>去掉某个请求参数信息</td> 
  </tr> 
  <tr> 
   <td>RewritePath</td> 
   <td>- RewritePath=/where(?&lt;segment&gt;/?.<em>), /test(?&lt;segment&gt;/?.</em>)</td> 
   <td>改写路径 /where/... 改成 /test/...</td> 
  </tr> 
  <tr> 
   <td>SetPath</td> 
   <td>- SetPath=/{segment}</td> 
   <td>设置请求路径，与RewritePath类似</td> 
  </tr> 
  <tr> 
   <td>SetRequestHeader</td> 
   <td>- SetRequestHeader=X-Request-Red, Blue</td> 
   <td>设置请求头信息</td> 
  </tr> 
  <tr> 
   <td>SetStatus</td> 
   <td>- SetStatus=401</td> 
   <td>设置响应状态码</td> 
  </tr> 
  <tr> 
   <td>StripPrefix</td> 
   <td>- StripPrefix=2</td> 
   <td>跳过指定路径</td> 
  </tr> 
  <tr> 
   <td>RequestSize</td> 
   <td>- name: RequestSize args: maxSize: 5000000</td> 
   <td>请求大小</td> 
  </tr> 
 </tbody> 
</table>

实例1：跳过指定路径（yml文件配置方法）

spring:
      cloud:
        gateway:
          routes:
            - id: consumer
              uri: lb://service-consumer  
              predicates:
                - Path=/consumer/**       
              filters:
                - StripPrefix=1

实例2：添加前缀（yml文件配置方法）

#rest  --> http://localhost:10010/consumer/echo/123
    #fegin --> http://localhost:10010/consumer/feign/echo/123
    
    spring:
      cloud:
        gateway:
          routes:
            - id: PrefixPath
              uri: lb://service-consumer
              predicates:
                - Path=/consumer/**
              filters:
                - StripPrefix=1
                - PrefixPath=/feign
    
    #feign  --> http://localhost:10010/consumer/echo/123

实例3：改写路径（yml文件配置方法）

#rest --> http://localhost:10010/consumer/echo/123
    
    spring:
      cloud:
        gateway:
          routes:
            - id: RewritePath
              uri: lb://service-consumer
              predicates:
                - Path=/consumer/**
              filters:
                - RewritePath=/consumer(?<segment>/?.*), $\{segment}
    
    # 正则表达式详解：
    
    # ?<segment> --> 名称为 segment 的组
    # /?		 --> /出现0次或1次
    # .*		 --> 任意字符出现0次或多次
    # 总结：将 /?.*匹配到的结果捕获到名称为segment的组中
    
    # $\{segment} --> 将名称为 segment 的分组捕获到的文本置换到此处
    ## 注意，\的出现是由于避免 yaml 语法认为这是一个变量

#### 2.2：请求头过滤器(示例官网过滤器工厂6.1程序演示) ####

![ac7511b46e9b4f33aca73a153f34ec4d.png][]

下面我们以AddRequestHeader 为例。

> **需求**：给所有进入service-consumer的请求添加一个请求头：Truth=I can succeed

只需要修改gateway服务的application.yml文件，添加路由过滤即可：

#端口号
    server:
      port: 10010
    spring:
      application:
        name: test-gateway
      cloud:
        nacos:
          discovery:
            server-addr: localhost:8848   #nacos服务地址
        gateway:
          routes:   # 网关路由配置
          - id: consumer                  #自定义，路由id，只要唯一即可
            uri: lb://service-consumer     #访问路径，路由的目标地址 lb是负载均衡，后面跟着服务名称
            predicates:                      #断言，也就是判断请求是否复合路由规则的条件
              - Path=/consumer/**            #这个是按照路径匹配，只要以/consumer/开头就符合要求
              - Before=2031-01-20T17:42:47.789-07:00[Asia/Shanghai]
            filters:                      #过滤器
              - AddRequestHeader=qx,I can succeed ! #添加请求头
              - StripPrefix=1  #跳过前缀进行访问，这里即使把请求参数中consumer跳过，发送请求

编写controller测试方法用来测试请求头中是否携带

@RestController
    @RequestMapping("/user")
    public class UserController {
        /**
         * 测试过滤器工程，添加请求头
         * @param
         * @return
         */
        @GetMapping("/test")
        public String test(@RequestHeader("qx") String qx){
            return qx;
        }

![c29bfbfe4e1b4ede924d54b95e89a64e.png][]

当前过滤器写在service-consumer服务路由下，因此仅仅对访问service-consumer的请求有效。

#### 2.3：默认过滤器 ####

如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

#端口号
    server:
      port: 10010
    spring:
      application:
        name: test-gateway
      cloud:
        nacos:
          discovery:
            server-addr: localhost:8848   #nacos服务地址
        gateway:
          routes:   # 网关路由配置
          - id: consumer                  #自定义，路由id，只要唯一即可
            uri: lb://service-consumer     #访问路径，路由的目标地址 lb是负载均衡，后面跟着服务名称
            predicates:                      #断言，也就是判断请求是否复合路由规则的条件
              - Path=/consumer/**            #这个是按照路径匹配，只要以/consumer/开头就符合要求
              - Before=2031-01-20T17:42:47.789-07:00[Asia/Shanghai]
          default-filters: # 默认过滤项
              - AddRequestHeader=qx,I can succeed ! #添加请求头

#### 2.4：总结 ####

过滤器的作用是什么？

① 对路由的请求或响应做加工处理，比如添加请求头

② 配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么？

① 对所有路由都生效的过滤器

[9fb59e94a91647e3a16783169069b4f6.png]: https://img-blog.csdnimg.cn/9fb59e94a91647e3a16783169069b4f6.png
[Spring Cloud Gateway]: https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories
[2d6000cd363e41c6bbcaecac5926effd.png]: https://img-blog.csdnimg.cn/2d6000cd363e41c6bbcaecac5926effd.png
[b11b999cbbcd4835ba8eaba935db56bb.png]: https://img-blog.csdnimg.cn/b11b999cbbcd4835ba8eaba935db56bb.png
[6d08684aec274974abb737cf4fda8371.png]: https://img-blog.csdnimg.cn/6d08684aec274974abb737cf4fda8371.png
[59ada05d44d24ed48a66ec00d6316660.png]: https://img-blog.csdnimg.cn/59ada05d44d24ed48a66ec00d6316660.png
[5c5af4c6dbf54646ae959662efb32e7c.png]: https://img-blog.csdnimg.cn/5c5af4c6dbf54646ae959662efb32e7c.png
[7ab040185e8a4bcc987507c77557c9e5.png]: https://img-blog.csdnimg.cn/7ab040185e8a4bcc987507c77557c9e5.png
[spring]: https://mp.csdn.net/mp_blog/creation/editor/128040472?spm=1000.2115.3001.5352
[11c1d388d8774a9daffadb8fc9418cea.png]: https://img-blog.csdnimg.cn/11c1d388d8774a9daffadb8fc9418cea.png
[ac7511b46e9b4f33aca73a153f34ec4d.png]: https://img-blog.csdnimg.cn/ac7511b46e9b4f33aca73a153f34ec4d.png
[c29bfbfe4e1b4ede924d54b95e89a64e.png]: https://img-blog.csdnimg.cn/c29bfbfe4e1b4ede924d54b95e89a64e.png