Goの共通モジュール管理の方法をまとめてみた（Go1.18で導入されたWorkspaceも）

Gitで共通モジュールを管理して使う場面

中くらいの規模感があるサービスであれば、モノリシックに作っていた環境から徐々にサービスを分割していくことがあると思いますので、その際に似たような処理が必要になる場面があるかと思います。
その時に同じ処理を作る、というのは渋いなぁといった時などに有効です。
例えばRDBへのReadアクセスのみ別サーバーから提供したい場合、Queryだけ叩ければいいのでスキーマは同一のものを使いたい、とかそんな感じ時に使用します。

新しく導入されたWorkspace機能

今までのGo共通モジュール管理の課題

管理方法として、PluginとGitの管理の2つがありましたが、多くの場面ではGitの管理方法が使われているかと思います。
その際に問題となるのは、共通モジュールを修正後、修正したものを一旦ローカルで組み込んでテストすることができない、に尽きると思います。
どういうことかというと、go.modでは依存パッケージの管理をしていますが、その対象パッケージをリリースタグベースでしか管理できないところです。

Git管理のセクションで取り扱ったgo.modを確認するとわかりますが、ハッシュ値が用いられています

module multi_modules

go 1.17

require github.com/y-saiki1/gitmodules v0.0.0-20220401161211-c7093e33520b

このv0.0.0-20220401161211-c7093e33520bを見るとわかるように、go getで取得するパッケージはバージョンを指定しないとデフォルトブランチの最新の状態のものを取得します。
多くの場合、リリースタグを切って管理されているかと思いますので、バージョン管理している場合はここがgithub.com/y-saiki1/gitmodules v1.0.1のようになります。

これの何が問題なのかというと

1. Aプロジェクトで必要になった機能を、共通モジュール側に用意する。この際、変更前の共通モジュールはv1.0.0とします。
2. 共通モジュールを修正したので、確認のためのテストを共通モジュール側に用意してテスト
3. その後、共通モジュールのリポジトリにコミット
4. コミットをレビューしてもらい、マージされる
5. マージ後、リリースタグをv1.0.1で切る
6. Aプロジェクト側で共通モジュールのバージョンをv1.0.1に上げる

という手順が必要になります。
素直な意見として、長い！長すぎる！レビュー待ちが発生してしまうのはこれは良くない、そう考えるのが普通です。
せめてローカルでもサクッと共有したいじゃないですか。でなければ開発効率が落ちてしまいます。
かと言って自分で勝手にマージしてリリースするわけにもいかないので、どうすればいいのか、それはreplaceディレクティブを使うことで解決します。（まだWorkspaceは出てきません。）
簡単に説明すると、これです。

replace github.com/y-saiki1/gitmodules v0.0.0-20220401161211-c7093e33520b => ../gitmodules

参照している共通モジュールをローカルのディレクトリに直結することができます。
これでレビュー待ちやむやみなリリースタグを切ることは無くなりました。
が、さらに問題が発生します。
go.modを編集しているため、go.modそのものの変更がコミットに紛れ込んでしまう可能性と、どの状態の共通モジュールを参照して作った機能なのかわからなくなるといった問題です。
チームで開発していると、Aプロジェクトのソースコードと共通モジュールを新しくいじったAさんの手元では動いているが、Bさんが新しく作った機能のほうでは動かない…なんてことが起こり得ます。
実際Aさんがローカルでの動作確認だけして、共通モジュールのコミット忘れ・レビュー待ちで止まっている状態で、Aプロジェクトの方のコミットはマージされてしまったということがあり得ます（これはちゃんとテストが稼働していればAプロジェクトはCI上のテストで共通モジュールの古いバージョンを参照するため、テストが落ちる＝マージされないので防げますが）
またreplaceディレクティブを使うことで、その人のローカル環境のディレクトリ構造に依存しますので、もしディレクトリ構成が違えば、共通モジュールのパス先も変わりますので、このreplaceディレクティブはコミットすべきではないと思います。
そうなるとコミットにgo.modの変更が適切に行われているかレビューでしっかりみなければいけないので、大変です。

このことから、共通モジュールはreplaceディレクティブで手軽に管理できる一方、go.modの変更を手動で監視する必要があるので、課題となっていました。

Workspaceについて

Workspaceはgitで管理されている共通モジュールのimportをローカルのディレクトリに差し替えることが可能になります。
この機能はreplaceディレクティブと解決できるポイントは同じですが、go.modに何か手を加える必要がない点で違います。
go1.18のworkspaceの使い方についてはこちら

~/ $ mkdir workspace
~/ $ cd workspace
~/workspace $ 
~/workspace $ touch docker-compose.yml
~/workspace $ touch Dockerfile
~/workspace $ mkdir go-service # サービスコードを置くところ
~/workspace $ mkdir gopkg # 共通モジュール配置先

version: '3.6'

services:
  workspace:
    build: 
      context: .
      dockerfile: ./Dockerfile
    volumes:
      - ./:/go/src
    tty: true

FROM golang:1.18.0-alpine3.15
WORKDIR /go/src
RUN apk update && \
    apk add bash git

~/workspace $ tree
.
├── Dockerfile
├── docker-compose.yml
├── gopkg
└── go-service
~/workspace $ docker compose up -d

~/workspace $ docker compose exec workspace bash
# ↓ここからコンテナ内
/go/src $ cd go-service
# ↓公開するソースコードでなければ適当なmod名でおkです
/go/src/go-service $ go mod init go-service
/go/src/go-service $ cd ../
/go/src $ cd gopkg
# ↓公開するソースコードの方は以下の形式で。githubリポジトリはまだ作成しなくてもいいので、リポジトリ名と同じにしておいてください
/go/src/gopkg $ go mod init github.com/y-saiki1/gopkg

package gopkg

import "fmt"

func Run() {
	fmt.Println("Hello From MY Go PKG")
}

~/workspace/gopkg $ git init
# ↓自分で用意したリポジトリ名に替えてください
~/workspace/gopkg $ git remote add origin [email protected]:y-saiki1/gopkg.git
~/workspace/gopkg $ git add .
~/workspace/gopkg $ git commit -m 'first commit'
~/workspace/gopkg $ git push origin master

~/workspace/ $ docker compose exec workspace bash
# ここからコンテナ内
/go/src/ $ cd go-service
/go/src/ $ go get github.com/y-saiki1/gopkg

~/workspace/ $ docker compose exec workspace go work init ./go-service ./gopkg

go 1.18

use (
	./go-service1
	./gopkg
)

package main

import (
	// 以下追加（ここは自分のリポジトリに読み替えてください）
	"github.com/y-saiki1/gopkg"
)

func main() {
	gopkg.Run()
}

~/workspace/ $ docker compose exec workspace go run go-service
Hello From MY Go PKG

package gopkg

import "fmt"

func Run() {
	fmt.Println("共通モジュールからHello")
}

~/workspace/ $ docker compose exec workspace go run go-service
共通モジュールからHello

~/workspace/ $ docker compose exec workspace bash
# ここからコンテナ内
/go/src $ cd go-service
/go/src/go-service $ go run main.go
共通モジュールからHello