Day4 一致性哈希学习笔记

Author: jerekli

gee-cache/day4-consistent-hash/geecache/consistenthash/consistenthash.go

@@ -11,21 +11,21 @@ type Hash func(data []byte) uint32
 
 // Map constains all hashed keys
 type Map struct {
-	hash     Hash
-	replicas int
-	keys     []int // Sorted
-	hashMap  map[int]string
+	hash     Hash           // 定义了函数类型 Hash，
+	replicas int            // 虚拟节点倍数
+	keys     []int          // Sorted 哈希环
+	hashMap  map[int]string // 虚拟节点与真实节点的映射表 hashMap，键是虚拟节点的哈希值，值是真实节点的名称。
 }
 
-// New creates a Map instance
+// New creates a Map instance 构造函数 New() 允许自定义虚拟节点倍数和 Hash 函数。
 func New(replicas int, fn Hash) *Map {
 	m := &Map{
 		replicas: replicas,
 		hash:     fn,
 		hashMap:  make(map[int]string),
 	}
 	if m.hash == nil {
-		m.hash = crc32.ChecksumIEEE
+		m.hash = crc32.ChecksumIEEE // 采取依赖注入的方式，允许用于替换成自定义的 Hash 函数，也方便测试时替换，默认为 crc32.ChecksumIEEE 算法。
 	}
 	return m
 }
@@ -34,11 +34,15 @@ func New(replicas int, fn Hash) *Map {
 func (m *Map) Add(keys ...string) {
 	for _, key := range keys {
 		for i := 0; i < m.replicas; i++ {
+			// 对每一个真实节点 key，对应创建 m.replicas 个虚拟节点，虚拟节点的名称是：strconv.Itoa(i) + key，即通过添加编号的方式区分不同虚拟节点。
 			hash := int(m.hash([]byte(strconv.Itoa(i) + key)))
+			// 使用 m.hash() 计算虚拟节点的哈希值，使用 append(m.keys, hash) 添加到环上。
 			m.keys = append(m.keys, hash)
+			// 在 hashMap 中增加虚拟节点和真实节点的映射关系
 			m.hashMap[hash] = key
 		}
 	}
+	// 最后一步，环上的哈希值排序。
 	sort.Ints(m.keys)
 }
 
@@ -47,12 +51,16 @@ func (m *Map) Get(key string) string {
 	if len(m.keys) == 0 {
 		return ""
 	}
-
+	// 第一步，计算 key 的哈希值。
 	hash := int(m.hash([]byte(key)))
 	// Binary search for appropriate replica.
+	// 第二步，顺时针找到第一个匹配的虚拟节点的下标 idx，从 m.keys 中获取到对应的哈希值。如果 idx == len(m.keys)，
+	// 说明应选择 m.keys[0]，
 	idx := sort.Search(len(m.keys), func(i int) bool {
+		// 寻找到第一个大于这个hash值的keys[i]的坐标idx
 		return m.keys[i] >= hash
 	})
-
+	// 第三步，通过 hashMap 映射得到真实的节点。
+	// 因为 m.keys 是一个环状结构，所以用取余数的方式来处理这种情况。
 	return m.hashMap[m.keys[idx%len(m.keys)]]
 }

gee-cache/day4-consistent-hash/geecache/consistenthash/consistenthash_test.go

@@ -6,20 +6,22 @@ import (
 )
 
 func TestHashing(t *testing.T) {
+	// 自定义的 Hash 算法只处理数字，传入字符串表示的数字，返回对应的数字即可。
 	hash := New(3, func(key []byte) uint32 {
 		i, _ := strconv.Atoi(string(key))
 		return uint32(i)
 	})
 
 	// Given the above hash function, this will give replicas with "hashes":
 	// 2, 4, 6, 12, 14, 16, 22, 24, 26
-	hash.Add("6", "4", "2")
-
+	hash.Add("6", "4", "2") // 一开始，有 2/4/6 三个真实节点，对应的虚拟节点的哈希值是 02/12/22、04/14/24、06/16/26。
+	//那么用例 2/11/23/27 选择的虚拟节点分别是 02/12/24/02，也就是真实节点 2/2/4/2。
 	testCases := map[string]string{
 		"2":  "2",
 		"11": "2",
 		"23": "4",
 		"27": "2",
+		"3":  "4",
 	}
 
 	for k, v := range testCases {