✨ add redis hashtable sample

Author: yuanyu90221

.github/workflows/go.yml

@@ -0,0 +1,28 @@
+name: Go
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup go-task
+        uses: pnorton5432/setup-task@v1
+        with:
+          task-version: 3.29.1
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 'stable'
+          check-latest: true
+      - name: Task Build for mage
+        run: task build-gg
+      - name: Test with gg build
+        run: ./gg build

.gitignore

@@ -0,0 +1,29 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env
+mage
+gg
+bin
+data

Makefile

@@ -0,0 +1,18 @@
+.PHONY=build
+include .env
+export $(shell sed 's/=.*//' .env)
+build:
+	@CGO_ENABLED=0 GOOS=linux go build -o bin/main cmd/main.go
+
+run: build
+	@./bin/main
+
+
+coverage:
+	@go test -v -cover ./...
+
+test:
+	@go test -v ./...
+
+redis-compose:
+	@sudo docker compose up -d

README.md

@@ -0,0 +1,70 @@
+# golang-sample-with-redis
+
+This repository for practice use redis with golang
+
+## redis hashtable sample
+
+```golang
+package main
+
+import (
+	"context"
+	"fmt"
+	"log/slog"
+	"os"
+
+	"github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/config"
+	"github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/logger"
+	myredis "github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/redis"
+	"github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/util"
+	"github.com/redis/go-redis/v9"
+)
+
+func main() {
+	jsonLogger := slog.New(slog.NewJSONHandler(
+		os.Stdout, &slog.HandlerOptions{
+			AddSource: true,
+		},
+	))
+	ctx := logger.CtxWithLogger(context.Background(), jsonLogger)
+	config.Init(ctx)
+	redisURL := config.AppCfg.RedisUrl
+	rdb, err := myredis.New(redisURL)
+	if err != nil {
+		util.FailOnError(ctx, err, fmt.Sprintf("failed to connect to %s\n", redisURL))
+	}
+	defer rdb.Close()
+	_, err = rdb.Ping(ctx)
+	if err != nil {
+		util.FailOnError(ctx, err, fmt.Sprintf("failed to ping to %s\n", redisURL))
+	}
+  // 建立　struct
+	var rh1 = RedisHash{
+		Name:   "eddie",
+		ID:     123,
+		Online: true,
+	}
+  // 透過 pipeline 方式一次批量設定 hashtable
+	rdb.Pipelined(ctx, func(pipe redis.Pipeliner) error {
+		pipe.HSet(ctx, "rh1", "name", rh1.Name)
+		pipe.HSet(ctx, "rh1", "id", rh1.ID)
+		pipe.HSet(ctx, "rh1", "online", rh1.Online)
+		return nil
+	})
+	var rh2 RedisHash
+  // 採用　hash read 的方式一次讀取整個　hashtable 相關的 key 的整個結構
+	err = rdb.HGetAll(ctx, "rh1").Scan(&rh2)
+	if err != nil {
+		util.FailOnError(ctx, err, "failed on scan rh2")
+	}
+	jsonLogger.Info("hash sample", slog.Any("rh2", rh2))
+}
+
+// RedisHash struct for handle
+type RedisHash struct {
+	Name   string `redis:"name"`
+	ID     int32  `redis:"id"`
+	Online bool   `redis:"online"`
+}
+
+```

Taskfile.yml

@@ -0,0 +1,40 @@
+version: '3'
+
+tasks:
+  default:
+    cmds:
+      - echo "This is task cmd"
+    silent: true
+  
+  # build:
+  #   cmds:
+  #     - CGO_ENABLED=0 GOOS=linux go build -o bin/main cmd/main.go
+  #   silent: true
+  # run:
+  #   cmds:
+  #     - ./bin/main
+  #   deps:
+  #     - build
+  #   silent: true
+
+  build-mage:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o ./mage mage-tools/mage.go
+    silent: true
+  
+  build-gg:
+    cmds:
+      - ./mage -d mage-tools -compile ../gg
+    deps:
+      - build-mage
+    silent: true
+
+  coverage:
+    cmds:
+      - go test -v -cover ./...
+    silent: true
+  test:
+    cmds:
+      - go test -v ./...
+    silent: true
+  

cmd/basic-sample/main.go

@@ -0,0 +1,52 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"log/slog"
+	"os"
+
+	"github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/config"
+	"github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/logger"
+	myredis "github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/redis"
+	"github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/util"
+	"github.com/redis/go-redis/v9"
+)
+
+func main() {
+	jsonLogger := slog.New(slog.NewJSONHandler(
+		os.Stdout, &slog.HandlerOptions{
+			AddSource: true,
+		},
+	))
+	ctx := logger.CtxWithLogger(context.Background(), jsonLogger)
+	config.Init(ctx)
+	redisURL := config.AppCfg.RedisUrl
+	rdb, err := myredis.New(redisURL)
+	if err != nil {
+		util.FailOnError(ctx, err, fmt.Sprintf("failed to connect to %s\n", redisURL))
+	}
+	defer rdb.Close()
+	_, err = rdb.Ping(ctx)
+	if err != nil {
+		util.FailOnError(ctx, err, fmt.Sprintf("failed to ping to %s\n", redisURL))
+	}
+	err = rdb.Set(ctx, "key1", "value1", 0)
+	if err != nil {
+		util.FailOnError(ctx, err, "failed to set key1")
+	}
+	res, err := rdb.Get(ctx, "key1")
+	if err != nil {
+		jsonLogger.Error("failed to get key1")
+	} else {
+		jsonLogger.Info("result get", slog.Any("res", res))
+	}
+	_, err = rdb.Get(ctx, "key2")
+	if err != nil {
+		if err == redis.Nil {
+			jsonLogger.Error("key2 does not exists")
+		} else {
+			jsonLogger.Error("err", slog.Any("err", err))
+		}
+	}
+}

cmd/hash-sample/main.go

@@ -0,0 +1,58 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"log/slog"
+	"os"
+
+	"github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/config"
+	"github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/logger"
+	myredis "github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/redis"
+	"github.com/leetcode-golang-classroom/golang-sample-with-redis/internal/util"
+	"github.com/redis/go-redis/v9"
+)
+
+func main() {
+	jsonLogger := slog.New(slog.NewJSONHandler(
+		os.Stdout, &slog.HandlerOptions{
+			AddSource: true,
+		},
+	))
+	ctx := logger.CtxWithLogger(context.Background(), jsonLogger)
+	config.Init(ctx)
+	redisURL := config.AppCfg.RedisUrl
+	rdb, err := myredis.New(redisURL)
+	if err != nil {
+		util.FailOnError(ctx, err, fmt.Sprintf("failed to connect to %s\n", redisURL))
+	}
+	defer rdb.Close()
+	_, err = rdb.Ping(ctx)
+	if err != nil {
+		util.FailOnError(ctx, err, fmt.Sprintf("failed to ping to %s\n", redisURL))
+	}
+	var rh1 = RedisHash{
+		Name:   "eddie",
+		ID:     123,
+		Online: true,
+	}
+	rdb.Pipelined(ctx, func(pipe redis.Pipeliner) error {
+		pipe.HSet(ctx, "rh1", "name", rh1.Name)
+		pipe.HSet(ctx, "rh1", "id", rh1.ID)
+		pipe.HSet(ctx, "rh1", "online", rh1.Online)
+		return nil
+	})
+	var rh2 RedisHash
+	err = rdb.HGetAll(ctx, "rh1").Scan(&rh2)
+	if err != nil {
+		util.FailOnError(ctx, err, "failed on scan rh2")
+	}
+	jsonLogger.Info("hash sample", slog.Any("rh2", rh2))
+}
+
+// RedisHash struct for handle
+type RedisHash struct {
+	Name   string `redis:"name"`
+	ID     int32  `redis:"id"`
+	Online bool   `redis:"online"`
+}

docker-compose.yml

@@ -0,0 +1,18 @@
+services:
+  redis:
+    build:
+      context: .
+      dockerfile: ./redis-dockerfile
+    container_name: sample-redis
+    restart: always
+    ports:
+      - ${REDIS_PORT}:6379
+    volumes:
+      - ./data:/data
+    environment:
+      - REDIS_PASSWORD=${REDIS_PASSWORD}
+      - REDIS_PORT=${REDIS_PORT}
+
+networks:
+  sample-redis:
+    driver: bridge

go.mod

@@ -0,0 +1,28 @@
+module github.com/leetcode-golang-classroom/golang-sample-with-redis
+
+go 1.24.0
+
+require (
+	github.com/magefile/mage v1.15.0
+	github.com/redis/go-redis/v9 v9.7.3
+	github.com/spf13/viper v1.20.1
+)
+
+require (
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
+	github.com/fsnotify/fsnotify v1.8.0 // indirect
+	github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.3 // indirect
+	github.com/sagikazarmark/locafero v0.7.0 // indirect
+	github.com/sourcegraph/conc v0.3.0 // indirect
+	github.com/spf13/afero v1.12.0 // indirect
+	github.com/spf13/cast v1.7.1 // indirect
+	github.com/spf13/pflag v1.0.6 // indirect
+	github.com/subosito/gotenv v1.6.0 // indirect
+	go.uber.org/atomic v1.9.0 // indirect
+	go.uber.org/multierr v1.9.0 // indirect
+	golang.org/x/sys v0.29.0 // indirect
+	golang.org/x/text v0.21.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)