Spring Cloud GateWay常用配置项说明

小鱼儿 2022-09-02 14:57 204阅读 0赞

Spring Cloud GateWay采用异步非阻塞网络模型，效率高配置简单，是作为服务网关的不二选择。我们只需要在项目中引入GateWay的依赖，添加GateWay的配置就可以使用GateWay。依赖如下：

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>

Spring Cloud GateWay常用配置如下：

spring:
      application:
        name: futureGateway
      cloud:
        gateway:
          routes:
            - id: accountServiceRouter # 路由ID，保持唯一
              uri: lb://accountService # 目标服务地址
              predicates: # 断言（路由条件）
                - Path=/account/** - id: accountServiceRouter2 # 测试过滤器 uri: lb://accountService # 目标服务地址 predicates: # 断言（路由条件） - Path=/client/account/** filters: # 过滤器 - StripPrefix=1 # 截去路径中的/client，剩余部分和uri的值拼接作为转发地址，数字代表要截去的位数 - id: emailServiceRouter uri: http://127.0.0.1:8201 predicates: - Path=/email/**

Spring Cloud GateWay的配置以路由为单位，一个路由由一个ID，一个目标地址，一组断言和一组过滤器组成，每个路由代表一组请求转发的规则。  
**id**：在一个网关中，id要是唯一的，命名的时候方便区分即可。  
**uri**：请求转发的目标地址，可以以http、https和lb为前缀，以lb为前缀的时候表示这是一个动态路由，GateWay会根据lb://后面的服务名称从服务注册中心中获取服务实例，然后将请求转发到具体的服务地址，实现负载均衡。  
**predicates**：断言，通过断言可以设置一组路由条件，可以根据请求方式、请求头、请求参数、请求主机和请求路径等断言进行设置，通常我们使用请求路径进行设置，只要请求地址和Path中的地址匹配，就会将请求转发，多个路径以逗号分隔，例如：

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

**filters**：过滤器，使用过滤器可以在网关转发请求前和接收响应后执行一些操作，例如鉴权、限流等，例如StripPrefix可以去掉客户端请求地址中的若干路径，然后将剩余的路径和uri中的地址拼接后转发。  
Filter分两种，GatewayFilter和GlobalFilter，GatewayFilter应用在单个路由上，GlobalFilter应用在全局路由上。因为GlobalFilter可以使所有的路由都生效，所以可以用来实现统一的鉴权、日志记录等功能。

**版本信息**  
JDK：1.11  
Spring Boot：2.3.9.RELEASE  
Spring Cloud：Hoxton.SR9

**示例地址**  
[https://gitee.com/shiyonghm/future-spring-cloud-parent][https_gitee.com_shiyonghm_future-spring-cloud-parent]

[https_gitee.com_shiyonghm_future-spring-cloud-parent]: https://gitee.com/shiyonghm/future-spring-cloud-parent