"go-redis"で、Go＋Redis連携による「Pub/Sub」機能で、コンテキストを用いよ うとしても「Publish」「Subscribe」でエラーとなる。

Question

ご覧いただきありがとうございます。

Goパッケージの「go-redis」およびコンテキストにつきまして、初歩的な質問である
ことをご容赦ください。

Go言語とRedisを連携した、Pub/Sub機能を学習しています。

ぜひともアドバイスをよろしくお願いいたします。

問題点・実現したいこと

問題点

"go-redis"の「Pub/Sub」機能で、コンテキストを用いようとしても
「Publish」「Subscribe」でエラーが発生してなかなか解決できないです。

• Publishを用いた場合では「(コンテキストを指して)引数が多すぎる」というエラー。
• Subscribeを用いた場合では「コンテキストの変数が文字列として入っている」というエラー。

「import context」と「ctx := context.Background()」をコメント
アウトして、Contextを使わずにPublish、Subscribeすると動くようになります。

実現したいこと＆前提

実現したいことは「Redis <-> Go言語」同士の通信で、Publish(メッセージ配信)
とSubscribe(メッセージ受信)のやり取りを確認したいことです。

今回は、VirtualBoxのローカルだけでGo＋Redisを連携させるという条件で
話させていただきます。

---

(2021/07/19) 解決しました。

ご指摘通り、go mod で「go-redis」のバージョンが何故か6点台になっていたので、
go mod で最新バージョンを取得して解決しました。
コンテキストが必要なのは「go-redis」のv8からでした。

---

参考にしている資料

①　Redis as a Pub/Sub Engine in Go
https://itnext.io/redis-as-a-pub-sub-engine-in-go-10eb5e6699cc

②　How to ensure redis subscriber receive message in Go (Golang)?
https://stackoverflow.com/questions/41197200/how-to-ensure-redis-subscriber-receive-message-in-go-golang

---

発生している問題・エラーメッセージ

上記の「参考にしている資料」では、「ctx := context.Background()」
でコンテキストを初期化して、「context.WithCancel」などをしなくても
動くという内容でした。

ところが、実際にソースに書き込んで、Publish、Subscribeしようとしても
下記①と②のパターンでエラーになってしまいます。

①　Publish(メッセージ配信)の場合

too many arguments in call to redisClient.cmdable.Publish

go-redisのドキュメントではPublishメソッドは、コンテキストを引数と
して定義されています。
https://pkg.go.dev/github.com/go-redis/redis/v8#Client.Publish

Subscribe(メッセージ受信)の場合

cannot use ctx (type context.Context) as type string in argument to redisClient.Subscribe

go-redisのドキュメントでは、Subscribeメソッドも、コンテキストを引数と
して定義されています。
https://pkg.go.dev/github.com/go-redis/redis/v8#Client.Subscribe

---

試したこと

「import context」と「ctx := context.Background()」をコメント
アウトして、Contextを使わずにPublish、Subscribeすると動くようになります。

---

該当のソースコード

① Publish(メッセージ配信)の場合 (pub.go)

package main 

import (
	"fmt"
	"time"
	"context"
	"github.com/go-redis/redis"
)

//go-redisのクライアント型
var redisClient *redis.Client

/** 
redis-serverに接続 
*/
func init() {
    redisClient = redis.NewClient(&redis.Options{
		Addr:     "localhost:6379",
		Password: "",
		DB:       0,
	})
}

/** 
メイン処理　
Redisチャンネル「targetHoge」に向かってPublish(メッセージ配信)する処理
*/
func main (){

	//pingを打って接続できたかを確認する
	pong, err := redisClient.Ping().Result()
	fmt.Println(pong, err)
	 if err !=nil {
		fmt.Println("err", err);
	 } else {
		fmt.Println("ping OK : " + pong);
	 }
	
	//------------------------【今回問題になっているコンテキストの初期化】
	var ctx = context.Background()
	rderr := redisClient.Publish(ctx, "targetHoge", time.Now()).Err()
	 if rderr !=nil {
		panic(err)
	 } else {
		fmt.Println("Publish OK : ");
	 }

}

② Publish(メッセージ配信)の場合 (sub.go)

package main 

import (
	"fmt"
	"context"
	"github.com/go-redis/redis"
)

//go-redisのクライアント型
var redisClient *redis.Client

/** 
redis-serverに接続 
*/
func init() {
    redisClient = redis.NewClient(&redis.Options{
		Addr:     "localhost:6379",
		Password: "",
		DB:       0,
	})
}

/** 
メイン処理　
Redisチャンネル「targetHoge」から、Subscribe(メッセージ受信)する処理
*/
func main (){

	//pingを打って接続できたかを確認する
	pong, err := redisClient.Ping().Result()
	fmt.Println(pong, err)
	 if err !=nil {
		fmt.Println("err", err);
	 } else {
		fmt.Println("ping OK : " + pong);
	 }
	
	//------------------------【【今回問題になっているコンテキストの初期化】
	var ctx = context.Background()

	// チャンネル「targetHoge」のオープン
	topic := redisClient.Subscribe(ctx, "targetHoge")
	// チャンネル「targetHoge」からの送信待ち
	channel := topic.Channel()
	// 受信したメッセージの出力
	for msg := range channel {
		fmt.Println(msg)
	}

---

補足情報（FW/ツールのバージョンなど）

Goのパッケージ「go-redis」はV8 (https://github.com/go-redis/redis)
Oracle VritualBox 6.1.22
Rocky Linux release 8.4 (Green Obsidian)
go version go1.16.6 linux/amd64
Redis server v=6.2.4
redis-cli 6.2.4

Answer 1

go.modの中にあるgithub.com/go-redis/redisのバージョンを確認しましょう。
V7以下の場合、context.Context引数がありません。

その場合、以下のコマンドでバージョンを最新に引き上げてみてください。

go get github.com/go-redis/redis@latest

（他の依存ライブラリがgo-redis@v7を要求している場合、v8にならない場合がありますが）

Comments

[tamahimesama_23]

ご指摘通り、go.modを調べたらなぜかv6で展開されてしまっていたので、
`go mod init github.com/go-redis/redis@latest`で初期化して
`go get github.com/go-redis/redis/v8`で最新化できて、今回の問題が解決できました。
お忙しい中のご回答、ありがとうございました。