标签路由

本文介绍如何使用标签路由插件 (opens new window)。

功能介绍

标签路由插件通过对服务提供者以服务粒度或者全局粒度配置路由规则，通过将某一个或多个服务的提供者划分到同一个分组，约束流量只在指定分组中流转，从而实现流量隔离的目的，可以作为流量染色、蓝绿发布、灰度发布、全链路灰度、同可用区优先调用等场景的能力基础。

标签路由插件通过非侵入的方式实现微服务之间路由规则的配置以及管理。在微服务存在多个版本、多个实例的情况下，标签路由插件可以通过配置路由规则管理服务之间的路由，达到无损升级、应用拨测等业务目的。

参数配置

Sermant-agent配置

标签路由插件需要在Sermant-agent中配置服务元数据（版本号、其它元数据），参考Sermant-agent使用手册。微服务实例的标签信息在服务注册时会携带，路由筛选过程需利用下列配置的标签。

• service.meta.version: 版本号，用来标识当前微服务实例的版本。

• service.meta.parameters: 其它元数据，用来给当前微服务实例打标签，形如k1:v1,k2:v2。

• service.meta.zone: 可用区，用来标识当前微服务实例的可用区信息。

详细路由规则

标签路由插件基于动态配置中心进行配置发布，配置发布可以参考动态配置中心使用手册。

• group

  其中group值为app=${service.meta.application}&environment=${service.meta.environment}，即应用配置。service.meta.application、service.meta.environment的配置请参考Sermant-agent使用手册。

• key

  针对服务粒度的规则，key值为servicecomb.routeRule.${yourServiceName}，${yourServiceName}为目标应用的微服务名称（即spring.application.name/dubbo.application.name配置的值）。

  针对全局粒度的规则，key值为servicecomb.globalRouteRule。

  注意，全局粒度的规则优先级小于服务粒度的规则。

• content

  content值为具体的路由规则。

标签路由规则示例及说明

标签路由的规则支持三种类型：基于流量匹配的路由规则、基于标签匹配的路由规则以及流量染色规则。三种类型规则可同时配置生效，也可分别单独配置。

注意：标签路由规则的格式为yaml

• 基于流量匹配的路由规则

  基于流量匹配的路由规则即通过匹配http/Dubbo的请求头/attachment中的字段来确认路由规则是否需要应用至该请求中。该规则常用于灰度发布等场景。

  其规则示例如下：

  ---
  - kind: routematcher.sermant.io/flow # kind类型为基于流量匹配的路由规则
    description: test                  # description用于描述规则
    rules: 
      - precedence: 2                    # 优先级，数字越大，优先级越高，匹配成功后不再匹配低优先级规则
        match:                           # 请求匹配规则。0..N个，不配置表示匹配。每条匹配规则只允许存在一个attachments/headers。
          attachments:                   # dubbo attachment匹配。如果是http header匹配，需要配置为headers。
            id:                          # 属性名，使用时修改为具体的key，如果配置了多个key，那么所有的key规则都必须和请求匹配。
              exact: '1'                 # 配置策略，key的属性值等于1，详细配置策略参考配置策略表
              caseInsensitive: false     # false:不区分大小写（默认）,true:区分大小写。配置为false时，将统一转为大写进行比较
        route:                           # 路由规则
          - weight: 20                   # 权重值为20%
            tags:
              version: 1.0.0             # 满足match条件的实例路由到version标签为1.0.0的实例
          - weight: 80                   # 权重值为80%
            tags:
              version: 1.0.1             # 满足match条件的实例路由到version标签为1.0.1的实例
      - precedence: 1                    # 优先级，数字越大，优先级越高。
        route:
          - weight: 20                   # 权重值为20%
            tags:
              group: red                 # 满足match条件的实例路由到group标签为red的实例
          - weight: 80                   # 权重值为80%
            tags:
              group: green               # 满足match条件的实例路由到group标签为green的实例
  

  上述路由规则解释： attachments信息中id属性值为1的请求20%会路由到版本号为1.0.0的服务实例，80%会路由到版本号为1.0.1的服务实例。其他请求20%会路由到group标签为red的服务实例，80%会路由到group标签为green的服务实例。

  注意： 新增配置时，请去掉注释，否则会导致新增失败。

  参数键	说明	默认值	是否必须
  precedence	优先级，数字越大，优先级越高	空	是
  match	匹配规则，支持attachments（dubbo应用的attachents参数）/headers（http 请求头）	空	否
  exact	配置策略， 详细配置策略参考配置策略表	空	否
  route	路由规则，包括权重配置以及标签信息配置	空	是
  weight	权重值	空	是
  tags	表示下游的标签信息，满足match条件的实例路由到该标签的下游实例	空	是

• 基于标签匹配的路由规则

  基于标签匹配的路由规则即通过匹配消费端实例自身的标签来确认路由规则是否需要应用至该请求中。该规则常用于同标签优先路由等场景。

  ---
  - kind: routematcher.sermant.io/tag      # kind类型为基于的标签匹配的路由规则
    description: test                      # description用于描述规则
    rules:
      - precedence: 1                      # 规则的优先级，数字越大，优先级越高，匹配成功后不再匹配低优先级规则
        match:                             
          tags:                            # tags固定键，表示需匹配消费端实例自身的标签
            zone:                          # 表示需要匹配的消费端的标签名为zone，该键按照实际标签名进行配置
              exact: 'hangzhou'            # 配置策略，zone的属性值等于hangzhou，详细配置策略参考配置策略表
              caseInsensitive: false       # false:不区分大小写（默认）,true:区分大小写。配置为false时，将统一转为大写进行比较
        route:
          - tags:
              zone: CONSUMER_TAG           # 该行key表示被调用服务实例的标签名为zone，CONSUMER_TAG为保留字段，表示路由到zone的值相同的服务实例，即被调用服务实例的zone标签需等于'hangzhou'。该配置方式常用于同AZ优先路由等场景
      - precedence: 2                      # 规则的优先级，数字越大，优先级越高,匹配成功后不在匹配低优先级规则
        match:
          tags:                            # tags为固定键，表示需匹配消费端实例自身的标签
            version:                       # 表示需要匹配的消费端的标签名为version，该键按照实际标签名进行配置
              exact: '1.0.0'               # 配置策略，version的属性值等于1.0.0，详细配置策略参考配置策略表
              caseInsensitive: false
        route:
          - weight: 20                     # 权重值为20%
            tags:
              group: red                   # 满足match条件的实例路由到group标签为red的实例
          - weight: 80                     # 权重值为80%
            tags:
              group: green                 # 满足match条件的实例路由到group标签为green的实例
  

  上述路由规则解释： zone标签配置为hangzhou的消费端实例在调用下游服务时，优先调用zone标签也为hangzhou的下游实例。version标签配置为1.0.0的消费端实例在调用下游服务时，请求的20%会路由到group标签为red的服务实例，80%会路由到group标签为green的服务实例。

  注意： 新增配置时，请去掉注释，否则会导致新增失败。

  参数键	说明	默认值	是否必须
  precedence	优先级，数字越大，优先级越高	空	是
  match	匹配规则，只支持tags	空	否
  tags(match中)	match中的tags表示需匹配消费端实例自身的标签	空	是
  exact	配置策略， 详细配置策略参考配置策略表	空	否
  route	路由规则，包括权重配置以及标签信息配置	空	是
  weight	权重值，若使用CONSUMER_TAG保留字段可不配置，默认为100%，用于同标签优先的场景。其他场景需配置	空	是
  tags(route中)	route中的tags表示下游的标签信息，满足match条件的实例路由到该标签的下游实例	空	是

上述基于流量和基于标签匹配的路由规则同时配置时，将先筛选满足基于流量的路由规则的实例，然后再筛选满足基于标签匹配的路由规则的实例，也即取二者交集。

• 同标签匹配优先的路由规则 同标签优先路由，是指在应用调用服务时，优先调用同标签的服务provider。同标签匹配优先的路由规则是基于标签匹配的路由规则的一个特例。

其规则示例如下：

  ---
  - kind: routematcher.sermant.io/tag      # kind类型为基于的标签匹配的路由规则
    description: sameTag                   # description用于描述规则
    rules:
      - precedence: 1                      # 规则的优先级，数字越大，优先级越高，匹配成功后不再匹配低优先级规则
        match:                             
          tags:                            # tags固定键，表示需匹配消费端实例自身的标签
            zone:                          # 表示需要匹配的消费端的标签名为zone，该键按照实际标签名进行配置
              exact: 'hangzhou'            # 配置策略，zone的属性值等于hangzhou，详细配置策略参考配置策略表
              caseInsensitive: false       # false:不区分大小写（默认）,true:区分大小写。配置为false时，将统一转为大写进行比较
          policy:
            triggerThreshold: 20           # 比例阈值（表示20%），同标签provider可用服务实例数占总可用provider数，大于等于该数字则同标签优先
            minAllInstances: 3             # 全部实例最小可用阈值，全部实例最小可用阈值大于全部provider可用实例数，则同标签优先 
        route:
          - tags:
              zone: CONSUMER_TAG           # 该行key表示被调用服务实例的标签名为zone，CONSUMER_TAG为保留字段，表示路由到zone的值相同的服务实例，即被调用服务实例的zone标签需等于'hangzhou'。该配置方式用于同AZ优先路由等场景

上述路由规则解释： zone标签配置为hangzhou的消费端实例在调用下游服务时，根据下发的策略，匹配调用下游实例。

1. 若下游无zone标签为hangzhou的实例，则consumer则会在下游的所有实例根据负载均衡策略调用。
2. 若下游总实例数为2时（其中只有一个实例带有zone的标签为hangzhou）， 则优先调用zone标签为hangzhou的下游实例（因为全部实例最小可用阈值大于全部provider可用实例数）。
3. 若下游总实例数为4时（其中只有一个实例带有zone的标签为hangzhou）， 则优先调用zone标签为hangzhou的下游实例（因为同标签provider可用服务实例数占总可用provider数大于比例阈值）。
4. 若下游总实例数为6时（其中只有一个实例带有zone的标签为hangzhou）， 则consumer则会在下游的所有实例根据负载均衡策略调用（因为同标签provider可用服务实例数占总可用provider数小于比例阈值）。

注意： 新增配置时，请去掉注释，否则会导致新增失败。

参数键	说明	默认值	是否必须
precedence	优先级，数字越大，优先级越高	空	是
match	匹配规则，只支持tags	空	否
tags(match中)	match中的tags表示需匹配消费端实例自身的标签	空	是
exact	配置策略， 详细配置策略参考配置策略表	空	否
triggerThreshold（policy中）	比例阈值，若同标签provider可用服务实例数占总可用provider数大于等于比例阈值，则同标签优先	空	否
minAllInstances（policy中）	全部实例最小可用阈值，全部实例最小可用阈值大于全部provider可用实例数，则同标签优先	空	否
route	路由规则，包括权重配置以及标签信息配置	空	是
tags(route中)	route中的tags表示下游的标签信息，满足match条件的实例路由到该标签的下游实例	空	是

• 流量染色规则

  流量染色规则，可以将符合一定规则的请求流量进行染色标记，并且将标记跟随着链路一直传递下去。结合流量路由与流量染色能力，可以实现全链路灰度、多环境隔离等场景。

---
- kind: route.sermant.io/lane # 路由规则为染色规则的类型
  description: lane  # 规则描述
  rules:
    - precedence: 2 # 规则的优先级，数字越大，优先级越高，匹配成功后不再匹配低优先级规则
      match: # 请求匹配规则。0..N个，不配置表示匹配
        method: getFoo # dubbo接口方法名，不配置表示匹配
        path: "io.sermant.bar" # dubbo接口名，不配置表示匹配
        protocol: dubbo # 流量入口为dubbo协议，dubbo协议只会匹配attachments/args
        attachments: # dubbo attachments匹配，不配置表示匹配
          id: # 属性名，使用时修改为具体的属性，如果配置了多个属性，那么所有的属性规则都必须和请求匹配
            exact: '1' # 配置策略，id等于1，详细配置策略参考配置策略表
            caseInsensitive: false # false:不区分大小写（默认）,true:区分大小写。配置为false时，将统一转为小写进行比较
        args: # dubbo args匹配，不配置表示匹配
          args0: # dubbo接口的第0个参数
            type: .name # 取值类型，dubbo args匹配特有字段，第0个参数为实体，调用getName()方法，详细取值类型参考取值类型表
            exact: 'foo' # 配置策略，等于foo，详细配置策略参考配置策略表
      route:
        - tag-inject: # 染色标记
            x-sermant-flag2: gray2 # 发起对下游调用时，将该标记传递到http headers/dubbo attachments中
          weight: 100 # 染色权重
    - precedence: 1
      match:
        method: get # http请求方式，不配置表示匹配
        path: "/foo" # http请求路径，不配置表示匹配
        protocol: http # 流量入口为http协议，http协议只会匹配headers/parameters
        headers: # http headers匹配，不配置表示匹配
          id:
            exact: '1'
        parameters: # http url parameters匹配，不配置表示匹配
          name:
            exact: 'foo'
      route:
        - tag-inject:
            x-sermant-flag1: gray1
          weight: 60

注意： 新增配置时，请去掉注释，否则会导致新增失败。

上述染色规则解释： 首先匹配流量入口为dubbo协议的请求，如果请求接口为com.huaweicloud.bar，请求方法为getFoo，attachments中id等于1，对方法中的第0个参数调用getName()方法的返回值等于foo，就对满足条件的100%流量打上【x-sermant-flag2: gray2】的标记，并在调用下游时进行传递，如果不匹配，则匹配流量入口为http协议的请求，如果请求接口为/foo，请求方式为get，headers中id等于1，url parameters中name等于foo，就对满足条件的60%流量打上【x-sermant-flag1: gray1】的标记，并在调用下游时进行传递。

参数键	说明	默认值	是否必须
precedence	优先级，数字越大，优先级越高	空	是
match	匹配规则，支持attachments/args/headers/parameters	空	否
method	dubbo接口方法名/http请求方式	空	否
path	dubbo接口名/http请求路径	空	否
protocol	流量入口协议，dubbo/http	空	match存在时必填
exact	配置策略，详细配置策略参考配置策略表	空	否
type	取值类型，详细取值类型参考取值类型表	空	否
route	染色规则，包括权重配置以及染色标记配置	空	是
weight	权重值	空	是
tag-inject	染色标记	空	是

配置策略列表

策略名	策略值	匹配规则
精确匹配	exact	参数值等于配置值
正则	regex	参数值匹配正则表达式，由于部分正则表达式（如\w与\W等）区分大小写，所以使用正则策略时，请谨慎选择caseInsensitive（是否区分大小写）
不等于	noEqu	参数值不等于配置值
大于等于	noLess	参数值大于等于配置值
小于等于	noGreater	参数值小于等于配置值
大于	greater	参数值大于配置值
小于	less	参数值小于配置值
包含	in	参数值在列表中

取值类型表

类型	取值方式	适用参数类型
留空	表示直接取当前参数的值	适用普通参数类型，例如String、int、long等
.name	表示取参数的name属性，相当于ARG0.getName()	适用于对象类型
.isEnabled()	表示取参数的enabled属性，相当于ARG0.isEnabled()	适用于对象类型
[0]	取数组的第一个值，相当于ARG0[0]	适用于普通类型的数组，例如String[]、int[]
.get(0)	取List的第一个值，相当于ARG0.get(0)	适用于普通类型的列表，例如List<String>、List<Integer>
.get("key")	获取key对应的值，相当于ARG0.get("key")	适用于普通类型的map，例如Map<String, String>

支持版本和限制

框架支持：

• SpringCloud Edgware.SR2 - 2021.0.0

• Dubbo 2.6.x-2.7.x，3.0.x-3.2.x

限制：

• 不支持异步调用

• http客户端目前只支持Feign、RestTemplate

操作和结果验证

下面将演示如何使用标签路由插件，验证使用Sermant动态配置中心（ZooKeeper）为SpringCloud服务配置标签路由场景。

准备工作

• 下载 (opens new window) Sermant Release包（当前版本推荐1.4.0版本）
• 下载 (opens new window) Demo二进制产物压缩包
• 下载 (opens new window)ServiceComb（注册中心），并启动
• 下载 (opens new window)ZooKeeper（动态配置中心），并启动

步骤一：获取Demo二进制产物

解压Demo二进制产物压缩包，即可得到spring-cloud-router-consumer.jar、spring-cloud-router-provider.jar和spring-cloud-router-zuul.jar。

步骤二：部署应用

（1）启动zuul网关

# windows
java -Dservicecomb_service_enableSpringRegister=true -javaagent:${path}\sermant-agent-x.x.x\agent\sermant-agent.jar=appName=default -jar spring-cloud-router-zuul.jar

# mac, linux
java -Dservicecomb_service_enableSpringRegister=true -javaagent:${path}/sermant-agent-x.x.x/agent/sermant-agent.jar=appName=default -jar spring-cloud-router-zuul.jar

（2）启动消费者

# windows
java -Dservicecomb_service_enableSpringRegister=true -javaagent:${path}\sermant-agent-x.x.x\agent\sermant-agent.jar=appName=default -jar spring-cloud-router-consumer.jar

# mac, linux
java -Dservicecomb_service_enableSpringRegister=true -javaagent:${path}/sermant-agent-x.x.x/agent/sermant-agent.jar=appName=default -jar spring-cloud-router-consumer.jar

（3）启动生产者

# windows
java -Dservicecomb_service_enableSpringRegister=true -javaagent:${path}\sermant-agent-x.x.x\agent\sermant-agent.jar=appName=default -jar spring-cloud-router-provider.jar

# mac, linux
java -Dservicecomb_service_enableSpringRegister=true -javaagent:${path}/sermant-agent-x.x.x/agent/sermant-agent.jar=appName=default -jar spring-cloud-router-provider.jar

（4）启动标签生产者（版本为1.0.1，标签为group:gray）

# windows
java -Dservicecomb_service_enableSpringRegister=true -Dservice_meta_version=1.0.1 -Dservice_meta_parameters=group:gray -Dserver.port=8163 -javaagent:${path}\sermant-agent-x.x.x\agent\sermant-agent.jar=appName=default -jar spring-cloud-router-provider.jar

# mac, linux
java -Dservicecomb_service_enableSpringRegister=true -Dservice_meta_version=1.0.1 -Dservice_meta_parameters=group:gray -Dserver.port=8163 -javaagent:${path}/sermant-agent-x.x.x/agent/sermant-agent.jar=appName=default -jar spring-cloud-router-provider.jar

说明： ${path}为sermant实际安装路径，x.x.x代表sermant某个版本号。

步骤三：查看服务注册情况

登录ServiceComb (opens new window)后台，查看服务是否注册成功。

步骤四：发布配置

配置路由规则，参考动态配置中心使用手册进行配置发布。

其中key值为servicecomb.routeRule.spring-cloud-router-provider，group为app=default&environment=，content为具体的路由规则，如下所示：

---
- kind: routematcher.sermant.io/flow
  description: test                  
  rules: 
    - precedence: 1
      match:
        headers:
          id:
            exact: '1'
            caseInsensitive: false
      route:
        - tags:
            group: gray
          weight: 100
    - precedence: 2
      match:
        headers:
          id:
            exact: '2'
            caseInsensitive: false
      route:
        - tags:
            version: 1.0.1
          weight: 100

上述标签路由规则解释： 请求头信息中id属性值为1的请求会路由到组名为gray的服务实例，id属性值为2的请求会路由到版本号为1.0.1的服务实例。

利用ZooKeeper提供的命令行工具进行配置发布。

1、在${path}/bin/目录执行以下命令创建节点/app=default&environment=

# linux mac
./zkCli.sh -server localhost:2181 create /app=default&environment=

# windows
zkCli.cmd -server localhost:2181 create /app=default&environment=

2、在${path}/bin/目录执行以下命令创建节点/app=default&environment=/servicecomb.routeRule.spring-cloud-router-provider并设置数据。

# linux mac
./zkCli.sh -server localhost:2181 create /app=default&environment=/servicecomb.routeRule.spring-cloud-router-provider "---
- kind: routematcher.sermant.io/flow
  description: test                  
  rules: 
    - precedence: 1
      match:
        headers:
          id:
            exact: '1'
            caseInsensitive: false
      route:
        - tags:
            group: gray
          weight: 100
    - precedence: 2
      match:
        headers:
          id:
            exact: '2'
            caseInsensitive: false
      route:
        - tags:
            version: 1.0.1
          weight: 100"

# windows
zkCli.cmd -server localhost:2181 create /app=default&environment=/servicecomb.routeRule.spring-cloud-router-provider "---
- kind: routematcher.sermant.io/flow
  description: test                  
  rules: 
    - precedence: 1
      match:
        headers:
          id:
            exact: '1'
            caseInsensitive: false
      route:
        - tags:
            group: gray
          weight: 100
    - precedence: 2
      match:
        headers:
          id:
            exact: '2'
            caseInsensitive: false
      route:
        - tags:
            version: 1.0.1
          weight: 100"

说明：${path}为ZooKeeper的安装目录。

验证

当启动以上4个应用并正确配置路由规则后，通过http客户端工具访问http://127.0.0.1:8170/consumer/hello/rest，可以发现，当请求头为id: 1或者id: 2时，会路由到版本为1.0.1的provider，当不满足以上条件时，会访问到版本为1.0.0的provider。