検索条件にCRITERIAを

検索条件にCRITERIAを同人ソフトサークル Project ICKX 若葉章 @effy_staffs (EFFY開発チーム)

検索をパターン化する CRITERIAパターン(造語)のご紹介

状況！ • これは部屋単位の予約システムです • 部屋の予約は次の三要素で成立します • 予約日 • 部屋番号 •
顧客ID • 指定する予約日と部屋番号でリソースにアクセスしたいです

ほーん、ならまずはVoこうするか

Entityはこうやな

URLの構築はこうやな Symfonyの場合、 URLパスパート上の変数名とここのキー名が完全一致する必要がある年月日なのでフォーマットを整えるっぴ

検索はこうやな Doctrineかつスキーマ定義で Datetime型を指定している場合、 Datetime型を与える必要がある設定次第だがDoctrineの場合プロパティ名を lowerCamelCaseにする必要がある

似たような検索が出るたびにこうちまちま弄るのめんどくさいな

具体的には・・・ • 全ての検索箇所、URL構築箇所においてそれぞれのエンティティの特性に合わせたプロパティ名の書き換えが必要 • 検索とURL構築でコンテキストが異なり、コンタミネーションすると事故につながる今回はたまたま同じ

検索条件にCRITERIAを

まずはエンティティを抽象的に扱えるように

検索条件インターフェースの用意 • 全ての検索条件はcriteriaアクセサーを持つ • 本例においてPHP8.4からの非対称可視性プロパティフックで実装しているのは責務を明確にしたいから

ドメイン層としての検索条件インターフェースの用意 • ドメイン層なのでドメインエンティティからの変換が可能 • 一度ドメイン層として”検索条件”を一般化する事で、アプリ層などの他階層での関心毎を減らす

アプリ層としての検索条件インターフェースの用意 • ドメイン検索条件として検索条件を受け入れる事でシステム全体の検索条件を明確にする • アプリ層として検索条件の受け入れ方を一般化し、どのような特性であっても同じ手触りを提供させる • 合わせて、共通項は自動化もさせる

アプリ層としての検索条件特性の用意 • アプリ層としての検索条件の特性を抽出し、以降の実装での考え事を減らします

特性に応じた検索条件インターフェースの用意 • 検索特性に応じた検索条件インターフェースを用意することで知識のコンタミネーションを防ぐ ※URLって書いてあるんだからURL用の結果が返るのは自明

検索条件にCRITERIAを

ドメイン検索条件 • ドメイン知識としての検索条件が明快になった • 要求を全て満たしているので高品質 • 予約日と部屋番号でリソースにアクセス
• 要求の確認対象が明確かつ最小なので、検証しやすい • ドメイン層としてのコンテキストを持つため利用側での自律動作を実施しやすい（後述）

アプリ検索条件（repository） • アプリ検索条件インターフェースがそのまま使われる事はないです • このリポジトリ検索に必要なコンテキストだけを考えれば良くなっています • 今回はVOが持つ情報が 1:1で適合しているので
get criteriaでは変換なし

アプリ検索条件（url） • このURL検索に必要なコンテキストだけを考えれば良くなっています • リポジトリ側と違ってこちらではコンテキストに依存した変換を行っています
• これが利用側における自律的な動作です • 十分なコンテキストを与えられているため必要ならクラス名を元に完全自動変換すら可能です

検索条件がCRITERIAに

検索 • これだけで済むようになっちゃった • 以降、検索条件が変わったとしてもcriteria群を弄るだけで利用側のコードを変更する事はありません（それ以前にクラスとして用途が明確になっているので変更される事はまず起きえないんですが）

URL構築 • URL検索条件インスタンスを直接与えられるならこれで済むようになりました • リポジトリ検索条件とインターフェースが同一なため、ドメイン検索条件を修正し、アプリ検索条件が追随すれば自動的に全体の協調が取れます

URL構築 • ただまぁ流石に繰り返しの中などでは利用できないので、twig拡張を用意した方が良いです • twig拡張の例

URL構築 • 拡張がある前提ならばこのような記述が可能となります • 単数であっても次の通り • 例によってパラメータが変わったとしても実際に利用する側の変更は不要となりました

おしまい

検索条件にCRITERIAを

検索条件にCRITERIAを

ICKX

More Decks by ICKX

Other Decks in Programming

Featured

Transcript