Laravel-tweet-ddd
- twitter風アプリケーションをDDD(ドメイン駆動設計)のアーキテクチャに乗せて実装するプロジェクト
Overview
- DDDのコンテキストによる実装
- オーバーエンジニアリングを許容する
- あくまで個人的な技術アウトプットの場のため
Environments
- Laravel 7.x
- PHP 7.4.7
- Mysql 5.7
- Redis 5.0.7
- MinIO
- S3のMock Storageとして使用
- Docker
- node.js(assetビルド)
- パッケージ管理: yarn
Infrastructure
- このアプリケーションのインフラ構成はこちらのリポジトリでterraformで管理しています
Architecture
Onion Architecture
Architecture Overview
Workflow sequence
- e.g. Create New Entity
Directory tree
├── domain // Pure Domain Knowledge
│ ├── Base // Base Abstract Classes
│ ├── Application // Application Utility services
│ │ └── Contract
| | ├── Uuid
| | └── Transaction
│ ├── Model // Domain Model layer
│ │ ├── Entity
| | | ├── Base
| | | └── Tweet
│ │ ├── ValueObject
| | | ├── Base
| | | └── Tweet
│ │ └── DTO
| | ├── Base
| | └── Tweet
│ ├── Query // Belongs to ApplicationService, Abstract CQRS Query, not included concrete implementation
│ ├── Repository // Belongs to ApplicationService layer, not included concrete implementation
│ │ └── Contract
| | └── Tweet
│ └── UseCase // Belongs to ApplicationService layer, Accomplish use-case
|── infrastructure // Concrete Implementations. Should implement ApplicationService interface e.g RDBMS, HTTP Clients...
│ ├── Application // Concrete Utility Application services
| | ├── Uuid
| | └── Transaction
│ ├── Query // Concrete CQRS Query
| └── Repository // Concrete Repository
| ├── Base
│ │ └── InMemoryRepository // for testing
| └── Tweet
├── app // Laravel app
│ ├── Console
│ ├── Eloquent
│ ├── Exceptions
│ ├── Http
│ │ ├── Actions // For ADR pattern
│ │ │ ├── Frontend
│ │ │ └── Backend
│ │ ├── Responders // For ADR pattern
│ │ │ ├── Frontend
│ │ │ └── Backend
│ │ └── Middleware
│ ├── Providers
│ └── View
│ └── Components
│ └── Partial
├── bootstrap
│ └── cache
├── config
├── database
│ ├── factories
│ ├── migrations
│ └── seeds
├── docker // configs with using docker-compose
│ ├── mysql
│ │ └── init
│ ├── nginx
│ └── php
├── docs
│ └── architecture
├── public
├── resources
│ ├── js
│ │ └── components
│ ├── lang
│ │ └── en
│ ├── sass
│ └── views
│ ├── components
│ │ └── partial
│ ├── frontend
│ ├── backend
│ └── layouts
├── routes
├── storage
│ ├── app
│ │ └── public
│ ├── framework
│ └── logs
└── tests
├── Browser // for E2E
│ ├── Frontend
│ ├── Backend
│ ├── Pages
│ ├── console
│ └── screenshots
├── Helper // test helpers
│ ├── Domain
│ └── Utils
├── Feature
└── UnitADR
Testing Architecture
- Unit TestとE2E Testを用いて動作を担保する。
- Unit Test: phpunit
- E2E Test: Laravel Dusk
- 全体のテスト設計比率としては、
UnitTest:E2E = 8:2程度を想定する。- 実装依存するE2Eテストは壊れやすい為、比率を少なくしている。
Unit Test Policy
- UseCase単位 = 1Actionに対するtestを実装する。
- test自体がEntity、ValueObject、DomainServiceが持つドメイン知識のドキュメントになる。
- UseCase程度の粒度に対して動作を担保すれば、test設計コストに対するcoverageを最大化できると判断している。
- また、特定のロジックに対して細かくtestを書きすぎると、コード全体の保守性が下がっていく為。
- 純粋なDomain知識に対してtestを行う為、infrastructureを全て隠蔽し、各interfaceに対してtestを行う。
- LaravelのDIコンテナを利用して、entityの永続化先を全てInMemoryに差し替えることで上記を解決する。
- Testing用DBの存在を意識せずに、test実装が可能になる。
- 参考
infrastructure/Repository/Base/InMemoryRepository.php
class InMemoryTweetRepository extends InMemoryRepository implements TweetRepository
{
/**
* save Tweet entity.
*
* @param Tweet $tweet
* @return void
*/
public function save(Tweet $tweet): void
{
$this->saveInMemory($tweet);
}
}E2E Test Policy
- infrastructureレベルで期待する動作が担保されているかを検査する。
- e.g. RDBMS, S3, Redis, etc...
- unit testで抽象化されたDomainを検査済みの為、具象レベルでの担保はこちらで行う。
Installation
-
dockerを予めインストールしてください。
-
clone
git clone https://github.com/naoyaUda/laravel-tweet-ddd.git- install
# コンテナのビルド、依存パッケージのインストール、DBの初期化を行う
make install
# permission変更
chmod -R 777 storage
chmod -R 777 bootstrap/cacheHow to
- 各種操作コマンドはMakefileに記述しています。以下コマンドですべてのターゲットを確認できます。
make help