akka-ddd-cqrs-es-example

KO | EN

gitlite — search

#javascript #php #java #dotfiles #ruby #linux #c-plus-plus #python #macos #vim #zsh #opencv

akka-ddd-cqrs-es-example

★ 85 Open GitHub ↗

Bank API CQRS Event Sourcing System on Akka-Cluster (Concept Model)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Bank API CQRS Event Sourcing System on Akka-Cluster (Concept Model)

**!!!Notice!!!: This project is now considered outdated as it is based on the old Akka (untyped) API. For a more up-to-date example using the new Akka Typed API, please refer to [j5ik2o/akka-cqrs-es-example-typed](https://github.com/j5ik2o/akka-cqrs-es-example-typed). We strongly recommend checking out the updated version for a better understanding and implementation of the CQRS/ES pattern.**

## Features

- DDD, CQRS + Event Sourcing based design
- Implement using Akka(-actor, -stream, -cluster-sharding, -persistence, -persistence-query, -http, ...)
- Scala 2.12.4
- REST API Application

## Target domain

- Bank Account to deposit/withdraw

## Target Use cases

- Deposit money to a Bank Account
- Withdraw money from a Bank Account
- Refer to deposits and withdraws in a Bank Account

## Layered structure

In this project, the layered structure is based on ['Clean Architecture'](https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html).

### Domain layer

- Domain objects are represented by case class.
- Domain types
    - [BankAccountId](domain/src/main/scala/com/github/j5ik2o/bank/domain/model/BankAccountId.scala)
    - [BankAccount](domain/src/main/scala/com/github/j5ik2o/bank/domain/model/BankAccount.scala)
    - [BankAccountEventId](domain/src/main/scala/com/github/j5ik2o/bank/domain/model/BankAccountEventId.scala)
    - [BankAccountEvent](domain/src/main/scala/com/github/j5ik2o/bank/domain/model/BankAccountEvent.scala)
        - BankAccountOpened is the account opening event
        - BankAccountUpdateared is the account information updating event
        - BankAccountDeposited is the deposit event
        - BankAccountWithdrawn is the withdarw event
        - BankAccountClosed is the account closed event

### Use case layer

- Command use case is [BankAccountAggregateUseCase](use-case/src/main/scala/com/github/j5ik2o/bank/useCase/BankAccountAggregateUseCase.scala)
- Query use case is [BankAccountReadModelUseCase](use-case/src/main/scala/com/github/j5ik2o/bank/useCase/BankAccountReadModelUseCase.scala)

### Interface layer

#### Aggregate

- [BankAccountAggregate](interface/src/main/scala/com/github/j5ik2o/bank/adaptor/aggregate/BankAccountAggregate.scala)(PersistentActor)
- [ShardedBankAccountAggregate](interface/src/main/scala/com/github/j5ik2o/bank/adaptor/aggregate/ShardedBankAccountAggregate.scala)(Extended BankAccountAggregate for cluster-sharding)
- [ShardedBankAccountAggregates](interface/src/main/scala/com/github/j5ik2o/bank/adaptor/aggregate/ShardedBankAccountAggregates.scala)(proxy to ShardRegion)

#### Controller

- [BankAccountController](interface/src/main/scala/com/github/j5ik2o/bank/adaptor/controller/BankAccountController.scala)
- [Routes](interface/src/main/scala/com/github/j5ik2o/bank/adaptor/controller/Routes.scala)
- [BankAccountValidateDirectives](interface/src/main/scala/com/github/j5ik2o/bank/adaptor/controller/BankAccountValidateDirectives.scala)

#### Persistence

The DAOs and Records are generated by [septeni-original/sbt-dao-generator](septeni-original/sbt-dao-generator)

- Slick3
    - [BankAccountDao, BankAccountRecord](interface/src/main/scala/com/github/j5ik2o/bank/adaptor/dao/BankAccount.scala)
    - [BankAccountEventDao, BankAccountEventRecord](interface/src/main/scala/com/github/j5ik2o/bank/adaptor/dao/BankAccountEvent.scala)

## How to run unit tests

```sh
$ sbt clean test
```

## How to run E2E tests

Terminal #1

```sh
$ sbt -DPORT=2551 -DHTTP_PORT=8080 'localMysql/run' 'api-server/run'
```

Terminal #2

```sh
$ sbt -DPORT=2552 -DHTTP_PORT=8081 'api-server/run'
```

Terminal #3

```sh
$ sbt -DPORT=2553 -DHTTP_PORT=8082 'api-server/run'
```

Terminal #4

```sh
$ sbt 'read-model-updater/run'
```

## How to test

```sh
# open a bank account
$ curl -X POST \
  http://localhost:$PORT/bank-accounts \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{ "name": "test-1" }'
{"id":"XEe","errorMessage":null}%

# update the bank account
$ curl -X PUT \
  http://localhost:8080/bank-accounts/XEe \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
  "name": "test-2"
}'
{"id":"XEe","errorMessage":null}%

# deposit to the bank account
$ curl -X PUT \
  http://localhost:8080/bank-accounts/XEe/events \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
	"type": "deposit",
	"amount": 1000,
	"currencyCode": "JPY"
}'
{"id":"XEe","errorMessage":null}%

# withdraw from the bank account
$ curl -X PUT \
  http://localhost:8080/bank-accounts/XEe/events \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
	"type": "withdraw",
	"amount": 500,
	"currencyCode": "JPY"
}'
{"id":"XEe","errorMessage":null}%

# refer to events(deposits or withdraws) in the bank account
$ curl -X GET \
  http://localhost:8080/bank-accounts/XEe \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json'
{
    "id": "XEe",
    "values": [
        {
            "type": "deposit",
            "amount": 1000,
            "currencyCode": "JPY",
            "createAt": 1520219459
        }
    ],
    "errorMessage": null
}

# close the bank account
$ curl -X DELETE \
  http://localhost:8080/bank-accounts/XEe \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json'
{
    "id": "XEe",
    "errorMessage": null
}
{"id":"XEe","errorMessage":null}%
```

akka-ddd-cqrs-es-example

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README