Gateway

荒流2021年12月22日大约 6 分钟约 1852 字

1. 前言

对于微服务集群内部而言，服务注册与发现机制已经解决了服务之间的相互调用问题。而对于微服务集群外部呢？比如终端的用户，其到目前为止，要向一个微服务发起请求，仍然需要直接面向该服务的 ip:port 信息，面对千千万万个微服务，这无疑又对用户造成了巨大的困扰。因此，有必要为外部的客户端提供一个统一的访问入口，避免客户端直接与庞大的后台微服务进行接触，从而让客户端的访问更简单。

概括而言，网关发挥了如下作用：

对接客户端请求，将其路由到对应微服务，并实现负载均衡
对用户请求做身份认证、权限校验
对用户请求做限流

在 Spring Cloud Gateway 的网关实现基于 Spring5 中提供的 WebFlux，属性于响应式编程，具备更好的性能。

快速入门

搭建网关服务的步骤：

创建新的 module，引入SpringCloudGateway的依赖和nacos的服务发现依赖：

<!--网关依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos 服务发现依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

配置 application.yml，包括服务基本信息、nacos地址、路由：

其中路由配置包括：
路由 id：路由的唯一标识
路由目标（uri）：路由的目标地址，http 代码固定地址，lb 代表根据服务名负载均衡
路由断言（predicates）：判断路由的规则
路由过滤器（filters）；对请求或响应做处理

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由 id，自定义，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http 就是固定地址
          uri: lb://userservice  # 路由的目标地址 lb 就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个就是按照路径匹配，只要以/user/开头就符合要求
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
        - id: after_route # 这个例子从 Spring Cloud Gateway 官方文档中挪过来的
          uri: https://example.org
          predicates:
            - Cookie=mycookie,mycookievalue

对于一个包含了spring-cloud-starter-gateway依赖的项目，如果不想启用网关功能，可以设置spring.cloud.gateway.enabled=false。

2. Gateway 执行原理

The following diagram provides a high-level overview of how Spring Cloud Gateway works:

Clients make requests to Spring Cloud Gateway.
If the Gateway Handler Mapping determines that a request matches a route, it is sent to the Gateway Web Handler.
This handler runs the request through a filter chain that is specific to the request.
The reason the filters are divided by the dotted line is that filters can run logic both before and after the proxy request is sent. All “pre” filter logic is executed. Then the proxy request is made. After the proxy request is made, the “post” filter logic is run.

Spring Cloud Gateway 的术语：

Route: The basic building block of the gateway. It is defined by an ID, a destination URI, a collection of predicates, and a collection of filters. A route is matched if the aggregate predicate is true.
Predicate: This is a Java 8 Function Predicate. The input type is a Spring Framework ServerWebExchange. This lets you match on anything from the HTTP request, such as headers or parameters.
Filter: These are instances of GatewayFilter that have been constructed with a specific factory. Here, you can modify requests and responses before or after sending the downstream request.

3. 路由断言

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

例如，Path=/user/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的，像这样的路由断言工厂在 Spring Cloud Gateway 中内置了十几个，可以从官方文档中一窥其貌：

4. 路由过滤器

Route filters allow the modification of the incoming HTTP request or outgoing HTTP response in some manner. Route filters are scoped to a particular route. Spring Cloud Gateway includes many built-in GatewayFilter Factories.

4.1 `GatewayFilter`

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

类似于路由断言工厂，Spring 提供了 30 多种不同的路由过滤器工厂 GatewayFilter Factory，例如：

名称	说明
`AddRequestHeader`	给当前请求添加一个请求头
`RemoveRequestHeader`	移除请求中的一个请求头
`AddResponseHeader`	给响应结果中添加一个响应头
`RemoveResponseHeader`	从响应结果中移除一个响应头
`RequestRateLimiter`	限制请求的流量
...	......
`DefaultFilters`	默认过滤器（对所有请求生效）

案例

假设我们需要给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!，其实现方式是，在gateway中修改application.yml文件，给userservice的路由添加过滤器：

默认过滤器

如果要对所有的路由都生效，可以将过滤器工厂写到 default-filters下，这个属性接收一个过滤器数组。如：

4.2 `GlobalFilter`

When a request matches a route, the filtering web handler adds all instances of GlobalFilter and all route-specific instances of GatewayFilter to a filter chain. This combined filter chain is sorted by the org.springframework.core.Ordered interface, which you can set by implementing the getOrder() method.

全局过滤器（GlobalFilter）的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。区别在于，GatewayFilter通过配置定义，处理逻辑是固定的，而GlobalFilter的逻辑可以自定义，需要自己写代码实现，定义方式是实现GlobalFilter接口：