Merge pull request #806 from devlights/add-singleflight-example

Author: devlights

examples/singleapp/singleflight/.gitignore

@@ -0,0 +1 @@
+app

examples/singleapp/singleflight/README.md

@@ -0,0 +1,28 @@
+# これは何？
+
+```golang.org/x/sync/singleflight``` のサンプルです。
+
+singleflightパッケージは、重複した関数呼び出しを抑制するためのメカニズムを提供します。
+
+このパッケージは、特に高価な操作や重複する操作が同時に複数のゴルーチンから要求される場合に有効です。
+
+singleflightパッケージは、golang.org/x/sync/singleflightライブラリに含まれており、主に以下の機能を提供します。
+
+- 重複呼び出しの抑制：同じキーに対する複数のリクエストが同時に発生した場合、最初のリクエストが完了するまで他のリクエストを待機させ、結果を共有します。
+- 効率の向上：重複した操作を防ぐことで、サービスやデータベースへの不要な負荷を軽減します。
+- シンプルなAPI：Group型を使用して、重複する操作を管理します。
+
+Cache Stampedeなどが発生する可能性がある部分などで利用出来ます。
+
+```Group.Forget()``` が存在するのがちょっとした違い。
+
+## 参考情報
+
+- https://pkg.go.dev/golang.org/x/sync/singleflight
+- https://twitter.com/func25/status/1778770235316916427?t=39VDEN8c8WFp9fc-JGBABA&s=19
+- https://zenn.dev/nkmrkz/articles/go-singleflight
+- https://christina04.hatenablog.com/entry/go-singleflight
+- https://pkg.go.dev/sync@go1.22.3#OnceValue
+- https://cs.opensource.google/go/x/sync/+/refs/tags/v0.7.0:singleflight/singleflight.go
+- https://blog.wu-boy.com/2024/02/how-to-reslove-the-hotspot-invalid-using-singleflight-en/
+- https://www.codingexplorations.com/blog/understanding-singleflight-in-golang-a-solution-for-eliminating-redundant-work

examples/singleapp/singleflight/Taskfile.yml

@@ -0,0 +1,15 @@
+# https://taskfile.dev
+
+version: '3'
+
+tasks:
+  default:
+    cmds:
+      - task: build
+      - task: run
+  build:
+    cmds:
+      - go build -o app{{.exeEXT}}
+  run:
+    cmds:
+      - ./app{{.exeEXT}}

examples/singleapp/singleflight/main.go

@@ -0,0 +1,102 @@
+package main
+
+import (
+	"log"
+	"sync"
+	"time"
+
+	"golang.org/x/sync/singleflight"
+)
+
+func init() {
+	log.SetFlags(0)
+}
+
+func heavy(delay time.Duration, prefix string) {
+	log.Printf("%s start", prefix)
+	defer log.Printf("%s end  ", prefix)
+
+	time.Sleep(delay)
+}
+
+func main() {
+	// Group.Do() or Group.DoChan() を利用して
+	// 重複する呼び出しが発生する箇所や処理負荷が高い操作などの呼び出しを
+	// 抑制することが出来る。
+	//
+	// Cache Stampedeが発生する可能性がある部分には非常に有効です。
+
+	const (
+		KEY = "FUNC-GROUP-KEY"
+	)
+
+	var (
+		grp     = &singleflight.Group{}
+		ready   = make(chan struct{})
+		results = make(chan (<-chan singleflight.Result))
+		wg      = sync.WaitGroup{}
+	)
+
+	wg.Add(3)
+	go func() {
+		defer wg.Done()
+
+		results <- grp.DoChan(KEY, func() (any, error) {
+			<-ready
+			heavy(3*time.Second, "func1")
+			return "func1", nil
+		})
+	}()
+	go func() {
+		defer wg.Done()
+
+		results <- grp.DoChan(KEY, func() (any, error) {
+			<-ready
+			heavy(1*time.Second, "func2")
+			return "func2", nil
+		})
+	}()
+	go func() {
+		defer wg.Done()
+
+		results <- grp.DoChan(KEY, func() (any, error) {
+			<-ready
+			heavy(2*time.Second, "func3")
+			return "func3", nil
+		})
+	}()
+	go func() {
+		defer close(results)
+		wg.Wait()
+	}()
+
+	// よーいドン
+	close(ready)
+
+	for ret := range results {
+		log.Printf("%+v", <-ret)
+	}
+
+	// 更に追加呼び出し
+	//   ただし、実行する前に Group.Forget() を呼び出して
+	//   キーに紐づく結果を忘れさせてから実行
+	grp.Forget(KEY)
+	ret := grp.DoChan(KEY, func() (any, error) {
+		heavy(1*time.Second, "func4")
+		return "func4", nil
+	})
+	log.Printf("%+v", <-ret)
+
+	/*
+	   task: [build] go build -o app
+	   task: [run] ./app
+	   func2 start
+	   func2 end
+	   {Val:func2 Err:<nil> Shared:true}
+	   {Val:func2 Err:<nil> Shared:true}
+	   {Val:func2 Err:<nil> Shared:true}
+	   func4 start
+	   func4 end
+	   {Val:func4 Err:<nil> Shared:false}
+	*/
+}