• 前言
• 1. 修改.tars協議檔案
  • 1.1 Go語言修改部分
  • 1.2 修改地方的邏輯
  • 1.3 通過協議檔案自動生成代碼
• 2. 【核心】增添Subset核心功能
  • 2.1 Go語言修改部分
  • 2.2 新增地方的邏輯
• 3. 添加常量與獲取染色key的方法
  • 3.1 Go語言修改部分
  • 3.2 修改地方的邏輯
• 4. 【核心】修改獲取服務IP規則
  • 4.1 Go語言修改部分
  • 4.2 修改地方的邏輯
• 5. 實作透傳染色Key功能（客戶端）
  • 5.1 Go語言修改部分
  • 5.2 修改地方的邏輯
• 6. 實作透傳染色Key功能（服務端）
  • 6.1 Go語言修改部分
  • 6.2 修改地方的邏輯
• 7. 給節點資訊增添Subset欄位
  • 7.1 Go語言修改部分
  • 7.2 修改地方的邏輯
• * 8. 新增工具類
  • 8.1 Go語言修改部分
• 最后

前言

利開園導師（下稱“利導師"）用Go語言實作了Subset路由規則，并在中期匯報分享會里介紹出來；這篇文章將基于利導師的實作方式，對Subset路由規則的細節做些理解與補充，

此篇文章為上半部分，旨在記錄利導師對TarsGo代碼的修改，并對分析其Subset路由規則，下半部分將對照與參考Go語言JDK的實作方式，對TarsJava相關Subset路由規則做代碼改進，

上下部分文章在目錄上一一對應，上半注重TarsGo分析，下半部分注重TarsJava實作方式，如上篇文章第一點修改.tars協議檔案記錄利導師在TarsGo的代碼修改，下片文章第一點也是修改.tars協議檔案，側重點在如何用Java語言實作，背景關系章相輔相成，建議對照學習，

一些資源鏈接如下：

下半部分文章鏈接
https://blog.csdn.net/dlhjw1412/article/details/119810186

TarsJava 實作Subset路由規則JDK鏈接地址
https://github.com/dlhjw/TarsJava/commit/cc2fe884ecbe8455a8e1f141e21341f4f3dd98a3

TarsGo 實作Subset路由規則JDK鏈接地址
https://github.com/defool/TarsGo/commit/136878e9551d68c4b54c402df564729f51f3dd9c#

1. 修改.tars協議檔案

在Tars協議檔案里；

1.1 Go語言修改部分

協議檔案共有兩處地方需要更改，一是給EndpointF節點增加Subset配置，二是在查找助手里添加根據ID獲取Subset配置資訊的介面配置；

給EndpointF節點增加Subset配置：

根據ID獲取Subset配置資訊的介面：

1.2 修改地方的邏輯

注意：

• 第一處：給EndpointF節點增加Subset配置
  • 最終結果可能不是這樣，要看Registry介面是怎樣的；
  • 修改協議檔案后需要運行一段命令自動生成相應代碼；
  • TarsGo的自動生成命令在tars/protocol/res/Makefile里；
• 第二處：根據ID獲取Subset配置資訊的介面
  • String id 為“應用名.服務名.埠名”；
  • id這樣設定是考慮到與其他介面命令對其；
  • 該介面要與Tars Registry新增的介面名對上；

1.3 通過協議檔案自動生成代碼

Tars有個強大的功能，它能根據.tars里的組態檔自動生成相應Bean代碼；

而在TarsGo里，對應代碼如下：

執行上述命令后，對應代碼會發生改變，如下：

這告訴我們老師發布的TarsGo代碼里，有些代碼不需要我們手動去更改，而是通過命令自動生成的，在Java中命令為在專案根路徑執行mvn tars:tars2java，具體程序將在下半部分文章里詳解，這里僅記錄TarsGo代碼在哪發生變化，

2. 【核心】增添Subset核心功能

Go語言在tars/subset.go內

2.1 Go語言修改部分

package tars

import (
	"encoding/json"
	"math/rand"
	"regexp"
	"strconv"
	"sync"
	"time"

	"github.com/TarsCloud/TarsGo/tars/protocol/res/endpointf"
	"github.com/TarsCloud/TarsGo/tars/protocol/res/queryf"
	"github.com/TarsCloud/TarsGo/tars/util/consistenthash"
	"github.com/TarsCloud/TarsGo/tars/util/endpoint"
	"github.com/serialx/hashring"
)

var (
	enableSubset = true
	subsetMg     = &subsetManager{}
)

type hashString string

func (h hashString) String() string {
	return string(h)
}

type subsetConf struct {
	enable    bool
	ruleType  string // ratio/key
	ratioConf *ratioConfig
	keyConf   *keyConfig

	lastUpdate time.Time
}

type ratioConfig struct {
	ring *hashring.HashRing
}

type keyRoute struct {
	action string
	value  string
	route  string
}

type keyConfig struct {
	rules        []keyRoute
	defaultRoute string
}

type subsetManager struct {
	lock  *sync.RWMutex
	cache map[string]*subsetConf

	registry *queryf.QueryF
}

//根據服務名獲取它的Subset方法，回傳subsetConf配置項
func (s *subsetManager) getSubsetConfig(servantName string) *subsetConf {
	s.lock.RLock()
	defer s.lock.RUnlock()
	var ret *subsetConf
	//如果快取在最近時間之內，就直接回傳
	if v, ok := s.cache[servantName]; ok {
		ret = v
		if v.lastUpdate.Add(time.Second * 10).After(time.Now()) {
			return ret
		}
	}
	//如果上次獲取時間超時，則呼叫registry介面獲取對應配置
	// get config from registry
	conf := &endpointf.SubsetConf{}
	retVal, err := s.registry.FindSubsetConfigById(servantName, conf)
	if err != nil || retVal != 0 {
		// log error
		return ret
	}

	ret = &subsetConf{
		ruleType:   conf.RuleType,
		lastUpdate: time.Now(),
	}
	s.cache[servantName] = ret
	
	// 決議從registry那獲取的配置資訊
	// parse subset conf
	if !conf.Enable {
		ret.enable = false
		return ret
	}
	//按比例路由
	if conf.RuleType == "ratio" {
		kv := make(map[string]int)
		json.Unmarshal([]byte(conf.RuteData), &kv)
		ret.ratioConf = &ratioConfig{ring: hashring.NewWithWeights(kv)}
	} else {
		keyConf := &keyConfig{}
		kvlist := make([]map[string]string, 0)
		json.Unmarshal([]byte(conf.RuteData), &kvlist)
		for _, kv := range kvlist {
		    //默認路由
			if vv, ok := kv["default"]; ok {
				keyConf.defaultRoute = vv
			}
			if vv, ok := kv["match"]; ok {
			    //精確匹配
				keyConf.rules = append(keyConf.rules, keyRoute{
					action: "match",
					value:  vv,
					route:  kv["route"],
				})
			} else if vv, ok := kv["equal"]; ok {
			    //正則匹配
				keyConf.rules = append(keyConf.rules, keyRoute{
					action: "equal",
					value:  vv,
					route:  kv["route"],
				})
			}
		}
		ret.keyConf = keyConf
	}
	return ret
}

func (s *subsetManager) getSubset(servantName, routeKey string) string {
	// check subset config exists
	subsetConf := subsetMg.getSubsetConfig(servantName)
	if subsetConf == nil {
		return ""
	}
	// route key to subset
	if subsetConf.ruleType == "ratio" {
		return subsetConf.ratioConf.findSubet(routeKey)
	}
	return subsetConf.keyConf.findSubet(routeKey)
}

//根據subset規則過濾節點
func subsetEndpointFilter(servantName, routeKey string, eps []endpoint.Endpoint) []endpoint.Endpoint {
	if !enableSubset {
		return eps
	}
	subset := subsetMg.getSubset(servantName, routeKey)
	if subset == "" {
		return eps
	}

	ret := make([]endpoint.Endpoint, 0)
	for i := range eps {
		if eps[i].Subset == subset {
			ret = append(ret, eps[i])
		}
	}
	return ret
}

func subsetHashEpFilter(servantName, routeKey string, m *consistenthash.ChMap) *consistenthash.ChMap {
	if !enableSubset {
		return m
	}
	subset := subsetMg.getSubset(servantName, routeKey)
	if subset == "" {
		return m
	}

	ret := consistenthash.NewChMap(32)
	for _, v := range m.GetNodes() {
		vv, ok := v.(endpoint.Endpoint)
		if ok && vv.Subset == subset {
			ret.Add(vv)
		}
	}
	return ret
}

func (k *ratioConfig) findSubet(key string) string {
	// 為空時使用隨機方式
	if key == "" {
		key = strconv.Itoa(rand.Int())
	}
	v, _ := k.ring.GetNode(key)
	return v
}

func (k *keyConfig) findSubet(key string) string {
	for _, v := range k.rules {
		if v.action == "equal" && key == v.value {
			return v.route
		} else if v.action == "match" {
			if matched, _ := regexp.Match(v.value, []byte(key)); matched {
				return v.route
			}
		}
	}
	return k.defaultRoute
}

2.2 新增地方的邏輯

3. 添加常量與獲取染色key的方法

在tars/util/current/tarscurrent相關包里，處理背景關系資訊相關；

3.1 Go語言修改部分

3.2 修改地方的邏輯

4. 【核心】修改獲取服務IP規則

在節點管理的相關檔案里；方法是實作在第8點；

4.1 Go語言修改部分

4.2 修改地方的邏輯

5. 實作透傳染色Key功能（客戶端）

在tars/tarsprotocol相關檔案里；

5.1 Go語言修改部分

5.2 修改地方的邏輯

注意：

• 這里的染色Key為新建的，與源代碼里的染色Key不同；
• 可以參考染色一致的實作方式，區別是Key的名稱不同，實作思路類似；
• 在TarsJava客戶端中，這里的最終執行的方法指TarsInvoker類里的三個執行方法；
  • 即：同步呼叫方法invokeWithSync()、異步呼叫方法invokeWithAsync()和協程呼叫方法invokeWithPromiseFuture()

6. 實作透傳染色Key功能（服務端）

在tars/tarsprotocol.go相關檔案里；

6.1 Go語言修改部分

6.2 修改地方的邏輯

• 在TarsJava服務端中，這里的最終執行的方法指TarsServantProcessor.process()

7. 給節點資訊增添Subset欄位

在節點資訊相關檔案里；

7.1 Go語言修改部分

7.2 修改地方的邏輯

注意：

• 不一定是String型別，只要在Endpoint物件結構體里添加一個Subset相關屬性，有地方用即可；
• 這部分在Java中僅為Endpoint.java類，故放在一起；

* 8. 新增工具類

在工具類包里；

8.1 Go語言修改部分

最后

新人制作，如有錯誤，歡迎指出，感激不盡！ 歡迎關注公眾號，會分享一些更日常的東西！ 如需轉載，請標注出處！

標籤：其他

上一篇：jdk的下載安裝及環境配置

下一篇：用Python做一個歡樂豆蹭蹭上漲的神器！自從用了它斗地主我就沒輸過！