1. move cloneBytes from geecache.go to byteview.go 2. add more tests

2024-04-21 12:32:11 +00:00 · 2020-02-12 20:36:05 +08:00
parent a6535ef328
commit 0d40f4f111
34 changed files with 860 additions and 62 deletions
@@ -27,8 +27,8 @@
 [GeeCache](https://geektutu.com/post/geecache.html) 是一个模仿 [groupcache](https://github.com/golang/groupcache) 实现的分布式缓存系统

 - [第一天：LRU 缓存淘汰策略](https://geektutu.com/post/geecache-day1.html) | [Code](gee-cache/day1-lru)
- 第二天：单机并发缓存 | [Code](gee-cache/day2-single-node)
- 第三天：HTTP 服务端 | [Code](gee-cache/day3-http-server)
+- [第二天：单机并发缓存](https://geektutu.com/post/geecache-day2.html) | [Code](gee-cache/day2-single-node)
+- [第三天：HTTP 服务端](https://geektutu.com/post/geecache-day3.html) | [Code](gee-cache/day3-http-server)
 - 第四天：一致性哈希(Hash) | [Code](gee-cache/day4-consistent-hash)
 - 第五天：分布式节点 | [Code](gee-cache/day5-multi-nodes)
 - 第六天：防止缓存击穿 | [Code](gee-cache/day6-single-flight)
@@ -19,3 +19,9 @@ func (v ByteView) ByteSlice() []byte {
 func (v ByteView) String() string {
 	return string(v.b)
 }
+
+func cloneBytes(b []byte) []byte {
+	c := make([]byte, len(b))
+	copy(c, b)
+	return c
+}
@@ -70,12 +70,6 @@ func (g *Group) Get(key string) (ByteView, error) {
 	return g.load(key)
 }

-func cloneBytes(b []byte) []byte {
-	c := make([]byte, len(b))
-	copy(c, b)
-	return c
-}
-
 func (g *Group) load(key string) (value ByteView, err error) {
 	return g.getLocally(key)
 }
@@ -3,6 +3,7 @@ package geecache
 import (
 	"fmt"
 	"log"
+	"reflect"
 	"testing"
 )

@@ -12,21 +13,39 @@ var db = map[string]string{
 	"Sam":  "567",
 }

+func TestGetter(t *testing.T) {
+	var f Getter = GetterFunc(func(key string) ([]byte, error) {
+		return []byte(key), nil
+	})
+
+	expect := []byte("key")
+	if v, _ := f.Get("key"); !reflect.DeepEqual(v, expect) {
+		t.Fatal("callback failed")
+	}
+}
+
 func TestGet(t *testing.T) {
+	loadCounts := make(map[string]int, len(db))
 	gee := NewGroup("scores", 2<<10, GetterFunc(
 		func(key string) ([]byte, error) {
 			log.Println("[SlowDB] search key", key)
 			if v, ok := db[key]; ok {
+				if _, ok := loadCounts[key]; !ok {
+					loadCounts[key] = 0
+				}
+				loadCounts[key]++
 				return []byte(v), nil
 			}
 			return nil, fmt.Errorf("%s not exist", key)
 		}))

 	for k, v := range db {
-		view, err := gee.Get(k)
-		if err != nil || view.String() != v {
+		if view, err := gee.Get(k); err != nil || view.String() != v {
 			t.Fatal("failed to get value of Tom")
 		}
+		if _, err := gee.Get(k); err != nil || loadCounts[k] > 1 {
+			t.Fatalf("cache %s miss", k)
+		}
 	}

 	if view, err := gee.Get("unknown"); err == nil {
@@ -19,3 +19,9 @@ func (v ByteView) ByteSlice() []byte {
 func (v ByteView) String() string {
 	return string(v.b)
 }
+
+func cloneBytes(b []byte) []byte {
+	c := make([]byte, len(b))
+	copy(c, b)
+	return c
+}
@@ -70,12 +70,6 @@ func (g *Group) Get(key string) (ByteView, error) {
 	return g.load(key)
 }

-func cloneBytes(b []byte) []byte {
-	c := make([]byte, len(b))
-	copy(c, b)
-	return c
-}
-
 func (g *Group) load(key string) (value ByteView, err error) {
 	return g.getLocally(key)
 }
@@ -3,6 +3,7 @@ package geecache
 import (
 	"fmt"
 	"log"
+	"reflect"
 	"testing"
 )

@@ -12,21 +13,39 @@ var db = map[string]string{
 	"Sam":  "567",
 }

+func TestGetter(t *testing.T) {
+	var f Getter = GetterFunc(func(key string) ([]byte, error) {
+		return []byte(key), nil
+	})
+
+	expect := []byte("key")
+	if v, _ := f.Get("key"); !reflect.DeepEqual(v, expect) {
+		t.Fatal("callback failed")
+	}
+}
+
 func TestGet(t *testing.T) {
+	loadCounts := make(map[string]int, len(db))
 	gee := NewGroup("scores", 2<<10, GetterFunc(
 		func(key string) ([]byte, error) {
 			log.Println("[SlowDB] search key", key)
 			if v, ok := db[key]; ok {
+				if _, ok := loadCounts[key]; !ok {
+					loadCounts[key] = 0
+				}
+				loadCounts[key]++
 				return []byte(v), nil
 			}
 			return nil, fmt.Errorf("%s not exist", key)
 		}))

 	for k, v := range db {
-		view, err := gee.Get(k)
-		if err != nil || view.String() != v {
+		if view, err := gee.Get(k); err != nil || view.String() != v {
 			t.Fatal("failed to get value of Tom")
 		}
+		if _, err := gee.Get(k); err != nil || loadCounts[k] > 1 {
+			t.Fatalf("cache %s miss", k)
+		}
 	}

 	if view, err := gee.Get("unknown"); err == nil {
@@ -16,7 +16,7 @@ type HTTPPool struct {
 	basePath string
 }

-// NewHTTPPool initializes an HTTP pool of peers, and registers itself as a PeerPicker.
+// NewHTTPPool initializes an HTTP pool of peers.
 func NewHTTPPool(self string) *HTTPPool {
 	return &HTTPPool{
 		self:     self,
@@ -19,3 +19,9 @@ func (v ByteView) ByteSlice() []byte {
 func (v ByteView) String() string {
 	return string(v.b)
 }
+
+func cloneBytes(b []byte) []byte {
+	c := make([]byte, len(b))
+	copy(c, b)
+	return c
+}
@@ -70,12 +70,6 @@ func (g *Group) Get(key string) (ByteView, error) {
 	return g.load(key)
 }

-func cloneBytes(b []byte) []byte {
-	c := make([]byte, len(b))
-	copy(c, b)
-	return c
-}
-
 func (g *Group) load(key string) (value ByteView, err error) {
 	return g.getLocally(key)
 }
@@ -3,6 +3,7 @@ package geecache
 import (
 	"fmt"
 	"log"
+	"reflect"
 	"testing"
 )

@@ -12,21 +13,39 @@ var db = map[string]string{
 	"Sam":  "567",
 }

+func TestGetter(t *testing.T) {
+	var f Getter = GetterFunc(func(key string) ([]byte, error) {
+		return []byte(key), nil
+	})
+
+	expect := []byte("key")
+	if v, _ := f.Get("key"); !reflect.DeepEqual(v, expect) {
+		t.Fatal("callback failed")
+	}
+}
+
 func TestGet(t *testing.T) {
+	loadCounts := make(map[string]int, len(db))
 	gee := NewGroup("scores", 2<<10, GetterFunc(
 		func(key string) ([]byte, error) {
 			log.Println("[SlowDB] search key", key)
 			if v, ok := db[key]; ok {
+				if _, ok := loadCounts[key]; !ok {
+					loadCounts[key] = 0
+				}
+				loadCounts[key]++
 				return []byte(v), nil
 			}
 			return nil, fmt.Errorf("%s not exist", key)
 		}))

 	for k, v := range db {
-		view, err := gee.Get(k)
-		if err != nil || view.String() != v {
+		if view, err := gee.Get(k); err != nil || view.String() != v {
 			t.Fatal("failed to get value of Tom")
 		}
+		if _, err := gee.Get(k); err != nil || loadCounts[k] > 1 {
+			t.Fatalf("cache %s miss", k)
+		}
 	}

 	if view, err := gee.Get("unknown"); err == nil {
@@ -16,7 +16,7 @@ type HTTPPool struct {
 	basePath string
 }

-// NewHTTPPool initializes an HTTP pool of peers, and registers itself as a PeerPicker.
+// NewHTTPPool initializes an HTTP pool of peers.
 func NewHTTPPool(self string) *HTTPPool {
 	return &HTTPPool{
 		self:     self,
@@ -19,3 +19,9 @@ func (v ByteView) ByteSlice() []byte {
 func (v ByteView) String() string {
 	return string(v.b)
 }
+
+func cloneBytes(b []byte) []byte {
+	c := make([]byte, len(b))
+	copy(c, b)
+	return c
+}
@@ -79,12 +79,6 @@ func (g *Group) RegisterPeers(peers PeerPicker) {
 	g.peers = peers
 }

-func cloneBytes(b []byte) []byte {
-	c := make([]byte, len(b))
-	copy(c, b)
-	return c
-}
-
 func (g *Group) load(key string) (value ByteView, err error) {
 	if g.peers != nil {
 		if peer, ok := g.peers.PickPeer(key); ok {
@@ -3,6 +3,7 @@ package geecache
 import (
 	"fmt"
 	"log"
+	"reflect"
 	"testing"
 )

@@ -12,21 +13,39 @@ var db = map[string]string{
 	"Sam":  "567",
 }

+func TestGetter(t *testing.T) {
+	var f Getter = GetterFunc(func(key string) ([]byte, error) {
+		return []byte(key), nil
+	})
+
+	expect := []byte("key")
+	if v, _ := f.Get("key"); !reflect.DeepEqual(v, expect) {
+		t.Fatal("callback failed")
+	}
+}
+
 func TestGet(t *testing.T) {
+	loadCounts := make(map[string]int, len(db))
 	gee := NewGroup("scores", 2<<10, GetterFunc(
 		func(key string) ([]byte, error) {
 			log.Println("[SlowDB] search key", key)
 			if v, ok := db[key]; ok {
+				if _, ok := loadCounts[key]; !ok {
+					loadCounts[key] = 0
+				}
+				loadCounts[key]++
 				return []byte(v), nil
 			}
 			return nil, fmt.Errorf("%s not exist", key)
 		}))

 	for k, v := range db {
-		view, err := gee.Get(k)
-		if err != nil || view.String() != v {
+		if view, err := gee.Get(k); err != nil || view.String() != v {
 			t.Fatal("failed to get value of Tom")
 		}
+		if _, err := gee.Get(k); err != nil || loadCounts[k] > 1 {
+			t.Fatalf("cache %s miss", k)
+		}
 	}

 	if view, err := gee.Get("unknown"); err == nil {
@@ -26,7 +26,7 @@ type HTTPPool struct {
 	httpGetters map[string]*httpGetter // keyed by e.g. "http://10.0.0.2:8008"
 }

-// NewHTTPPool initializes an HTTP pool of peers, and registers itself as a PeerPicker.
+// NewHTTPPool initializes an HTTP pool of peers.
 func NewHTTPPool(self string) *HTTPPool {
 	return &HTTPPool{
 		self:     self,
@@ -19,3 +19,9 @@ func (v ByteView) ByteSlice() []byte {
 func (v ByteView) String() string {
 	return string(v.b)
 }
+
+func cloneBytes(b []byte) []byte {
+	c := make([]byte, len(b))
+	copy(c, b)
+	return c
+}
@@ -84,12 +84,6 @@ func (g *Group) RegisterPeers(peers PeerPicker) {
 	g.peers = peers
 }

-func cloneBytes(b []byte) []byte {
-	c := make([]byte, len(b))
-	copy(c, b)
-	return c
-}
-
 func (g *Group) load(key string) (value ByteView, err error) {
 	// each key is only fetched once (either locally or remotely)
 	// regardless of the number of concurrent callers.
@@ -3,6 +3,7 @@ package geecache
 import (
 	"fmt"
 	"log"
+	"reflect"
 	"testing"
 )

@@ -12,21 +13,39 @@ var db = map[string]string{
 	"Sam":  "567",
 }

+func TestGetter(t *testing.T) {
+	var f Getter = GetterFunc(func(key string) ([]byte, error) {
+		return []byte(key), nil
+	})
+
+	expect := []byte("key")
+	if v, _ := f.Get("key"); !reflect.DeepEqual(v, expect) {
+		t.Fatal("callback failed")
+	}
+}
+
 func TestGet(t *testing.T) {
+	loadCounts := make(map[string]int, len(db))
 	gee := NewGroup("scores", 2<<10, GetterFunc(
 		func(key string) ([]byte, error) {
 			log.Println("[SlowDB] search key", key)
 			if v, ok := db[key]; ok {
+				if _, ok := loadCounts[key]; !ok {
+					loadCounts[key] = 0
+				}
+				loadCounts[key]++
 				return []byte(v), nil
 			}
 			return nil, fmt.Errorf("%s not exist", key)
 		}))

 	for k, v := range db {
-		view, err := gee.Get(k)
-		if err != nil || view.String() != v {
+		if view, err := gee.Get(k); err != nil || view.String() != v {
 			t.Fatal("failed to get value of Tom")
 		}
+		if _, err := gee.Get(k); err != nil || loadCounts[k] > 1 {
+			t.Fatalf("cache %s miss", k)
+		}
 	}

 	if view, err := gee.Get("unknown"); err == nil {
@@ -26,7 +26,7 @@ type HTTPPool struct {
 	httpGetters map[string]*httpGetter // keyed by e.g. "http://10.0.0.2:8008"
 }

-// NewHTTPPool initializes an HTTP pool of peers, and registers itself as a PeerPicker.
+// NewHTTPPool initializes an HTTP pool of peers.
 func NewHTTPPool(self string) *HTTPPool {
 	return &HTTPPool{
 		self:     self,
@@ -19,3 +19,9 @@ func (v ByteView) ByteSlice() []byte {
 func (v ByteView) String() string {
 	return string(v.b)
 }
+
+func cloneBytes(b []byte) []byte {
+	c := make([]byte, len(b))
+	copy(c, b)
+	return c
+}
@@ -85,12 +85,6 @@ func (g *Group) RegisterPeers(peers PeerPicker) {
 	g.peers = peers
 }

-func cloneBytes(b []byte) []byte {
-	c := make([]byte, len(b))
-	copy(c, b)
-	return c
-}
-
 func (g *Group) load(key string) (value ByteView, err error) {
 	// each key is only fetched once (either locally or remotely)
 	// regardless of the number of concurrent callers.
@@ -3,6 +3,7 @@ package geecache
 import (
 	"fmt"
 	"log"
+	"reflect"
 	"testing"
 )

@@ -12,21 +13,39 @@ var db = map[string]string{
 	"Sam":  "567",
 }

+func TestGetter(t *testing.T) {
+	var f Getter = GetterFunc(func(key string) ([]byte, error) {
+		return []byte(key), nil
+	})
+
+	expect := []byte("key")
+	if v, _ := f.Get("key"); !reflect.DeepEqual(v, expect) {
+		t.Fatal("callback failed")
+	}
+}
+
 func TestGet(t *testing.T) {
+	loadCounts := make(map[string]int, len(db))
 	gee := NewGroup("scores", 2<<10, GetterFunc(
 		func(key string) ([]byte, error) {
 			log.Println("[SlowDB] search key", key)
 			if v, ok := db[key]; ok {
+				if _, ok := loadCounts[key]; !ok {
+					loadCounts[key] = 0
+				}
+				loadCounts[key]++
 				return []byte(v), nil
 			}
 			return nil, fmt.Errorf("%s not exist", key)
 		}))

 	for k, v := range db {
-		view, err := gee.Get(k)
-		if err != nil || view.String() != v {
+		if view, err := gee.Get(k); err != nil || view.String() != v {
 			t.Fatal("failed to get value of Tom")
 		}
+		if _, err := gee.Get(k); err != nil || loadCounts[k] > 1 {
+			t.Fatalf("cache %s miss", k)
+		}
 	}

 	if view, err := gee.Get("unknown"); err == nil {
@@ -29,7 +29,7 @@ type HTTPPool struct {
 	httpGetters map[string]*httpGetter // keyed by e.g. "http://10.0.0.2:8008"
 }

-// NewHTTPPool initializes an HTTP pool of peers, and registers itself as a PeerPicker.
+// NewHTTPPool initializes an HTTP pool of peers.
 func NewHTTPPool(self string) *HTTPPool {
 	return &HTTPPool{
 		self:     self,
@@ -1,7 +1,7 @@
 ---
 title: 动手写分布式缓存 - GeeCache第一天 LRU 缓存淘汰策略
 date: 2020-02-11 22:00:00
-description: 7天用 Go语言/golang 从零实现分布式缓存 GeeCache 教程(7 days implement golang distributed cache from scratch tutorial)，动手写分布式缓存，参照 groupcache 的实现。本文介绍常用的三种缓存淘汰(失效)算法：先进先出(FIFO)，最少使用(LFU) 和 最近最少使用(LRU)，并实现 LRU 算法和相应的测试代码。
+description: 7天用 Go语言/golang 从零实现分布式缓存 GeeCache 教程(7 days implement golang distributed cache from scratch tutorial)，动手写分布式缓存，参照 groupcache 的实现。本文介绍了常用的三种缓存淘汰(失效)算法：先进先出(FIFO)，最少使用(LFU) 和 最近最少使用(LRU)，并实现 LRU 算法和相应的测试代码。
 tags:
 - Go
 nav: 从零实现
@@ -9,8 +9,8 @@ categories:
 - 分布式缓存 - GeeCache
 keywords:
 - Go语言
- 从零实现分布式缓存
- 动手写分布式缓存
+- 从零实现
+- 分布式缓存
 - LRU
 - 缓存失效
 image: post/geecache-day1/lru_logo.jpg
@@ -141,7 +141,7 @@ func (c *Cache) RemoveOldest() {
 ```

 - `c.ll.Back()` 取到队首节点，从链表中删除。
- `delete(c.cache, kv.key)`，从字典中`c.cache`删除该节点的映射关系。
+- `delete(c.cache, kv.key)`，从字典中 `c.cache` 删除该节点的映射关系。
 - 更新当前所用的内存 `c.nbytes`。
 - 如果回调函数 `OnEvicted` 不为 nil，则调用回调函数。

@@ -167,7 +167,7 @@ func (c *Cache) Add(key string, value Value) {
 ```

 - 如果键存在，则更新对应节点的值，并将该节点移到队尾。
- 不存在则是新增场景，首先队尾添加新节点 `&entry{key, value}`, 并字典中添加 `key` 和节点的映射关系。
+- 不存在则是新增场景，首先队尾添加新节点 `&entry{key, value}`, 并字典中添加 key 和节点的映射关系。
 - 更新 `c.nbytes`，如果超过了设定的最大值 `c.maxBytes`，则移除最少访问的节点。

 最后，为了方便测试，我们实现 `Len()` 用来获取添加了多少条数据。
@@ -0,0 +1,430 @@
+---
+title: 动手写分布式缓存 - GeeCache第二天 单机并发缓存
+date: 2020-02-12 22:00:00
+description: 7天用 Go语言/golang 从零实现分布式缓存 GeeCache 教程(7 days implement golang distributed cache from scratch tutorial)，动手写分布式缓存，参照 groupcache 的实现。本文介绍了 sync.Mutex 互斥锁的使用，并发控制 LRU 缓存。实现 GeeCache 核心数据结构 Group，缓存不存在时，调用回调函数(callback)获取源数据。
+tags:
+- Go
+nav: 从零实现
+categories:
+- 分布式缓存 - GeeCache
+keywords:
+- Go语言
+- 从零实现
+- 分布式缓存
+- 互斥锁
+- sync.Mutex
+image: post/geecache-day2/concurrent_cache_logo.jpg
+github: https://github.com/geektutu/7days-golang
+---
+
+![geecache concurrent cache](geecache-day2/concurrent_cache.jpg)
+
+本文是[7天用Go从零实现分布式缓存GeeCache](https://geektutu.com/post/geecache.html)的第二篇。
+
+- 介绍 sync.Mutex 互斥锁的使用，并实现 LRU 缓存的并发控制。
+- 实现 GeeCache 核心数据结构 Group，缓存不存在时，调用回调函数获取源数据，**代码约150行**
+
+## 1 sync.Mutex
+
+多个协程(goroutine)同时读写同一个变量，在并发度较高的情况下，会发生冲突。确保一次只有一个协程(goroutine)可以访问该变量以避免冲突，这称之为`互斥`，互斥锁可以解决这个问题。
+
+> sync.Mutex 是一个互斥锁，可以由不同的协程加锁和解锁。
+
+`sync.Mutex` 是 Go 语言标准库提供的一个互斥锁，当一个协程(goroutine)获得了这个锁的拥有权后，其它请求锁的协程(goroutine) 就会阻塞在 `Lock()` 方法的调用上，直到调用 `Unlock()` 锁被释放。
+
+接下来举一个简单的例子，假设有10个并发的协程打印了同一个数字`100`，为了避免重复打印，实现了`printOnce(num int)` 函数，使用集合 set 记录已打印过的数字，如果数字已打印过，则不再打印。
+
+```go
+var set = make(map[int]bool, 0)
+
+func printOnce(num int) {
+	if _, exist := set[num]; !exist {
+		fmt.Println(num)
+	}
+	set[num] = true
+}
+
+func main() {
+	for i := 0; i < 10; i++ {
+		go printOnce(100)
+	}
+	time.Sleep(time.Second)
+}
+```
+
+我们运行 `go run .` 会发生什么情况呢？
+
+```bash
+$ go run .
+100
+100
+```
+
+有时候打印 2 次，有时候打印 4 次，有时候还会触发 panic，因为对同一个数据结构`set`的访问冲突了。接下来用互斥锁的`Lock()`和`Unlock()` 方法将冲突的部分包裹起来：
+
+```go
+var m sync.Mutex
+var set = make(map[int]bool, 0)
+
+func printOnce(num int) {
+	m.Lock()
+	if _, exist := set[num]; !exist {
+		fmt.Println(num)
+	}
+	set[num] = true
+	m.Unlock()
+}
+
+func main() {
+	for i := 0; i < 10; i++ {
+		go printOnce(100)
+	}
+	time.Sleep(time.Second)
+}
+```
+
+```bash
+$ go run .
+100
+```
+
+相同的数字只会被打印一次。当一个协程调用了 `Lock()` 方法时，其他协程被阻塞了，直到`Unlock()`调用将锁释放。因此被包裹部分的代码就能够避免冲突，实现互斥。
+
+`Unlock()`释放锁还有另外一种写法：
+
+```go
+func printOnce(num int) {
+	m.Lock()
+	defer m.Unlock()
+	if _, exist := set[num]; !exist {
+		fmt.Println(num)
+	}
+	set[num] = true
+}
+```
+
+## 2 支持并发读写
+
+上一篇文章 [GeeCache 第一天](https://geektutu.com/post/geecache-day1.html) 实现了 LRU 缓存淘汰策略。接下来我们使用 `sync.Mutex` 封装 LRU 的几个方法，使之支持并发的读写。在这之前，我们抽象了一个只读数据结构 `ByteView` 用来表示缓存值，是 GeeCache 主要的数据结构之一。
+
+[day2-single-node/geecache/byteview.go - github](https://github.com/geektutu/7days-golang/tree/master/gee-cache/day2-single-node/geecache)
+
+```go
+package geecache
+
+// A ByteView holds an immutable view of bytes.
+type ByteView struct {
+	b []byte
+}
+
+// Len returns the view's length
+func (v ByteView) Len() int {
+	return len(v.b)
+}
+
+// ByteSlice returns a copy of the data as a byte slice.
+func (v ByteView) ByteSlice() []byte {
+	return cloneBytes(v.b)
+}
+
+// String returns the data as a string, making a copy if necessary.
+func (v ByteView) String() string {
+	return string(v.b)
+}
+
+func cloneBytes(b []byte) []byte {
+	c := make([]byte, len(b))
+	copy(c, b)
+	return c
+}
+```
+
+- ByteView 只有一个数据成员，`b []byte`，b 将会存储真实的缓存值。选择 byte 类型是为了能够支持任意的数据类型的存储，例如字符串、图片等。
+- 实现 `Len() int` 方法，我们在 lru.Cache 的实现中，要求被缓存对象必须实现 Value 接口，即 `Len() int` 方法，返回其所占的内存大小。
+- `b` 是只读的，使用 `ByteSlice()` 方法返回一个拷贝，防止缓存值被外部程序修改。
+
+接下来就可以为 lru.Cache 添加并发特性了。
+
+[day2-single-node/geecache/cache.go - github](https://github.com/geektutu/7days-golang/tree/master/gee-cache/day2-single-node/geecache)
+
+```go
+package geecache
+
+import (
+	"geecache/lru"
+	"sync"
+)
+
+type cache struct {
+	mu         sync.Mutex
+	lru        *lru.Cache
+	cacheBytes int64
+}
+
+func (c *cache) add(key string, value ByteView) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+	if c.lru == nil {
+		c.lru = lru.New(c.cacheBytes, nil)
+	}
+	c.lru.Add(key, value)
+}
+
+func (c *cache) get(key string) (value ByteView, ok bool) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+	if c.lru == nil {
+		return
+	}
+
+	if v, ok := c.lru.Get(key); ok {
+		return v.(ByteView), ok
+	}
+
+	return
+}
+```
+
+- `cache.go` 的实现非常简单，实例化 lru，封装 get 和 add 方法，并添加互斥锁 mu。
+- 在 `add` 方法中，判断了 `c.lru` 是否为 nil，如果不等于 nil 再创建实例。这种方法称之为延迟初始化(Lazy Initialization)，一个对象的延迟初始化意味着该对象的创建将会延迟至第一次使用该对象时。主要用于提高性能，并减少程序内存要求。
+
+## 3 主体结构 Group
+
+Group 是 GeeCache 最核心的数据结构，负责与用户的交互，并且控制缓存值存储和获取的流程。
+
+```bash
+                            是
+接收 key --> 检查是否被缓存 -----> 返回缓存值 ⑴
+                |  否                         是
+                |-----> 是否应当从远程节点获取 -----> 与远程节点交互 --> 返回缓存值 ⑵
+                            |  否
+                            |-----> 调用`回调函数`，获取值并添加到缓存 --> 返回缓存值 ⑶
+```
+
+我们将在 `geecache.go` 中实现主体结构 Group，那么 GeeCache 的代码结构的雏形已经形成了。
+
+```bash
+geecache/
+    |--lru/
+        |--lru.go  // lru 缓存淘汰策略
+    |--byteview.go // 缓存值的抽象与封装
+    |--cache.go    // 并发控制
+    |--geecache.go // 负责与外部交互，控制缓存存储和获取的主流程
+```
+
+接下来我们将实现流程 ⑴ 和 ⑶，远程交互的部分后续再实现。
+
+
+### 3.1 回调 Getter
+
+我们思考一下，如果缓存不存在，应从数据源（文件，数据库等）获取数据并添加到缓存中。GeeCache 是否应该支持多种数据源的配置呢？不应该，一是数据源的种类太多，没办法一一实现；而是扩展性不好。如何从源头获取数据，应该是用户决定的事情，我们就把这件事交给用户好了。因此，我们设计了一个回调函数(callback)，在缓存不存在时，调用这个函数，得到源数据。
+
+[day2-single-node/geecache/geecache.go - github](https://github.com/geektutu/7days-golang/tree/master/gee-cache/day2-single-node/geecache)
+
+```go
+// A Getter loads data for a key.
+type Getter interface {
+	Get(key string) ([]byte, error)
+}
+
+// A GetterFunc implements Getter with a function.
+type GetterFunc func(key string) ([]byte, error)
+
+// Get implements Getter interface function
+func (f GetterFunc) Get(key string) ([]byte, error) {
+	return f(key)
+}
+```
+
+- 定义接口 Getter 和 回调函数 `Get(key string)([]byte, error)`，参数是 key，返回值是 []byte。
+- 定义函数类型 GetterFunc，并实现 Getter 接口的 `Get` 方法。
+
+我们可以写一个测试用例来保证回调函数能够正常工作。
+
+```go
+func TestGetter(t *testing.T) {
+	var f Getter = GetterFunc(func(key string) ([]byte, error) {
+		return []byte(key), nil
+	})
+
+	expect := []byte("key")
+	if v, _ := f.Get("key"); !reflect.DeepEqual(v, expect) {
+		t.Errorf("callback failed")
+	}
+}
+```
+
+- 在这个测试用例中，我们借助 GetterFunc 的类型转换，将一个匿名回调函数转换成了接口 `f Getter`。
+- 调用该接口的方法 `f.Get(key string)`，实际上就是在调用匿名回调函数。
+
+> 定义一个函数类型 F，并且实现接口 A 的方法，然后在这个方法中调用自己。这是 Go 语言中将其他函数（参数返回值定义与 F 一致）转换为接口 A 的常用技巧。
+
+### 3.2 Group 的定义
+
+接下来是最核心数据结构 Group 的定义：
+
+[day2-single-node/geecache/geecache.go - github](https://github.com/geektutu/7days-golang/tree/master/gee-cache/day2-single-node/geecache)
+
+```go
+// A Group is a cache namespace and associated data loaded spread over
+type Group struct {
+	name      string
+	getter    Getter
+	mainCache cache
+}
+
+var (
+	mu     sync.RWMutex
+	groups = make(map[string]*Group)
+)
+
+// NewGroup create a new instance of Group
+func NewGroup(name string, cacheBytes int64, getter Getter) *Group {
+	if getter == nil {
+		panic("nil Getter")
+	}
+	mu.Lock()
+	defer mu.Unlock()
+	g := &Group{
+		name:      name,
+		getter:    getter,
+		mainCache: cache{cacheBytes: cacheBytes},
+	}
+	groups[name] = g
+	return g
+}
+
+// GetGroup returns the named group previously created with NewGroup, or
+// nil if there's no such group.
+func GetGroup(name string) *Group {
+	mu.RLock()
+	g := groups[name]
+	mu.RUnlock()
+	return g
+}
+```
+
+- 一个 Group 可以认为是一个缓存的命名空间，每个 Group 拥有一个唯一的名称 `name`。比如可以创建三个 Group，缓存学生的成绩命名为 scores，缓存学生信息的命名为 info，缓存学生课程的命名为 courses。
+- 第二个属性是 `getter Getter`，即缓存未命中时获取源数据的回调(callback)。
+- 第三个属性是 `mainCache cache`，即一开始实现的并发缓存。
+- 构建函数 `NewGroup` 用来实例化 Group，并且将 group 存储在全局变量 `groups` 中。
+- `GetGroup` 用来特定名称的 Group，这里使用了只读锁 `RLock()`，因为不涉及任何冲突变量的写操作。
+
+### 3.3 Group 的 Get 方法
+
+接下来是 GeeCache 最为核心的方法 `Get`：
+
+```go
+// Get value for a key from cache
+func (g *Group) Get(key string) (ByteView, error) {
+	if key == "" {
+		return ByteView{}, fmt.Errorf("key is required")
+	}
+
+	if v, ok := g.mainCache.get(key); ok {
+		log.Println("[GeeCache] hit")
+		return v, nil
+	}
+
+	return g.load(key)
+}
+
+func (g *Group) load(key string) (value ByteView, err error) {
+	return g.getLocally(key)
+}
+
+func (g *Group) getLocally(key string) (ByteView, error) {
+	bytes, err := g.getter.Get(key)
+	if err != nil {
+		return ByteView{}, err
+
+	}
+	value := ByteView{b: cloneBytes(bytes)}
+	g.populateCache(key, value)
+	return value, nil
+}
+
+func (g *Group) populateCache(key string, value ByteView) {
+	g.mainCache.add(key, value)
+}
+```
+
+- Get 方法实现了上述所说的流程 ⑴ 和 ⑶。
+- 流程 ⑴ ：从 mainCache 中查找缓存，如果存在则返回缓存值。
+- 流程 ⑶ ：缓存不存在，则调用 load 方法，load 调用 getLocally（分布式场景下会调用 getFromPeer 从其他节点获取），getLocally 调用用户回调函数 `g.getter.Get()` 获取源数据，并且将源数据添加到缓存 mainCache 中（通过 populateCache 方法）
+
+至此，这一章节的单机并发缓存就已经完成了。
+
+## 4 测试
+
+可以写测试用例，也可以写 main 函数来测试这一章节实现的功能。那我们通过测试用例来看一下，如何使用我们实现的单机并发缓存吧。
+
+首先，用一个 map 模拟耗时的数据库。
+
+```go
+var db = map[string]string{
+	"Tom":  "630",
+	"Jack": "589",
+	"Sam":  "567",
+}
+```
+
+创建 group 实例，并测试 `Get` 方法
+
+```go
+func TestGet(t *testing.T) {
+	loadCounts := make(map[string]int, len(db))
+	gee := NewGroup("scores", 2<<10, GetterFunc(
+		func(key string) ([]byte, error) {
+			log.Println("[SlowDB] search key", key)
+			if v, ok := db[key]; ok {
+				if _, ok := loadCounts[key]; !ok {
+					loadCounts[key] = 0
+				}
+				loadCounts[key] += 1
+				return []byte(v), nil
+			}
+			return nil, fmt.Errorf("%s not exist", key)
+		}))
+
+	for k, v := range db {
+		if view, err := gee.Get(k); err != nil || view.String() != v {
+			t.Fatal("failed to get value of Tom")
+		} // load from callback function
+		if _, err := gee.Get(k); err != nil || loadCounts[k] > 1 {
+			t.Fatalf("cache %s miss", k)
+		} // cache hit
+	}
+
+	if view, err := gee.Get("unknown"); err == nil {
+		t.Fatalf("the value of unknow should be empty, but %s got", view)
+	}
+}
+```
+
+- 在这个测试用例中，我们主要测试了 2 种情况
+- 1）在缓存为空的情况下，能够通过回调函数获取到源数据。
+- 2）在缓存已经存在的情况下，是否直接从缓存中获取，为了实现这一点，使用 `loadCounts` 统计某个键调用回调函数的次数，如果次数大于1，则表示调用了多次回调函数，没有缓存。
+
+测试结果如下：
+
+```bash
+$ go test -run TestGet
+2020/02/11 22:07:31 [SlowDB] search key Sam
+2020/02/11 22:07:31 [GeeCache] hit
+2020/02/11 22:07:31 [SlowDB] search key Tom
+2020/02/11 22:07:31 [GeeCache] hit
+2020/02/11 22:07:31 [SlowDB] search key Jack
+2020/02/11 22:07:31 [GeeCache] hit
+2020/02/11 22:07:31 [SlowDB] search key unknown
+PASS
+ok      geecache        0.008s
+```
+
+可以很清晰地看到，缓存为空时，调用了回调函数，第二次访问时，则直接从缓存中读取。
+
+## 附 推荐阅读
+
+- [Go 语言简明教程 - 并发编程](https://geektutu.com/post/quick-golang.html#7-并发编程-goroutine)
+- [Go Test 单元测试简明教程](https://geektutu.com/post/quick-go-test.html)
+- [sync 官方文档 - golang.org](https://golang.org/pkg/sync/)
@@ -0,0 +1,254 @@
+---
+title: 动手写分布式缓存 - GeeCache第三天 HTTP 服务端
+date: 2020-02-12 22:00:00
+description: 7天用 Go语言/golang 从零实现分布式缓存 GeeCache 教程(7 days implement golang distributed cache from scratch tutorial)，动手写分布式缓存，参照 groupcache 的实现。本文介绍了如何使用标准库 http 搭建 HTTP Server，为 GeeCache 单机节点搭建 HTTP 服务，并进行相关的测试。
+tags:
+- Go
+nav: 从零实现
+categories:
+- 分布式缓存 - GeeCache
+keywords:
+- Go语言
+- 从零实现
+- 分布式缓存
+- HTTP Server
+image: post/geecache-day3/http_logo.jpg
+github: https://github.com/geektutu/7days-golang
+---
+
+![geecache http server](geecache-day3/http.jpg)
+
+本文是[7天用Go从零实现分布式缓存GeeCache](https://geektutu.com/post/geecache.html)的第三篇。
+
+- 介绍如何使用 Go 语言标准库 `http` 搭建 HTTP Server
+- 并实现 main 函数启动 HTTP Server 测试 API，**代码约60行**
+
+## 1 http 标准库
+
+Go 语言提供了 `http` 标准库，可以非常方便地搭建 HTTP 服务端和客户端。比如我们可以实现一个服务端，无论接收到什么请求，都返回字符串 "Hello World!"
+
+```go
+package main
+
+import (
+	"log"
+	"net/http"
+)
+
+type server int
+
+func (h *server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	log.Println(r.URL.Path)
+	w.Write([]byte("Hello World!"))
+}
+
+func main() {
+	var s server
+	http.ListenAndServe("localhost:9999", &s)
+}
+```
+
+- 创建任意类型 server，并实现 `ServeHTTP` 方法。
+- 调用 `http.ListenAndServe` 在 9999 端口启动 http 服务，处理请求的对象为 `s server`。
+
+接下来我们执行 `go run .` 启动服务，借助 curl 来测试效果：
+
+```bash
+$ curl http://localhost:9999  
+Hello World!
+$ curl http://localhost:9999/abc
+Hello World!
+```
+
+Go 程序日志输出
+
+```bash
+2020/02/11 22:56:32 /
+2020/02/11 22:56:34 /abc
+```
+
+> `http.ListenAndServe` 接收 2 个参数，第一个参数是服务启动的地址，第二个参数是 Handler，任何实现了 `ServeHTTP` 方法的对象都可以作为 HTTP 的 Handler。
+
+在标准库中，http.Handler 接口的定义如下：
+
+```go
+package http
+
+type Handler interface {
+    ServeHTTP(w ResponseWriter, r *Request)
+}
+```
+
+## 2 GeeCache HTTP 服务端
+
+分布式缓存需要实现节点间通信，建立基于 HTTP 的通信机制是比较常见和简单的做法。如果一个节点启动了 HTTP 服务，那么这个节点就可以被其他节点访问。今天我们就为单机节点搭建 HTTP Server。
+
+不与其他部分耦合，我们将这部分代码放在新的 `http.go` 文件中，当前的代码结构如下：
+
+```bash
+geecache/
+    |--lru/
+        |--lru.go  // lru 缓存淘汰策略
+    |--byteview.go // 缓存值的抽象与封装
+    |--cache.go    // 并发控制
+    |--geecache.go // 负责与外部交互，控制缓存存储和获取的主流程
+	|--http.go     // 提供被其他节点访问的能力(基于http)
+```
+
+首先我们创建一个结构体 `HTTPPool`，作为承载节点间 HTTP 通信的核心数据结构（包括服务端和客户端，今天只实现服务端）。
+
+[day3-http-server/geecache/http.go - github](https://github.com/geektutu/7days-golang/tree/master/gee-cache/day3-http-server/geecache)
+
+```go
+package geecache
+
+import (
+	"fmt"
+	"log"
+	"net/http"
+	"strings"
+)
+
+const defaultBasePath = "/_geecache/"
+
+// HTTPPool implements PeerPicker for a pool of HTTP peers.
+type HTTPPool struct {
+	// this peer's base URL, e.g. "https://example.net:8000"
+	self     string
+	basePath string
+}
+
+// NewHTTPPool initializes an HTTP pool of peers.
+func NewHTTPPool(self string) *HTTPPool {
+	return &HTTPPool{
+		self:     self,
+		basePath: defaultBasePath,
+	}
+}
+```
+
+- `HTTPPool` 只有 2 个参数，一个是 self，用来记录自己的地址，包括主机名/IP 和端口。
+- 另一个是 basePath，作为节点间通讯地址的前缀，默认是 `/_geecache/`，那么 http://example.com/_geecache/ 开头的请求，就用于节点间的访问。因为一个主机上还可能承载其他的服务，加一段 Path 是一个好习惯。比如，大部分网站的 API 接口，一般以 `/api` 作为前缀。
+
+接下来，实现最为核心的 `ServeHTTP` 方法。
+
+```go
+// Log info with server name
+func (p *HTTPPool) Log(format string, v ...interface{}) {
+	log.Printf("[Server %s] %s", p.self, fmt.Sprintf(format, v...))
+}
+
+// ServeHTTP handle all http requests
+func (p *HTTPPool) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	if !strings.HasPrefix(r.URL.Path, p.basePath) {
+		panic("HTTPPool serving unexpected path: " + r.URL.Path)
+	}
+	p.Log("%s %s", r.Method, r.URL.Path)
+	// /<basepath>/<groupname>/<key> required
+	parts := strings.SplitN(r.URL.Path[len(p.basePath):], "/", 2)
+	if len(parts) != 2 {
+		http.Error(w, "bad request", http.StatusBadRequest)
+		return
+	}
+
+	groupName := parts[0]
+	key := parts[1]
+
+	group := GetGroup(groupName)
+	if group == nil {
+		http.Error(w, "no such group: "+groupName, http.StatusNotFound)
+		return
+	}
+
+	view, err := group.Get(key)
+	if err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+
+	w.Header().Set("Content-Type", "application/octet-stream")
+	w.Write(view.ByteSlice())
+}
+```
+
+- ServeHTTP 的实现逻辑是比较简单的，首先判断访问路径的前缀是否是 `basePath`，不是返回错误。
+- 我们约定访问路径格式为 `/<basepath>/<groupname>/<key>`，通过 groupname 得到 group 实例，再使用 `group.Get(key)` 获取缓存数据。
+- 最终使用 `w.Write()` 将缓存值作为 httpResponse 的 body 返回。
+
+到这里，HTTP 服务端已经完整地实现了。接下来，我们将在单机上启动 HTTP 服务，使用 curl 进行测试。
+
+## 3 测试
+
+实现 main 函数，实例化 group，并启动 HTTP 服务。
+
+[day3-http-server/main.go - github](https://github.com/geektutu/7days-golang/tree/master/gee-cache/day3-http-server)
+
+```go
+package main
+
+import (
+	"fmt"
+	"geecache"
+	"log"
+	"net/http"
+)
+
+var db = map[string]string{
+	"Tom":  "630",
+	"Jack": "589",
+	"Sam":  "567",
+}
+
+func main() {
+	geecache.NewGroup("scores", 2<<10, geecache.GetterFunc(
+		func(key string) ([]byte, error) {
+			log.Println("[SlowDB] search key", key)
+			if v, ok := db[key]; ok {
+				return []byte(v), nil
+			}
+			return nil, fmt.Errorf("%s not exist", key)
+		}))
+
+	addr := "localhost:9999"
+	peers := geecache.NewHTTPPool(addr)
+	log.Println("geecache is running at", addr)
+	log.Fatal(http.ListenAndServe(addr, peers))
+}
+```
+
+- 同样地，我们使用 map 模拟了数据源 db。
+- 创建一个名为 scores 的 Group，若缓存为空，回调函数会从 db 中获取数据并返回。
+- 使用 http.ListenAndServe 在 9999 端口启动了 HTTP 服务。
+
+> 需要注意的点：
+> main.go 和 geecache/ 在同级目录，但 go modules 不再支持 import <相对路径>，相对路径需要在 go.mod 中声明：
+> require geecache v0.0.0
+> replace geecache => ./geecache
+
+接下来，运行 main 函数，使用 curl 做一些简单测试：
+
+```bash
+$ curl http://localhost:9999/_geecache/scores/Tom
+630
+$ curl http://localhost:9999/_geecache/scores/kkk
+kkk not exist
+```
+
+GeeCache 的日志输出如下：
+
+```bash
+2020/02/11 23:28:39 geecache is running at localhost:9999
+2020/02/11 23:29:08 [Server localhost:9999] GET /_geecache/scores/Tom
+2020/02/11 23:29:08 [SlowDB] search key Tom
+2020/02/11 23:29:16 [Server localhost:9999] GET /_geecache/scores/kkk
+2020/02/11 23:29:16 [SlowDB] search key kkk
+```
+
+节点间的相互通信不仅需要 HTTP 服务端，还需要 HTTP 客户端，这就是我们下一步需要做的事情。
+
+## 附 推荐阅读
+
+- [Go 语言简明教程](https://geektutu.com/post/quick-golang.html)
+- [Go Test 单元测试简明教程](https://geektutu.com/post/quick-go-test.html)
+- [Go http.Handler 基础](https://geektutu.com/post/gee-day1.html)
+- [http 官方文档 - golang.org](https://golang.org/pkg/http)
@@ -59,8 +59,8 @@ github: https://github.com/geektutu/7days-golang
 ## 3 目录

 - [第一天：LRU 缓存淘汰策略](https://geektutu.com/post/geecache-day1.html) | [Code - Github](https://github.com/geektutu/7days-golang/blob/master/gee-cache/day1-lru)
- 第二天：单机并发缓存 | [Code - Github](https://github.com/geektutu/7days-golang/blob/master/gee-cache/day2-single-node)
- 第三天：HTTP 服务端 | [Code - Github](https://github.com/geektutu/7days-golang/blob/master/gee-cache/day3-http-server)
+- [第二天：单机并发缓存](https://geektutu.com/post/geecache-day2.html) | [Code - Github](https://github.com/geektutu/7days-golang/blob/master/gee-cache/day2-single-node)
+- [第三天：HTTP 服务端](https://geektutu.com/post/geecache-day3.html) | [Code - Github](https://github.com/geektutu/7days-golang/blob/master/gee-cache/day3-http-server)
 - 第四天：一致性哈希(Hash) | [Code - Github](https://github.com/geektutu/7days-golang/blob/master/gee-cache/day4-consistent-hash)
 - 第五天：分布式节点 | [Code - Github](https://github.com/geektutu/7days-golang/blob/master/gee-cache/day5-multi-nodes)
 - 第六天：防止缓存击穿 | [Code - Github](https://github.com/geektutu/7days-golang/blob/master/gee-cache/day6-single-flight)