SA实战 ·《SpringCloud Alibaba实战》第14章（一）

 

大家好，我是冰河~~
在《SpringCloud Alibaba实战》专栏前面的文章中，我们实现了用户微服务、商品微服务和订单微服务之间的远程调用，并且实现了服务调用的负载均衡。也基于阿里开源的Sentinel实现了服务的限流与容错，并详细介绍了Sentinel的核心技术与配置规则。

同时，简单介绍了服务网关，并对SpringCloud Gateway的核心架构进行了简要说明，也在项目中整合了SpringCloud Gateway网关实现了通过网关访问后端微服务，另外，也能够SpringCloud Gateway整合Sentinel实现了网关的限流功能。今天，我们再进一步介绍下SpringCloud Gateway网关的核心技术。

本章总览
 

 

本章概述
SpringCloud Gateway能够实现多种网关功能，比如路由转发、断言、过滤器、熔断、限流、降级、自定义谓词配置、自定义过滤器等等多种功能。今天，我们就一起来聊聊SpringCloud Gateway中的断言、过滤器与熔断机制。

网关断言
断言的英文是Predicate，也可以翻译成谓词。主要的作用就是进行条件判断，可以在网关中实现多种条件判断，只有所有的判断结果都通过时，也就是所有的条件判断都返回true，才会真正的执行路由功能。

SpringCloud Gateway内置断言
SpringCloud Gateway包括许多内置的断言工厂，所有这些断言都与HTTP请求的不同属性匹配。

基于日期时间类型的断言
基于日期时间类型的断言根据时间做判断，主要有三个：

• AfterRoutePredicateFactory：接收一个日期时间参数，判断当前请求的日期时间是否晚于指定的日期时间。
• BeforeRoutePredicateFactory：接收一个日期时间参数，判断当前请求的日期时间是否早于指定的日期时间。
• BetweenRoutePredicateFactory：接收两个日期时间参数，判断当前请求的日期时间是否在指定的时间时间段内。
  使用示例
  

  - After=2022-05-10T23:59:59.256+08:00[Asia/Shanghai]​

基于远程地址的断言
RemoteAddrRoutePredicateFactory：接收一个IP地址段，判断发出请求的客户端的IP地址是否在指定的IP地址段内。

使用示例

- RemoteAddr=192.168.0.1/24

基于Cookie的断言
CookieRoutePredicateFactory：接收两个参数， Cookie的名称和一个正则表达式。判断请求的Cookie是否具有给定名称且值与正则表达式匹配。

使用示例

- Cookie=name, binghe.

基于Header的断言
HeaderRoutePredicateFactory：接收两个参数，请求Header的名称和正则表达式。判断请求Header中是否具有给定的名称且值与正则表达式匹配。

使用示例

- Header=X-Request-Id, \d+

基于Host的断言
HostRoutePredicateFactory：接收一个参数，这个参数通常是主机名或者域名的模式，例如**.binghe.com这种格式。判断发出请求的主机是否满足匹配规则。

使用示例

- Host=**.binghe.com

基于Method请求方法的断言
MethodRoutePredicateFactory：接收一个参数，判断请求的类型是否跟指定的类型匹配，通常指的是请求方式。例如，POST、GET、PUT等请求方式。

使用示例

- Method=GET

基于Path请求路径的断言
PathRoutePredicateFactory：接收一个参数，判断请求的链接地址是否满足路径规则，通常指的是请求的URI部分。

使用示例

- Path=/binghe/{segment}

基于Query请求参数的断言
QueryRoutePredicateFactory ：接收两个参数，请求参数和正则表达式， 判断请求的参数是否具有给定的名称并且参数值是否与正则表达式匹配。

使用示例

- Query=name, binghe.

基于路由权重的断言
WeightRoutePredicateFactory：接收一个[组名,权重]格式的数组，然后对于同一个组内的路由按照权重转发。

使用示例

- id: weight1
  uri: http://localhost:8080
  predicates:
    - Path=/api/**
    - Weight=group1,2
  filters:
    - StripPrefix=1
- id: weight2
  uri: http://localhost:8081
  predicates:
    - Path=/api/**
    - Weight=group1,8
  filters:
    - StripPrefix=1

 

演示内置断言
在演示的示例中，我们基于Path请求路径的断言判断请求路径是否符合规则，基于远程地址的断言判断请求主机地址是否在地址段中，并且限制请求的方式为GET方式。整个演示的过程以访问用户微服务的接口为例。

（1）由于在开发项目时，所有的服务都是在我本地启动的，首先查看下我本机的IP地址，如下所示。

 

可以看到，我本机的IP地址为192.168.0.27，属于192.168.0.1/24网段。

（2）在服务网关模块shop-gateway中，将application.yml文件备份成application-sentinel.yml文件，并将application.yml文件中的内容修改成application-simple.yml文件中的内容。接下来，在application.yml文件中的spring.cloud.gateway.routes节点下的- id: user-gateway下面进行断言配置，配置后的结果如下所示。

spring:
  cloud:
    gateway:
      routes:
        - id: user-gateway
          uri: http://localhost:8060
          order: 1
          predicates:
            - Path=/server-user/**
            - RemoteAddr=192.168.0.1/24
            - Method=GET
          filters:
            - StripPrefix=1

 

注意：完整的配置参见案例完整源代码。

（3）配置完成后启动用户微服务和网关服务，通过网关服务访问用户微服务，在浏览器中输入http://localhost:10001/server-user/user/get/1001，如下所示。

 

可以看到通过http://localhost:10001/server-user/user/get/1001链接不能正确访问到用户信息。

接下来，在浏览器中输入http://192.168.0.27:10001/server-user/user/get/1001，能够正确获取到用户的信息。

 

（4）停止网关微服务，将基于远程地址的断言配置成- RemoteAddr=192.168.1.1/24，也就是将基于远程地址的断言配置成与我本机IP地址不在同一个网段，这样就能演示请求主机地址不在地址段中的情况，修改后的基于远程地址的断言配置如下所示。

- RemoteAddr=192.168.1.1/24

（5）重启网关服务，再次在浏览器中输入http://localhost:10001/server-user/user/get/1001，如下所示。

 

可以看到通过http://localhost:10001/server-user/user/get/1001链接不能正确访问到用户信息。

接下来，在浏览器中输入http://192.168.0.27:10001/server-user/user/get/1001，也不能正确获取到用户的信息了。

 

自定义断言
SpringCloud Gateway支持自定义断言功能，我们可以在具体业务中，基于SpringCloud Gateway自定义特定的断言功能。

自定义断言概述
SpringCloud Gateway虽然提供了多种内置的断言功能，但是在某些场景下无法满足业务的需要，此时，我们就可以基于SpringCloud Gateway自定义断言功能，以此来满足我们的业务场景。

实现自定义断言
这里，我们基于SpringCloud Gateway实现断言功能，实现后的效果是在服务网关的application.yml文件中的spring.cloud.gateway.routes节点下的- id: user-gateway下面进行如下配置。

spring:
  cloud:
    gateway:
      routes:
        - id: user-gateway
          uri: http://localhost:8060
          order: 1
          predicates:
            - Path=/server-user/**
            - Name=binghe
          filters:
            - StripPrefix=1

 

通过服务网关访问用户微服务时，只有在访问的链接后面添加?name=binghe参数时才能正确访问用户微服务。

（1）在网关服务shop-gateway中新建io.binghe.shop.predicate包，在包下新建NameRoutePredicateConfig类，主要定义一个Spring类型的name成员变量，用来接收配置文件中的参数，源码如下所示。

/**
 * @author binghe
 * @version 1.0.0
 * @description 接收配置文件中的参数
 */
@Data
public class NameRoutePredicateConfig implements Serializable {
    private static final long serialVersionUID = -3289515863427972825L;
    private String name;
}

 

（2）实现自定义断言时，需要新建类继承org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory类，在io.binghe.shop.predicate包下新建NameRoutePredicateFactory类，继承org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory类，并覆写相关的方法，源码如下所示。

/**
 * @author binghe
 * @version 1.0.0
 * @description 自定义断言功能
 */
@Component
public class NameRoutePredicateFactory extends AbstractRoutePredicateFactory<NameRoutePredicateConfig> {

    public NameRoutePredicateFactory() {
        super(NameRoutePredicateConfig.class);
    }

    @Override
    public Predicate<ServerWebExchange> apply(NameRoutePredicateConfig config) {
        return (serverWebExchange)->{
            String name = serverWebExchange.getRequest().getQueryParams().getFirst("name");
            if (StringUtils.isEmpty(name)){
                name = "";
            }
            return name.equals(config.getName());
        };
    }

    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("name");
    }
}

 

（3）在服务网关的application.yml文件中的spring.cloud.gateway.routes节点下的- id: user-gateway下面进行如下配置。

spring:
  cloud:
    gateway:
      routes:
        - id: user-gateway
          uri: http://localhost:8060
          order: 1
          predicates:
            - Path=/server-user/**
            - Name=binghe
          filters:
            - StripPrefix=1

（4）分别启动用户微服务与网关服务，在浏览器中输入http://localhost:10001/server-user/user/get/1001，如下所示。

 

可以看到，在浏览器中输入http://localhost:10001/server-user/user/get/1001，无法获取到用户信息。

（5）在浏览器中输入http://localhost:10001/server-user/user/get/1001?name=binghe，如下所示。

 

可以看到，在访问链接后添加?name=binghe参数后，能够正确获取到用户信息。

至此，我们实现了自定义断言功能。

 

文章转自公众号：冰河技术