ハッカソンなど短期間でWebアプリを開発する際のバックエンドのGo実装例です。 学習コストと開発コストを抑えることを目的としています。
-
レポジトリを作成したら、モジュール名(現
go-backend-template
)を適宜変更してください。 -
最低限DockerとDocker Composeが必要です。
- Compose Watchを使うため、Docker Composeのバージョンは2.22以上にしてください。
-
linter, formatterにはgolangci-lintを使っています。
- VSCodeを使用する場合は
.vscode/settings.json
でlinterの設定を行ってください
{ "go.lintTool": "golangci-lint" }
- VSCodeを使用する場合は
-
makeコマンドのターゲット一覧とその説明は
make help
で確認できます
docker compose watch
API、DB、DB管理画面が起動します。 各コンテナが起動したら、以下のURLにアクセスすることができます。 Compose Watchにより、ソースコードの変更を検知して自動で再起動します。
- http://localhost:8080/ (API)
- http://localhost:8081/ (DBの管理画面)
全てのテスト
make test
単体テストのみ
make test-unit
結合テストのみ
make test-integration
main.go
: エントリーポイント- 依存ライブラリの初期化など最低限の処理のみを書く
- ルーティングの設定は
./internal/handler/handler.go
に書く - 肥大化しそうなら
./internal/infrastructure/{pkgname}
を作って外部ライブラリの初期化処理を書くのもアリ
internal/
: アプリ本体の主実装- Tips: Goの仕様で
internal
パッケージは他プロジェクトから参照できない (https://go.dev/doc/go1.4#internalpackages) handler/
: ルーティング- 飛んできたリクエストを裁いてレスポンスを生成する
- DBアクセスは
repository/
で実装したメソッドを呼び出す - Tips: リクエストのバリデーションがしたい場合は↓のどちらかを使うと良い
- go-playground/validatorでタグベースのバリデーションをする
- go-ozzo/ozzo-validationでコードベースのバリデーションをする
migration/
: DBマイグレーション- DBのスキーマを定義する
- Tips: マイグレーションツールはpressly/gooseを使っている
- 初期化スキーマは
1_schema.sql
に記述し、運用開始後のスキーマ定義変更等は2_add_user_age.sql
のように連番を振って記述する- Tips: Goでは1.16からembedパッケージを使ってバイナリにファイルを文字列として埋め込むことができる
repository/
: DBアクセス- DBへのアクセス処理
- 引数のバリデーションは
handler/
に任せる
- 引数のバリデーションは
- DBへのアクセス処理
pkg/
: 汎用パッケージ- 複数パッケージから使いまわせるようにする
- 例:
pkg/config/
: アプリ・DBの設定 - Tips: 外部にパッケージを公開したい場合は
internal/
の外に出しても良い
- Tips: Goの仕様で
integration/
: 結合テストinternal/
の実装から実際にデータが取得できるかテストする- DBの立ち上げにはory/dockertestを使っている
- 短期開発段階では時間があれば書く程度で良い
- Tips: 外部サービス(traQ, Twitterなど)へのアクセスが発生する場合はgolang/mockなどを使ってモック(テスト用処理)を作ると良い