Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ytake/cqrs-app-sample
PHP(Laravel) / ES+CQRS Sample Application
https://github.com/ytake/cqrs-app-sample
cqrs-es elasticsearch kafka laravel mysql php
Last synced: 25 days ago
JSON representation
PHP(Laravel) / ES+CQRS Sample Application
- Host: GitHub
- URL: https://github.com/ytake/cqrs-app-sample
- Owner: ytake
- Created: 2018-09-10T12:51:28.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-02-01T22:26:46.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T16:14:55.662Z (about 1 month ago)
- Topics: cqrs-es, elasticsearch, kafka, laravel, mysql, php
- Language: PHP
- Homepage:
- Size: 395 KB
- Stars: 12
- Watchers: 4
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CQRS Application Sample
PHPを使って理解しやすいようなサンプルにしています。
実際に実践する場合は無理にPHPだけではやらずに適材適所な言語などを組み合わせてください。
## Required
PHP(Laravel), Apache Kafka(& zookeeper), MySQL、Elasticsearch
### Apache Kafka
recommended [confluent platform](https://www.confluent.jp/)
## 要件例
いくつかキーワードを投稿して、そのキーワードを見れるのはもちろんなんですが、
ワードクラウドみたいなものを実現したいんですよね！
キーワードはキーワードそのものと識別可能なユーザー情報、ここでは例としてuserIDだけにしましょう。
ワードクラウドライクなものはどう実現したらよいでしょう？
キーワードとはまた違う概念になりそう（コール数の概念が加わります）で、Elasticsearchを使えば実現できそうです。
## 処理の流れ
### Command + Event Sourcing
- PHP（フォーム）
- MySQL(スナップショット/実際には他のものを利用してください)
- Apache Kafka
### 読み込みモデル更新処理
- ReadModel Handler(Laravel CLI)
- Elasticsearch
supervisorやsystemdで動かすと良いでしょう。
### Query
- Elasticsearch
- PHP
## なぜLaravelのQueueを使わないのですか？
この処理だけではおそらく実現できますが、
現実問題として同じQueueの中身を他のプロセスが処理するケースもあるでしょう。
例えばブログを投稿した、をトリガーにキーワードの内容をpublishしたとします。
Elasticsearchにinsertする以外にRDBMSに正規化して持たせたい場合にどうすればいいでしょうか？
同じプロセスで処理する場合は2フェーズコミットになりそうです。
この場合、それぞれを担当するプロセスに分割した方は良さそうです。
必要とするのはラウンドロビンではない方法が望ましいです。
これはフレームワークの範囲を超えているので、専用のミドルウェアを使った方が良いでしょう。
## Run
### 1. Setup
アプリケーションを動かす前に実行してください
```bash
$ docker-compose up -d
# 各ミドルウェアはコンテナですが起動に時間がかかります。
# しばらくお待ちください。
# これらのミドルウェアを使う場合、商用ではコンテナではなく物理的HDDで動かしましょう。
$ docker-compose exec php composer install --prefer-dist --no-interaction && composer app-setup
$ docker-compose exec php /var/www/html/artisan migrate
```
### 2. Elasticsearch
tokenizerなどを設定します。
```bash
$ curl -X PUT 'http://localhost:9200/words' -H 'Content-Type: application/json' -d @dataset/mapping.json
$ curl -X POST 'http://localhost:9200/_bulk?pretty' -H 'Content-Type: application/json' --data-binary @dataset/words.json
```
### 3. Topic Subscribe
```bash
$ docker-compose exec php /var/www/html/artisan sample:subscribe_es
$ docker-compose exec php /var/www/html/artisan sample:subscribe_mysql
```