Skip to content

README.ja.md

Latest commit

 

History

History
167 lines (115 loc) · 5.76 KB

README.ja.md

File metadata and controls

167 lines (115 loc) · 5.76 KB

cqrs-es-example-php

CI Renovate License

概要

PHP実装によるCQRS（Command Query Responsibility Segregation）とイベントソーシングのサンプルプロジェクトです。このプロジェクトは、アクターモデルではなくクラスベースの実装となっています。

本プロジェクトは j5ik2o/cqrs-es-example-go のPHP版実装であり、イベントソーシングには j5ik2o/event-store-adapter-php を使用しています。

他言語での実装例については j5ik2o/cqrs-es-example を参照してください。

スタック

このOSSリポジトリは、主に以下の技術スタックを利用しています。

システムアーキテクチャ図

プロジェクト構成

.
├── src/
│   ├── Command/                 # コマンド側（書き込み）
│   │   ├── Domain/             # ドメインロジック
│   │   │   ├── GroupChat/      # グループチャット集約
│   │   │   └── UserAccount/    # ユーザーアカウント集約
│   │   ├── InterfaceAdaptor/   # インターフェースアダプター
│   │   │   ├── Repository/     # リポジトリ実装
│   │   │   └── Resolver/       # GraphQL Mutation Resolver
│   │   └── Processor/          # コマンドプロセッサー
│   └── Query/                  # クエリ側（読み取り）※実装予定
│       └── InterfaceAdaptor/
│           └── Resolver/       # GraphQL Query Resolver
├── tests/                      # テストコード
├── tools/                      # 開発ツール
│   ├── docker-compose/         # Docker設定
│   └── e2e-test/              # E2Eテストツール
└── docs/                       # ドキュメント

クイックスタート

前提条件

  • Docker および Docker Compose
  • Make (オプション)

セットアップ

  1. リポジトリのクローン
git clone https://github.com/akinoriakatsuka/cqrs-es-example-php.git
cd cqrs-es-example-php
  1. Docker環境の起動
# Dockerイメージのビルド
make docker-compose-build

# サービスの起動
make docker-compose-up
  1. 動作確認
# GraphQLエンドポイントのテスト
./tools/e2e-test/verify-group-chat.sh

開発

コマンド実行

すべてのコマンドはDockerコンテナ内で実行します：

# アプリケーションコンテナ内でコマンド実行
docker compose exec app [コマンド]

テスト

# 全テスト実行
make test

# カバレッジ付きテスト
make test-coverage

# 特定のテストファイル実行
docker compose exec app vendor/bin/phpunit tests/Path/To/TestFile.php

コード品質

# コードフォーマット
make fmt

# 静的解析
make phpstan

# リント（フォーマット + 静的解析）
make lint

設計原則

CQRS (Command Query Responsibility Segregation)

本プロジェクトでは、コマンド（書き込み）とクエリ（読み取り）の責務を明確に分離しています：

  • Command側: データの変更を担当。イベントソーシングにより全ての変更をイベントとして記録
  • Query側: データの読み取りを担当。最適化された読み取り専用モデルを使用（実装予定）

Event Sourcing

すべてのドメインイベントは以下の特徴を持ちます：

  • イミュータブル（不変）
  • 順序付けられている
  • 集約の完全な状態を再構築可能

Domain-Driven Design (DDD)

  • 集約 (Aggregate): GroupChat, UserAccount
  • 値オブジェクト (Value Object): GroupChatId, UserAccountId, MemberId
  • ドメインイベント: GroupChatCreated, MemberAdded, etc.

Contributing

プルリクエストを歓迎します。大きな変更の場合は、まずissueを開いて変更内容について議論してください。

開発フロー

  1. Featureブランチを作成 (git checkout -b feature/AmazingFeature)
  2. 変更をコミット (git commit -m 'Add some AmazingFeature')
  3. ブランチをプッシュ (git push origin feature/AmazingFeature)
  4. プルリクエストを作成

関連プロジェクト

ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細はLICENSEファイルを参照してください。

Author

サポート

質問や問題がある場合は、Issuesで報告してください。
⚡