有一類請(qǐng)求標(biāo)簽數(shù)據(jù)需要在業(yè)務(wù)響應(yīng)鏈路上一直傳遞，例如全鏈路追蹤里的 TraceId 、測(cè)試環(huán)境路由的 FeatureEnv 標(biāo)簽等。

服務(wù)路由和負(fù)載均衡的區(qū)別

服務(wù)路由和負(fù)載均衡都是解決選擇服務(wù)實(shí)例的問(wèn)題。區(qū)別在于服務(wù)路由是從全量的服務(wù)實(shí)例中挑選出一批滿足路由規(guī)則的服務(wù)實(shí)例，而負(fù)載均衡則是從路由匹配之后的服務(wù)實(shí)例列表中挑選出一個(gè)適合處理請(qǐng)求的實(shí)例。

二、測(cè)試環(huán)境路由實(shí)現(xiàn)原理

2.1 方案總覽

測(cè)試環(huán)境路由的樣例實(shí)現(xiàn)以下圖為例，一共有兩個(gè)測(cè)試環(huán)境以及一個(gè)基線環(huán)境。流量從端到端會(huì)依次經(jīng)過(guò)以下組件：App -> 網(wǎng)關(guān) -> 用戶中心 -> 積分中心 -> 活動(dòng)中心。

圖：測(cè)試環(huán)境路由示意圖

根據(jù)上一節(jié)服務(wù)路由章節(jié)所述，為了達(dá)到測(cè)試環(huán)境路由的能力，開(kāi)發(fā)工作需要做三件事情：

服務(wù)實(shí)例染色（標(biāo)識(shí)實(shí)例屬于哪個(gè)測(cè)試環(huán)境）

流量染色（標(biāo)識(shí)請(qǐng)求應(yīng)該被轉(zhuǎn)發(fā)到哪個(gè)測(cè)試環(huán)境）

服務(wù)路由 a. 網(wǎng)關(guān)根據(jù)請(qǐng)求的目標(biāo)測(cè)試環(huán)境標(biāo)簽轉(zhuǎn)發(fā)到對(duì)應(yīng)的目標(biāo)測(cè)試環(huán)境的用戶中心。 b. 服務(wù)調(diào)用時(shí)，優(yōu)先轉(zhuǎn)發(fā)到同測(cè)試環(huán)境下的目標(biāo)服務(wù)實(shí)例，如果同測(cè)試環(huán)境下沒(méi)有服務(wù)實(shí)例則轉(zhuǎn)發(fā)到基線環(huán)境。

以下三小節(jié)，將會(huì)詳細(xì)介紹這三部分的原理。

2.2 服務(wù)實(shí)例染色

在多測(cè)試環(huán)境的場(chǎng)景中，需要對(duì)每個(gè)測(cè)試環(huán)境部署的實(shí)例進(jìn)行區(qū)分，因此需要在實(shí)例上打 的標(biāo)簽。Spring Cloud Tencent 一共支持三種服務(wù)實(shí)例染色方式。

方式一：配置文件

在 Spring Boot 的 application.yml 配置文件里配置以下內(nèi)容即可實(shí)現(xiàn)染色：

spring:
cloud:
tencent:
metadata:
content:
idc:shanghai
env:f1

Spring Cloud Tencent 應(yīng)用在啟動(dòng)時(shí)，讀取配置文件并解析出 idc=shanghai 和 env=f1 標(biāo)簽信息。

如果以上配置文件放在項(xiàng)目源碼里，要實(shí)現(xiàn)不同的實(shí)例具有不同的標(biāo)簽值則需要打不同包?？梢酝ㄟ^(guò)以下兩種方式實(shí)現(xiàn)同一個(gè)運(yùn)行包設(shè)置不同的標(biāo)簽值：

通過(guò) -D 啟動(dòng)參數(shù)覆蓋，例如：-Dspring.cloud.tencent.metadata.content.idc=guangzhou

通過(guò) Spring Boot 標(biāo)準(zhǔn)方式，把a(bǔ)pplication.yml外掛本地磁盤(pán)上

方式二：環(huán)境變量

環(huán)境變量在容器場(chǎng)景下非常方便，Spring Cloud Tencent 約定了前綴為 SCT_METADATA_CONTENT_ 的環(huán)境變量為實(shí)例的標(biāo)簽信息，例如：

SCT_METADATA_CONTENT_IDC=shanghai

SCT_METADATA_CONTENT_ENV=f1

Spring Cloud Tencent 應(yīng)用在啟動(dòng)時(shí)，自動(dòng)會(huì)讀取環(huán)境變量并解析出 IDC=shanghai 和 ENV=f1 標(biāo)簽信息。

方式三：自定義實(shí)現(xiàn) SPI

前面兩種方式為 Spring Cloud Tencent 內(nèi)置的方式，但是不一定符合每個(gè)生產(chǎn)項(xiàng)目的規(guī)范，因此 Spring Cloud Tencent 還提供了一種允許開(kāi)發(fā)者自定義標(biāo)簽 Provider 的方式。例如以下兩種實(shí)踐場(chǎng)景：

把實(shí)例標(biāo)簽放到機(jī)器上的某一個(gè)配置文件里，例如 /etc/metadata。

應(yīng)用啟動(dòng)時(shí)，調(diào)用公司的 CMDB 接口獲取元信息。

這種場(chǎng)景下，只要實(shí)現(xiàn) InstanceMetadataProvider SPI 擴(kuò)展即可。

2.3 流量染色

流量染色即為每個(gè)請(qǐng)求打上目標(biāo)測(cè)試環(huán)境標(biāo)簽，路由轉(zhuǎn)發(fā)時(shí)根據(jù)請(qǐng)求標(biāo)簽匹配目標(biāo)服務(wù)實(shí)例。而流量染色可以分為以下幾種方式：

方式一：靜態(tài)染色

2.2 小節(jié)介紹了可以為服務(wù)實(shí)例設(shè)置一系列的標(biāo)簽信息，例如 idc=shanghai、env=f1 等。在有些場(chǎng)景下，期望所有經(jīng)過(guò)當(dāng)前實(shí)例的請(qǐng)求都帶上當(dāng)前實(shí)例的標(biāo)簽信息。例如經(jīng)過(guò) env=f1 的實(shí)例的請(qǐng)求都攜帶 env=f1 的標(biāo)簽信息。

服務(wù)實(shí)例染色有三種方式，對(duì)應(yīng)的定義哪些標(biāo)簽需要作為請(qǐng)求標(biāo)簽透?jìng)鞯芥溌飞弦灿腥N方式，核心思想就是定義需要全鏈路傳遞的標(biāo)簽鍵值對(duì)的鍵列表。

通過(guò)配置文件的 spring.cloud.tencent.metadata.content.transitive=["idc", "env"] 配置項(xiàng)指定

通過(guò) SCT_METADATA_CONTENT_TRANSITIVE=IDC,ENV 環(huán)境變量指定

通過(guò)實(shí)現(xiàn) InstanceMetadataProvider#getTransitiveMetadataKeys() 方法指定

方式二：動(dòng)態(tài)染色

靜態(tài)染色是把服務(wù)實(shí)例的某些標(biāo)簽作為請(qǐng)求標(biāo)簽，服務(wù)實(shí)例標(biāo)簽相對(duì)靜態(tài)，應(yīng)用啟動(dòng)后初始化一次之后就不再變更。但是在實(shí)際的應(yīng)用場(chǎng)景下，不同的請(qǐng)求往往需要設(shè)置不同的標(biāo)簽信息。此時(shí)則需要通過(guò)動(dòng)態(tài)染色的能力。

為請(qǐng)求動(dòng)態(tài)染色也非常簡(jiǎn)單，只需增加以 X-Polaris-Metadata-Transitive- 為前綴的 HTTP 請(qǐng)求頭即可，例如：X-Polaris-Metadata-Transitive-featureenv=f1。這樣 featureenv=f1 就能夠作為請(qǐng)求標(biāo)簽在鏈路上透?jìng)鳌?/p>

方式三：網(wǎng)關(guān)流量染色

網(wǎng)關(guān)常常作為流量的入口或者中轉(zhuǎn)站。經(jīng)過(guò)網(wǎng)關(guān)的請(qǐng)求，可以根據(jù)某些染色規(guī)則為請(qǐng)求增加標(biāo)簽信息。例如滿足請(qǐng)求參數(shù) uid=1000 請(qǐng)求打上 featureenv=f1 標(biāo)簽。

網(wǎng)關(guān)流量染色是非常實(shí)用的能力，在 Spring Cloud Tencent 里實(shí)現(xiàn)了非常靈活基于染色規(guī)則的 Spring Cloud Gateway 染色插件。例如以下染色規(guī)則可以實(shí)現(xiàn)為 uid=1000 的請(qǐng)求打上 featureenv=f1 標(biāo)簽、uid=1001 的請(qǐng)求打上 featureenv=f2 標(biāo)簽。更詳細(xì)的染色規(guī)則，可以參考文檔。

{
"rules":[
{
"conditions":[
{
"key":"${http.query.uid}",
"values":["1000"],
"operation":"EQUALS"
}
],
"labels":[
{
"key":"featureenv",
"value":"f1"
}
]
},
{
"conditions":[
{
"key":"${http.query.uid}",
"values":["1001"],
"operation":"EQUALS"
}
],
"labels":[
{
"key":"featureenv",
"value":"f2"
}
]
}
]
}

同時(shí) Spring Cloud Tencent 也預(yù)留了 TrafficStainer SPI ，用戶可以實(shí)現(xiàn)自定義流量染色插件。

2.4 Spring Cloud Tencent 路由功能原理

北極星提供了非常完善的服務(wù)治理能力，上層的服務(wù)框架基于北極星原生 SDK 就能快速實(shí)現(xiàn)強(qiáng)大的服務(wù)治理能力。Spring Cloud Tencent 就是在北極星的基礎(chǔ)上實(shí)現(xiàn)了服務(wù)路由能力。

北極星服務(wù)路由原理

北極星服務(wù)路由實(shí)現(xiàn)原理并不復(fù)雜，如下圖所示，從注冊(cè)中心獲取到所有實(shí)例信息，再經(jīng)過(guò)一系列的 RouterFilter 插件過(guò)濾出滿足條件的實(shí)例集合。

圖：北極星服務(wù)路由執(zhí)行鏈

在多測(cè)試環(huán)境場(chǎng)景下主要用到了 MetadataRouter （元數(shù)據(jù)路由）插件，此插件核心能力是根據(jù)請(qǐng)求的標(biāo)簽完全匹配服務(wù)實(shí)例的標(biāo)簽。

例如請(qǐng)求有兩個(gè)標(biāo)簽 key1=value1和 key2=value2，MetadataRouter 則會(huì)篩選出所有實(shí)例中包含同時(shí)滿足 key1=value1 和 key2=value2 的服務(wù)實(shí)例。在多測(cè)試環(huán)境場(chǎng)景下，Spring Cloud Tencent 缺省使用 featureenv 標(biāo)簽，通過(guò) featureenv 標(biāo)簽篩選出屬于同一個(gè)測(cè)試環(huán)境的服務(wù)實(shí)例。

Spring Cloud Tencent 服務(wù)路由原理

Spring Cloud Tencent 實(shí)現(xiàn)路由核心分成兩個(gè)部分：

擴(kuò)展 RestTemplate 、 Feign、SCG 獲取請(qǐng)求的標(biāo)簽信息并塞到 RouterContext （路由信息上下文）里。

擴(kuò)展 Spring Cloud 負(fù)載均衡組件（Hoxton 版本之前為 Ribbon，2020版本之后為 Spring Cloud LoadBalancer），在擴(kuò)展的實(shí)現(xiàn)里調(diào)用北極星的服務(wù)路由 API 實(shí)現(xiàn)服務(wù)實(shí)例過(guò)濾。

擴(kuò)展部分邏輯較為復(fù)雜，感興趣的讀者可以參考 spring-cloud-starter-tencent-polaris-router 模塊源碼。

三、測(cè)試環(huán)境路由用戶操作指引

在上一節(jié)中詳細(xì)介紹了測(cè)試環(huán)境路由的實(shí)現(xiàn)原理，這一節(jié)則詳細(xì)介紹站在用戶的視角需要操作的內(nèi)容。

通過(guò) Spring Cloud Tencent 實(shí)現(xiàn)流量的測(cè)試環(huán)境路由非常簡(jiǎn)單，核心包含三步：

服務(wù)增加測(cè)試環(huán)境路由插件依賴

部署的實(shí)例打上環(huán)境標(biāo)簽

為請(qǐng)求流量打上環(huán)境標(biāo)簽

完成以上三個(gè)步驟即可。

3.1 添加測(cè)試環(huán)境路由插件依賴

Spring Cloud Tencent 中的 spring-cloud-tencent-featureenv-plugin 模塊閉環(huán)了測(cè)試環(huán)境路由全部能力，所有服務(wù)只需要添加該依賴即可引入測(cè)試環(huán)境路由能力。

3.2 服務(wù)實(shí)例打上環(huán)境標(biāo)簽

spring-cloud-tencent-featureenv-plugin 默認(rèn)以 featureenv 標(biāo)簽作為匹配標(biāo)簽，用戶也可以通過(guò)系統(tǒng)內(nèi)置的 system-feature-env-router-label=custom_feature_env_key 標(biāo)簽來(lái)指定測(cè)試環(huán)境路由使用的標(biāo)簽鍵。以下三種方式以默認(rèn)的 featureenv 作為示例。

方式一：配置文件

在服務(wù)實(shí)例的配置文件中添加配置，如在 bootstrap.yml添加如下所示即可：

spring:
cloud:
tencent:
metadata:
content:
featureenv:f1#f1替換為測(cè)試環(huán)境名稱

方式二：環(huán)境變量

在服務(wù)實(shí)例所在的操作系統(tǒng)中添加環(huán)境變量也可進(jìn)行打標(biāo)，例如：SCT_METADATA_CONTENT_featureenv=f1

方式三：SPI 方式

自定義實(shí)現(xiàn) InstanceMetadataProvider#getMetadata() 方法的返回值里里包含 featureenv 即可。

基線環(huán)境標(biāo)簽值

注意，基線環(huán)境部署的服務(wù)實(shí)例不需要設(shè)置 featureenv 標(biāo)簽，表明其不屬于任何測(cè)試環(huán)境，才可在請(qǐng)求沒(méi)有匹配到對(duì)應(yīng)測(cè)試環(huán)境的時(shí)候，匹配到基線環(huán)境。

3.3 流量染色

方式一：客戶端染色 （推薦）

如下圖所示，在客戶端發(fā)出的 HTTP 請(qǐng)求里，新增 X-Polaris-Metadata-Transitive-featureenv=f1 請(qǐng)求頭即可實(shí)現(xiàn)染色。該方式是讓開(kāi)發(fā)者在請(qǐng)求創(chuàng)建的時(shí)候根據(jù)業(yè)務(wù)邏輯進(jìn)行流量染色。

圖：客戶端染色示意圖

方式二：網(wǎng)關(guān)動(dòng)態(tài)染色（推薦）

動(dòng)態(tài)染色是開(kāi)發(fā)者配置一定的染色規(guī)則，讓流量經(jīng)過(guò)網(wǎng)關(guān)時(shí)自動(dòng)染色，使用起來(lái)相當(dāng)方便。例如把 uid=1 用戶的請(qǐng)求都轉(zhuǎn)發(fā)到 f1 環(huán)境，把 uid=0 用戶的請(qǐng)求都轉(zhuǎn)發(fā)到 f2 環(huán)境。只需要配置一條染色規(guī)則即可實(shí)現(xiàn)。

圖：網(wǎng)關(guān)動(dòng)態(tài)染色示意圖

Spring Cloud Tencent 通過(guò)實(shí)現(xiàn) Spring Cloud Gateway 的 GlobalFilter 來(lái)實(shí)現(xiàn)流量染色插件，開(kāi)發(fā)者只需要添加 spring-cloud-tencent-gateway-plugin 依賴，并在配置文件中打開(kāi)染色插件開(kāi)關(guān)（spring.cloud.tencent.plugin.scg.staining.enabled=true）即可引入流量染色能力。

方式三：網(wǎng)關(guān)靜態(tài)染色

往請(qǐng)求中加入固定的 Header 是網(wǎng)關(guān)最常見(jiàn)的插件，如下圖所示。可以在每個(gè)環(huán)境部署一個(gè)網(wǎng)關(guān)，所有經(jīng)過(guò)網(wǎng)關(guān)的請(qǐng)求都增加 X-Polaris-Metadata-Transitive-featureenv=f1 請(qǐng)求頭即可。此種方式需要每個(gè)環(huán)境部署網(wǎng)關(guān)，成本高，所以使用頻率相對(duì)較低。

圖：網(wǎng)關(guān)靜態(tài)染色示意圖

完成以上操作步驟即可實(shí)現(xiàn)測(cè)試環(huán)境路由，讀者可運(yùn)行 Spring Cloud Tencent 下 polaris-router-featureenv-example 完整體驗(yàn)。

四、總結(jié)

測(cè)試環(huán)境路由在微服務(wù)架構(gòu)系統(tǒng)的開(kāi)發(fā)階段是非常實(shí)用的功能，能夠大大降低測(cè)試環(huán)境的維護(hù)成本、資源成本，同時(shí)能夠極大的提高研發(fā)效率。通過(guò)操作指引的章節(jié)可以看出通過(guò) Spring Cloud Tencent 實(shí)現(xiàn)測(cè)試環(huán)境路由非常簡(jiǎn)單的，只需要部署的服務(wù)實(shí)例增加相應(yīng)的環(huán)境標(biāo)簽以及在請(qǐng)求頭中增加一個(gè)標(biāo)簽即可。

業(yè)界常見(jiàn)的測(cè)試環(huán)境路由實(shí)現(xiàn)方案往往需要下發(fā)路由規(guī)則給鏈路上的服務(wù)，從而實(shí)現(xiàn)路由能力。但是通過(guò)北極星的元數(shù)據(jù)路由能力，整個(gè)方案里無(wú)需下發(fā)任何路由規(guī)則，只需要在實(shí)例設(shè)置相應(yīng)的標(biāo)簽信息即可，操作成本非常低。

如果項(xiàng)目剛好使用 Spring Cloud Gateway 作為網(wǎng)關(guān)，那么集成 Spring Cloud Tencent 里的網(wǎng)關(guān)染色插件能夠進(jìn)一步降低流量染色成本，客戶端無(wú)需做任何事情，只需要配置網(wǎng)關(guān)染色規(guī)則即可實(shí)現(xiàn)流量染色。

目前 Spring Cloud Tencent 主要實(shí)現(xiàn)了微服務(wù)之間調(diào)用流量的測(cè)試環(huán)境路由能力，不涉及消息隊(duì)列、任務(wù)調(diào)度的測(cè)試環(huán)境路由能力。

五、歡迎共建

如果您所在項(xiàng)目正在使用 Spring Cloud 框架，并且

沉淀出了非常實(shí)用的通用插件能力和場(chǎng)景化解決方案

目前正遇到一些落地難題

對(duì) Spring Cloud Tencent 項(xiàng)目感興趣

非常歡迎您跟我們一起打磨更多實(shí)用且通用的能力，共建滿足各類實(shí)際生產(chǎn)場(chǎng)景使用的微服務(wù)開(kāi)發(fā)框架。您的一個(gè)建議、Issue、Pull Request 甚至只是一個(gè)小小的 Star 都是對(duì) Spring Cloud Tencent 社區(qū)極大的支持。

Github 地址：https://github.com/Tencent/spring-cloud-tencent