keitakn/golang-grpc-server

GoでgRPCを実装する時のサンプルコード

Hi 👋, I'm keitakn

A passionate frontend developer from Tokyo

• 📄 Know about my experiences https://github.com/keitakn/cv

Blogs posts

• pytestでLLMプロダクトをLLMで評価するLLM-as-a-Judgeをやってみた
• OpenAI Streaming + Function callingの並列実行に対応する
• PlanetScale APIを使ってDBテストを高速化した
• Python + FastAPIでオニオンアーキテクチャ（簡易版）
• VercelのアプリケーションにCloudflareで購入した独自ドメインを設定する
• 【個人開発】猫のLGTM画像共有サービス、LGTMeowのデザインリニューアル + 多言語対応
• エンジニアにとって重要な能力は言語化だと思う

Connect with me:

Languages and Tools:

golang-grpc-server's Issues

gRPCサーバーに認証を設定する

Doneの定義

• gRPCサーバーにアクセスする際に認証が必要になっている事

プロジェクトの雛形を追加する

Doneの定義

• 開発を始める上で最低限必要となるコードがコミットされている事（Dockerfileなど）

ベースイメージをGo 1.14に変更

Doneの定義

• DockerfileのベースイメージがGo 1.14に変更されている事
• 前と同じようにアプリケーションの正常動作を確認出来ている事

ディレクトリ構成をGo標準の物に合わせる

Doneの定義

• 補足情報の記事を参考にディレクトリ構成がリファクタリングされている事

gRPCのインターフェースなど外部公開が必要な物やgrpcサーバーとgrpc-serverの2つのエンドポイントを持つようになったので、一度ディレクトリ構成を整理する。

補足情報

https://techdo.mediado.jp/entry/2019/01/18/112503

Goのバージョンを1.15の最新に変更する

ディレクトリ構成をもう少しシンプルな構成に変更する

サーバーとClientでGitリポジトリを分割する

Doneの定義

• gRPCのClient側、サーバー側でGitHubのリポジトリが分かれている事

補足

そもそもgRPCにサーバー側とかClient側とかいう概念はないが、サンプルコードの役割として名前付けしてあったほうが分かりやすい。

あと同じ .proto ファイルを読み込む必要があるので、リポジトリが分かれている場合でもそれが出来るかどうか試すという意味もある。

Go protocol-buffersのバージョンをv2に変更する

Doneの定義

• github.com/golang/protobuf が google.golang.org/protobuf に変更されている事
• 今まで通り .proto からGoのインターフェースが生成出来る事

参考情報

https://blog.golang.org/a-new-go-api-for-protocol-buffers

gRPCサーバーのアプリケーションログを出力するように改修する

Doneの定義

• ログがJSON形式で出力されている事

補足情報

サンプルとは言え、ログの内容に関してはデバッグが出来るだけの最低限の情報は入れておく。

ホットリロードツールをcosmtrek/airに変更する

Doneの定義

• こちらの記事 で紹介されている通り cosmtrek/air を利用するように変更されている事

補足情報

以下と同じように対応すれば問題なさそう。

nekochans/kimono-app-api#9

realize（が依存しているurfave/cli）のgo getの失敗を回避

Doneの定義

• realize のgo getに成功する事

変更点概要

./scripts/docker-compose-up.sh を走らせると下記のようなエラーが出る。

go get: gopkg.in/urfave/[email protected]: parsing go.mod:
	module declares its path as: github.com/urfave/cli/v2
	        but was required as: gopkg.in/urfave/cli.v2

こちらは oxequa/realize/issues/269 に記載の通り GO111MODULE=off go get github.com/oxequa/realizeとすることで回避できる。

また、oxequa/realize/issues/253, nekochans/portfolio-backend/issues/11 で議論されていた回避策は現時点ではもう必要ないようなので削除。

go get gopkg.in/urfave/cli.v2@master && \

技術的変更点概要

[hiroshi@MacBook-Pro]# git diff           [/Users/hiroshi/Development/src/github.com/itohiro73/golang-grpc-server]
diff --git a/build/package/docker/grpc/Dockerfile b/build/package/docker/grpc/Dockerfile
index b685317..188289c 100644
--- a/build/package/docker/grpc/Dockerfile
+++ b/build/package/docker/grpc/Dockerfile
@@ -29,8 +29,7 @@ COPY . .
 
 RUN set -eux && \
   go build -o golang-grpc-server ./cmd/grpc/main.go && \
-  go get gopkg.in/urfave/cli.v2@master && \
-  go get github.com/oxequa/realize && \
+  GO111MODULE=off go get github.com/oxequa/realize && \
   go get -u github.com/go-delve/delve/cmd/dlv && \
   go build -o /go/bin/dlv github.com/go-delve/delve/cmd/dlv

gRPC用のヘルスチェックメソッドを実装する

Doneの定義

• gRPC用のヘルスチェックメソッドが以下の要件で実施されている事

要件

• ヘルスチェックメソッドは認証・認可が不要になっている事
• ALBからヘルスチェックが出来るように工夫されている事

Kubernetes用のマニフェストファイルを追加する

Doneの定義

• Kubernetes用のマニフェストファイルが作成されている事
• EKS上で動作確認が完了している事

gRPCで相互通信出来る最小構成のサンプルコードを追加する

Doneの定義

• 2つのgRPCサーバーが構築され、その2つが相互通信出来る状態になっている事

補足情報

Dockerfileの

golang-grpc-server/Dockerfile

Line 25 in 046c8ca

chown -R go:go /app/grpc-server

の部分が間違っているのでついでに修正する。