各サービスは、servicesモジュールにエントリポイントを作成する。 エントリポイントとなるmain関数を持つファイルは、services/src/bin/ディレクトリに配置する。

各サービスは、以下の通り実行する。

cargo run --bin <main-fun-file>

# Web APIサービスを起動する場合
cargo run --bin web_api_service

• services -> common
• services -> adapters
• adapters -> common
• adapters -> usecases
• adapters -> infra
• infrastructures -> usecases
• infrastructures -> domains
• usecases -> common
• usecases -> domains
• domains -> common

sqlx-cliを以下の通りインストールする。

cargo install sqlx-cli --no-default-features --features rustls,postgres

.envファイルを以下の通り作成する。

DATABASE_URL=postgres://postgres:password@localhost:5432/axum-seaorm-ddd-example

Dockerサービスを起動した後、Dockerコンテナを以下の通り起動する。

docker-compose up -d    # d: バックグラウンドでコンテナを起動

データベースを以下の通り作成する。

sqlx database create

# データベースを削除する場合
# sqlx database drop

マイグレーションファイルを以下の通り作成する。

sqlx migrate add <name>

migrations/<timestamp>-<name>.sqlファイルが作成される。 このファイルにデータベーススキーマの変更を記述する。

マイグレーションを以下の通り実行する。

sqlx migrate run

実行しているデータベースのマイグレーション履歴と、migrationsディレクトリのマイグレーションファイルを比較して、実行されていないスクリプトを実行する。

upとdownスクリプトに対応する戻すことが可能なマイグレションを作成したい場合は、マイグレーションを作成するときに、-rフラグを追加する。

sqlx migrate add -r <name>
# Creating migrations/<timestamp>_<name>.up.sql
# Creating migrations/<timestamp>_<name>.down.sql

その後、マイグレーションを以下の通り実行する。

sqlx migrate run
# Applied <timestamp>-<name>

マイグレーションを戻す場合は以下を実行する。

sqlx migrate revert
# Applied <timestamp>/revert <name>

戻すことが不可能なマイグレーションと、戻すことが可能なマイグレーションを混在させると、エラーが発生する。

# 戻すことが不可能なマイグレーションを作成
sqlx migrate add <name1>
Creating migrations/20211001154420_<name>.sql

# 戻すことが可能なマイグレーションを作成(エラーが発生)
sqlx migrate add -r <name2>
error: cannot mix reversible migrations with simple migrations. All migrations should be reversible or simple migrations

バージョン3の安定バージョンがSeaORMが依存しているtokioとバージョンが合わないため、バージョン4.0.0-rc.3を使用している。

sea-orm-cliコマンドを以下の通りインストールする。

cargo install sea-orm-cli

データベースに存在するテーブルを表現するエンティティファイルを、以下の通り作成する。

sea-orm-cli generate entity -o infrastructures/src/postgres/schema

注意: 以下で説明する方法で、開発環境に限定してmockを有効にできなかった。

SeaORMのMockDatabaseConnectionがCloneを実装しない。 よって、axumのExtensionでデータベースコネクションを状態として記録できない。 このため、SeaORMのmockフィーチャを、以下の通り開発環境のみで有効にする。

[dependencies.sea-orm]
version = "0.5"
features = ["sqlx-postgres", "runtime-tokio-rustls", "macros", "debug-print"]
default-features = false

[dev-dependencies.sea-orm]
version = "0.5"
features = ["sqlx-postgres", "runtime-tokio-rustls", "macros", "debug-print", "mock"]
default-features = false

トークンはデータベースに蓄積され続けるため、定期的にデータベースに記録しているJWTトークンを削除する必要がある。