全体設計¶

7つの設計原則をベースにアジャイル開発に適うレイヤ設計を導入する

基本構成¶

レイヤ	設計
全体アーキテクチャ	DDD(オニオンアーキテクチャ)
RDBアクセス	Repositoryパターン (DomainServiceに組み込み)
トランザクション制御	Unit of Work
クエリ	必要に応じて検討：CQRS

全体構成¶

基本フロー¶

sequenceDiagram
  autonumber

  actor c as client
  participant p as Presentation
  participant a as Application
  participant d as Domain
  participant db as DB
  participant os as Outer Service

  c->>+p : Request
  p->>p: depends : check_access_token
  p->>+a : usecase.execute(InputDTO)

loop ユースケース操作
  alt バックエンド内に閉じる操作
    a->>+d : service.method()
    d->>-a : domain model
  else dbに関する操作 (ここではcommitしない)
    a->>+d : uow.repository.method()
    d->>+db : request
    db->>-d : return result
    d->>-a : domain model
  else 外部サービスを利用する操作
    a->>+d : service.method()
    d->>+os : request
    os->>-d : return result
    d->>-a : domain model
  end
end

opt db永続化実行
  a->>+db : uow.commit()
  db->>-a : return result
end

  a->>-p : OutputDTO
  p->>p: middleware : error handling
  p->>p: middleware : construct response 
  p->>p: middleware : logging
  p->>-c: Response

アプリ開発時に主に利用するもの¶

階層

Text Only

backend/volumes/app
├── core
│   ├── base
│   ├── depends
│   └── middleware
└── ddd
    ├── application
    │   ├── dto
    │   ├── uow
    │   └── usecase
    ├── domain
    │   ├── enum
    │   ├── error
    │   ├── factory
    │   ├── model
    │   ├── repository
    │   └── service
    ├── infrastructure
    │   ├── auth
    │   ├── database
    │   ├── factory
    │   ├── log
    │   ├── repository
    │   ├── service
    │   ├── uow
    │   └── util
    └── presentation
        ├── endpoint
        └── schema

説明

パス	役割
app/core	共通で利用するモジュールなどを配置
app/core/base	各レイヤで利用する基底クラス
app/core/depends	プレゼン層で利用するDepends
app/core/middleware	プレゼン層で利用するミドルウェア
app/ddd	DDDを表現する
app/ddd/application	DDD：ユースケース層
app/ddd/application/dto	DDD：ユースケース層の入出力DTO
app/ddd/application/uow	DDD：ユースケース層のUOW
app/ddd/application/usecase	DDD：ユースケース層のユースケース
app/ddd/domain	DDD：ドメイン層
app/ddd/domain/enum	DDD：ドメイン層の列挙型
app/ddd/domain/error	DDD：ドメイン層のエラー
app/ddd/domain/model	DDD：ドメイン層のドメインモデル
app/ddd/domain/repository	DDD：ドメイン層のリポジトリ（IF）
app/ddd/infrastructure	DDD：インフラ層
app/ddd/infrastructure/database	DDD：インフラ層のデータベース実装
app/ddd/infrastructure/repository	DDD：インフラ層のリポジトリ実装
app/ddd/presentation	DDD：プレゼンテーション層
app/ddd/presentation/endpoint	DDD：プレゼンテーション層のエンドポイント
app/ddd/presentation/schema	DDD：プレゼンテーション層の入出力スキーマ
app/main.py	起動ファイル
migrations	ORMやマイグレーション
migrations/models	ORM
tests	test関連
pyproject.toml	poetry設定
documentation/mkdocs/volume/docs	mkdocsで編集するmdファイル群
docs	自動生成されるドキュメント

プレゼン周りのcoreとinfrastructureの責務分解が微妙なので整理するかも
参考：PythonでDDDやってみた
- fastapiでオニオンアーキテクチャする例
- 全体構成参考として利用。細かいところは不完全なため実装変更する。