【gateway系列】一步步带你学习gateway路由规则实践

朴灿烈づ我的快乐病毒、 2022-08-28 11:51 40阅读 0赞

### 目录 ###

*  1、准备
 *   *  微服务项目
     *  gateway网关服务
 *  2、Path
 *  3、Query
 *  4、Method
 *  5、DateTime
 *  6、RemoteAddr
 *  7、Header

# 1、准备 #

## 微服务项目 ##

新创建一个springBoot项目作为微服务，简单一个demo，如下：

@RestController
    public class MemberController { 
    
    
        @RequestMapping("/query-demo")
        public String queryDemo(String name) { 
            return "https://blog.csdn.net/"+ name + "/article/details/120475609";
        }
    
    }

*  yml

server:
      port: 8083
    spring:
      application:
        name: member-server

## gateway网关服务 ##

*  **引入依赖**

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-gateway</artifactId>
            </dependency>
    
     <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${ spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>

*  yml配置

server:
      port: 8082
    spring:
      application:
        name: gateway-demo
      cloud:
        gateway:
          # 路由规则
          routes:
            - id: csdn-service  #路由id，唯一
              uri: https://blog.csdn.net/  #目标URI，路由到微服务的地址
              predicates:           #断言（判断条件）
                - Path=/xuan_lu/** #匹配对应的URL请求，将匹配到的请求追加在目标URI之后

以下路由规则，均改变`predicates`断言项内容；

# 2、Path #

请求地址`http://localhost:8082/xuan_lu/article/details/120475609`  
直接跳转到：`https://blog.csdn.net/xuan_lu/article/details/120475609`  
**id**：我们自定义的路由 ID，保持唯一  
**uri**：目标服务地址  
**predicates**：路由条件，Predicate 接受一个输入参数，返回一个布尔值结果。

# 3、Query #

*  **请求参数断言**：  
    配置如下:

server:
      port: 8082
    spring:
      application:
        name: gateway-demo
      cloud:
        gateway:
          # 路由规则
          routes:
            - id: csdn-service  #路由id，唯一
              uri: http://localhost:8083/  #目标URI，路由到微服务的地址
              predicates:           #断言（判断条件）
                - Query=name    #匹配请求参数中包含name的请求

表示：请求地址中参数名字，必须含有**name**才会允许通过；  
`http://localhost:8082/query-demo?name=xl`

*  **请求参数和请求值断言**  
    上面参数值可能路由请求结果不是很明显是否成功，那么结合参数值就会会明显：

请求路由转发失败：`http://localhost:8082/query-demo?name=xuan`  
请求路由转发成功：`http://localhost:8082/query-demo?name=xuanlu1`

# 4、Method #

通过是 POST、GET、PUT、DELETE 等不同的请求方式来进行路由。

1.  未通过网关访问：为了验证请求方式，先将代码请求改为`@RequestMapping`注解标识，表明即支持GET请求，也允许POST请求，分别用浏览器和Postman工具验证，直接请求准备的微服务项目，端口为8083；  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5rqqfua6kA_size_20_color_FFFFFF_t_70_g_se_x_16]
2.  通过网关访问：微服务项目请求仍使用`@RequestMapping`注解，网关路由将断言设置为`GET`请求方式，使用PostMan访问如下：明显路由不通过；  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5rqqfua6kA_size_20_color_FFFFFF_t_70_g_se_x_16 1]

# 5、DateTime #

<table> 
 <thead> 
  <tr> 
   <th align="left">关键字</th> 
   <th align="left">格式</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">Before</td> 
   <td align="left">- Before=2021-09-27T17:42:47.000+08:00[Asia/Shanghai]</td> 
   <td align="left">在某个时间之前的请求才会被转发到 http://localhost:8083服务器上</td> 
  </tr> 
  <tr> 
   <td align="left">After</td> 
   <td align="left">- After=2021-09-27T17:42:47.000+08:00[Asia/Shanghai]</td> 
   <td align="left">在某个时间之后的请求才会被转发</td> 
  </tr> 
  <tr> 
   <td align="left">Between</td> 
   <td align="left">- Between=2021-09-27T17:42:47.000+08:00Asia/Shanghai],2021-09-27T17:42:47.000+08:00[Asia/Shanghai]</td> 
   <td align="left">在某个时间段之间的才会被转发</td> 
  </tr> 
 </tbody> 
</table>

server:
      port: 8082
    spring:
      application:
        name: gateway-demo
      cloud:
        gateway:
          # 路由规则
          routes:
            - id: csdn-service  #路由id，唯一
              uri: http://localhost:8083/  #目标URI，路由到微服务的地址
              predicates:           #断言（判断条件）
                - After=2021-09-27T17:42:47.000+08:00[Asia/Shanghai]    #匹配请求时间上海时间17点42分之后

验证通过：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5rqqfua6kA_size_20_color_FFFFFF_t_70_g_se_x_16 2]  
反之，因为小编测试时，时间是20点，所以改为21点，测试验证是否通过：结果很明显失败；  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5rqqfua6kA_size_20_color_FFFFFF_t_70_g_se_x_16 3]

# 6、RemoteAddr #

通过设置某个 ip 区间号段的请求才会路由，RemoteAddr Route Predicate 接受 cidr 符号(IPv4 或 IPv6 )字符串的列表(最小大小为1)，例如 192.168.0.1/16 (其中 192.168.0.1 是 IP 地址，16 是子网掩码)。

# 7、Header #

Header Route Predicate:可以接收 2 个参数，一个 header 中属性名称和一个正则表达式，这个属性值和正则表达式匹配则执行。

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

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5rqqfua6kA_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/b3ff8111751d4372a9beded44cd3ecdc.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5rqqfua6kA_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220828/7713154d3c134470a536173432d1aa07.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5rqqfua6kA_size_20_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220828/738ae8106c524f02b4da76c77e98b06e.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5rqqfua6kA_size_20_color_FFFFFF_t_70_g_se_x_16 3]: /images/20220828/5656100d182e473ebe3e8cf4407ed368.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5rqqfua6kA_size_20_color_FFFFFF_t_70_g_se_x_16 4]: /images/20220828/3306fc22cf4f46f08bbf0ed4d67f0616.png