Scala Pet Store API (開発中)

目的

DDDに基づいた、一つの実装を示すこと(DDDは設計思想なので具体的な実装方式は複数あり得ますが、私が考える最良の実装という意味)。

特徴

• DDDに準拠した設計方針
• 対象ドメインはペットストア
• Scala 2.11対応
• Play 2.5.x対応
• アプリケーションとしては REST like API

対象ドメイン

• ペットストア
• 原典は Java Pet Storeですが、独自にアレンジしている部分があります。
• 参考にした実装は mybatis/jpetstore-6

レイヤー構造

DDDのレイヤー化アーキテクチャに従い、次のとおりのレイヤーに分割します。

• アプリケーション層
• ドメイン層
• インフラストラクチャ層

もっとも重要なのは、メンタルモデルを反映したドメイン層です。 このドメイン層を、非ドメイン層の知識から侵蝕されることを防ぐために、隔離します。

ドメイン層

ドメインの目的は、ペットストアの運営です。 ペットやペットフード、アクセサリーなどを仕入れて、顧客に販売するためのドメインです(仕入れの概念が現在ないので実装中です)。

ドメインモデル

• Customer Module = 顧客モジュール
  • Customer (GE,A) = ペットストアの顧客
    • StatusType (VO)
    • CustomerProfile (VO)
    • CustomerConfig (VO)
• Item Module = 商品モジュール
  • Category (GE,A) = 商品のカテゴリ(ex. 犬)
  • ItemType (GE,A) = 商品の種類(ex. 柴犬)
  • Item (GE,A) = 商品(ex. ぽち)
• Purchase Module = 購買モジュール
  • Cart (GE,A) = ショッピングカート
    • CartItem (VO) = カート内の商品と数量
  • Order (GE,A) = 注文
    • OrderItem (VO) = 注文する商品と数量

GE = グローバルな識別子を持つエンティティ
VO = 値オブジェクト
A = 集約

Specs

とりあえず、重要なところだけSpecを書いています。

• CartSpec
• OrderSpec

ここで重要なのは、モデルの表現(クラス名、属性名、振る舞いの名前(引数・戻り値も))にユビキタス言語以外の言葉を利用しないことです。
原則的に、これらの要素に、実装技術の言葉を含めてはいけません(実装技術の言葉を含めてしまうとメンタルモデルが離れていきドメインについて理解することが難しくなるため。ただし、StringやIntなどのデータ型や、ListやMap, Try, Option, Futureなどのコンテナ型は例外とする)。実装技術に関する知識は、アプリケーション層かインフラストラクチャ層に対応づけましょう。

• TODO
  • 仕入れ先の導入
  • 在庫の導入
  • 商品モデルにサブ型を導入する

インフラストラクチャ層

DDD基盤コード

わかりやすくするために、特別なライブラリを用意せず、簡単な基盤コードを含めています。

• Entity = DDDにおけるエンティティの責務
• Repository = DDDにおけるリポジトリの責務
  • RepositoryOnJDBC
    JDBCに対応したリポジトリの骨格実装。ScalikeJDBCで実装。ちなみに、1エンティティが複数テーブルにマッピングされるような実装は今のところ作っていません。そのうち作ります。Specはこちら
  • RepositoryOnMemory メモリに対応したリポジトリの骨格実装。内部実装はMapですがRepositoryとして操作できる。Specはこちら
  • RepositoryOnMemcached(TODO)
    Memcachedに対応したリポジトリの骨格実装。
  • CacheManagementRepository(TODO)
    キャッシュのマネジメントを行うリポジトリ実装。

アプリケーション層

• コントローラ(TODO)
• アプリケーションサービス(TODO)

利用している主なフレームワーク/ライブラリ

• Play Framework 2.5.x
• Google Guice
• ScalikeJDBC 2.x
• play-circe
• nscala-time
• specs2
• mockito

参考にしたコード

• https://github.com/mybatis/jpetstore-6
• https://github.com/scalikejdbc/hello-scalikejdbc
• https://github.com/tototoshi/play-json4s
• https://github.com/tototoshi/play-flyway
• http://qiita.com/opengl-8080/items/6fb69cd2493e149cac3a