- レイヤ順:
handler (REST)→service→repository/storage/auth/cache/domain。 - 依存注入:
google/wire(src/wire/wire.go→ 生成物wire_gen.go)。依存変更時はtask wireか包括的にtask generate。 - API: OpenAPI v2 (
docs/openapi/v2.yaml) →oapi-codegen生成コードsrc/handler/v2/openapi。実装はsrc/handler/v2/*に手書き。 - DB: MySQL (GORM2) リポジトリ具象は
src/repository/gorm2。Atlas による SQL マイグレーション (migrations/*.sql,atlas.hcl)。 - ストレージ: 設定により
swift/local/s3をstorageSwitch()で選択 (wire_gen.go)。 - キャッシュ: Ristretto (
src/cache/ristretto)。ユーザ/Seat など service + cache の 2 層。 - ドメイン値:
src/domain/values(必ずコンストラクタで作る, 直接 struct リテラル禁止)。
| 目的 | コマンド | 備考 |
|---|---|---|
| 依存DL +コード 生成 | task |
download + generate (wire + openapi + mocks) |
| 開発環境起動(v2) | task dev |
事前に OAuth の .env の設定が必要 |
| テスト | task test |
Docker 必須 / Table Driven + testify |
| Lint(diff対象) | task lint |
古いコードは無理に直さない |
| 自動修正試行 | task lint:fix |
可能な範囲で整形 |
| 新規マイグレーション | task migrate:new -- name |
空テンプレ生成 |
| マイグレーション Lint | task migrate:lint |
順序/競合検証 |
| DB スキーマ Doc の生成 | task tbls |
docs/db_schema 更新 |
| 全停止 | task down |
dev + tbls 停止 |
| DB データ削除 | task clean:db |
破壊的操作注意 |
docs/openapi/v2.yamlにスキーマ/paths/definitions 追加。task openapi(またはtask generate) でコード生成。src/service/v2にビジネスロジック追加 (権限・集約操作ここに集約)。src/repository/gorm2など service から操作するものの実装。src/handler/v2に HTTP ハンドラーの実装。- 依存が増えたら
src/wire/wire.goの Set に interface 追加 →task wire。 - Table Driven Test を
*_test.goに追加。
| Do | Don't |
|---|---|
| Interface 契約を先に考え実装は従う | 実装都合で interface を破壊的変更 |
| OpenAPI / SQL / wire Set を更新し再生成 | 生成物 (wire_gen.go, openapi code) を直接編集 |
| 値オブジェクトはコンストラクタ利用 | struct リテラル直書き |
Repository では fmt.Errorf("...: %w", err) でラップ |
下位エラーそのまま丸投げ |
- Visibility(
public/limited/private) はゲーム取得系でフィルタ必須。既存 handler/service を参照し同一条件を使い回す。 - Game Role:
ownerは削除/ロール管理まで、maintainerは編集/ファイル追加可。 - Admin: 全ゲーム操作 + Edition 作成権限。
- 権限は handler の checker で調べる。
Table Driven Test を採用する。
testCases := []struct{
name string
input X
wantErr bool
}{
{name: "ok", input: X{...}},
{name: "invalid id", input: X{...}, wantErr: true},
}
for _, testCase := range testCases { t.Run(testCase.name, func(t *testing.T) { /* require/assert */ }) }または
testCases := map[string]struct{
input X
wantErr bool
}{
"ok": {input: X{...}},
"invalid id": {input: X{...}, wantErr: true},
}
for name, testCase := range testCases { t.Run(name, func(t *testing.T) { /* require/assert */ }) }| 判断観点 | 質問例 | 維持方針 |
|---|---|---|
| 新規ロジックの所在 | ビジネスルールか I/O 変換か | ルール=service, I/O=handler |
| 依存の粒度 | DB/sql 操作が複数集約か | 再利用/権限境界は service で統合 |
| トランザクション | どこで開始/commit すべきか | service で開始し repository interface に Tx 注入 |
- wire 再生成忘れ (
task wireortask generate) → ビルドエラー。 - OpenAPI スキーマ未更新で handler 追加 → 生成コード不整合。
- 生成コードを直接編集 → 次回再生成で消滅。
- Visibility / 権限チェック抜け → 認可バグ。既存 service メソッド再利用を優先。
- 古いコードへ過度な lint 適用 → 差分が膨らむ。変更範囲最小化。
.
├── docker # Docker に関する設定
│ ├── base
│ ├── dev # 開発環境の設定
│ ├── production # 本番環境の設定
│ └── tbls # tbls による DB スキーマドキュメント生成用の設定
├── docs
│ ├── db_schema # DB スキーマドキュメント
│ ├── images
│ └── openapi # OpenAPI スキーマ
├── migrations # DB マイグレーションのSQLファイル
├── pkg
│ ├── context
│ ├── random # 暗号的に安全なランダム文字列生成
│ └── types # optionalな型
├── src
│ ├── auth # 認証関連
│ │ ├── mock
│ │ └── traQ
│ ├── cache # キャッシュ関連
│ │ ├── mock
│ │ └── ristretto
│ ├── config # 設定関連
│ │ ├── mock
│ │ └── v1 # 環境変数から読み込む実装
│ ├── domain # ドメインモデル
│ │ └── values # 値オブジェクト
│ ├── handler # HTTP ハンドラ
│ │ ├── common
│ │ └── v2 # ハンドラの実装
│ │ └── openapi # OpenAPI スキーマから生成されたコード
│ ├── repository # データの永続化。RDB を想定
│ │ ├── gorm2 # GORM を使った実装
│ │ │ ├── migrate # 古いマイグレーションのコード
│ │ │ └── schema # 新しいマイグレーションのコード
│ │ └── mock
│ ├── service # ビジネスロジック
│ │ ├── mock
│ │ ├── v1
│ │ └── v2
│ ├── storage # ストレージ関連。ファイルの保存先
│ │ ├── local # ローカルのファイルストレージ
│ │ ├── mock
│ │ ├── s3 # S3 ストレージ
│ │ └── swift # Swift ストレージ
│ └── wire # Dependency Injection
├── task # Taskfile の設定
└── testdata # テスト用に使うファイル設計の詳細は src/README.md も参照してください。
ゲーム。 タイトルと説明が紐づけられている。
ゲームを動かすためのファイル。実体は zip ファイル。1つのゲームに複数のゲームファイルが存在する。 Windows 用の exe ファイルを含むもの、Mac OS 用のアプリケーションを含むもの、JVM 用の jar ファイルを含むものがある。
ゲームの動画。1つの game に複数の game video が存在する。
ゲームの画像。1つの game に複数の game image が存在する。
ゲームのバージョン。1つの game に複数の game version が存在する。 1つのバージョンには、1つ以上の game file または URL、1つの game video、1つの game image が含まれる。
ランチャーのエディション。複数の game version をまとめたもの。 エディションは、 game version をまとめて配布するためのもの。 例えば、x年のコミケ用のエディション、y年の工大祭用のエディションなど。 以前は Launcher Version と呼ばれており、一部にその名前が残っている。
game に対する権限。
- owner: game の所有者。game の編集、削除、game roleの変更、削除、game fileのアップロード、game videoのアップロード、game imageのアップロード、game versionの作成ができる。
- maintainer: game の管理者。game の編集、game roleの変更、game fileのアップロード、game videoのアップロード、game imageのアップロード、game versionの作成ができる。
traP Collection の管理者。 edition を作成できるほか、全ての game について操作を行うことができる。
座席。工大祭などで座席の管理をするのに使用する。 ランチャーから今の座席の状態が送信され、空いている座席を確認できる。
game を作った人に関する情報。1 つの game に複数の game creator を紐づけることができる。 game role とは全く別の情報として管理する。複数の game creator job を紐づけることができる。
game creator の役割。「プログラマー」「プロジェクトリーダー」「デザイナー」などが考えられる。 あらかじめ admin が用意し、全てのゲームで共通して使われる preset job と、game ごとに名前をつけて作ることができる custom job の2種類がある。
ゲームの公開状態を表す。public、limited、private の3つの値をとる。
| 公開状態 | game file | game のタイトル、説明、game image、game video |
|---|---|---|
| public | 誰でもダウンロード可能 | 誰でも閲覧可能 |
| limited | 部員のみダウンロード可能 | 誰でも閲覧可能 |
| private | 部員のみダウンロード可能 | 部員のみ閲覧可能 |