🌝

6つの責務が混在したプッシュ通知送信処理をDDDでリファクタリングした話

に公開

はじめに

「このコード、どこを直せばいいんだろう…」

プッシュ通知送信機能に新しい要件追加の話が上がると、私たちはこの問いに直面しました。
6つの責務が混在するコード、そして「触ると何が壊れるかわからない」という恐怖。

本記事では、DDD(ドメイン駆動設計)のアプローチを採用し、このレガシーコードをどのようにリファクタリングしたのかをご紹介します。結果として得られた「変更に強い設計」の具体例と、今後の拡張への備えについても解説します。

プッシュ通知送信機能とは

私が所属するチームが開発している「カンリー福利厚生」のアプリでは、ユーザーにクーポン情報をプッシュ通知で届ける機能があります。この機能は大きく2種類の通知を扱います。

  • マーケティング用の通知: 特定のクーポンを指定して配信する単発の通知。新しいキャンペーンの告知や、期間限定クーポンのお知らせなどに使用

  • 定期通知: ユーザーの行動履歴に基づいて動的にクーポンを選定する定期的な通知。例えば「1ヶ月以内で最も利用されたクーポン」や「ユーザーが最後に閲覧したクーポン」などを自動的に選定し、パーソナライズされた通知を送信


1. 元々あった課題

1.1 単一責任原則(SRP)違反

先ほど述べた通り、リファクタリング前のプッシュ通知送信コマンドは、6つの責務を1クラスに抱えていました。以下の表は、各責務がコード内のどこに実装されていたかを示しています。

責任 メソッド
通知取得と重複除外 handle() 内
ユーザーフィルタリング filterUsersForNotification()
条件評価 evaluateUserConditions()
配信先決定 getDestinations()
通知送信 sendEachNotification()
結果更新 updateResults()

これらの責務が1つのクラスに集約されているため、テストの困難さ、変更時の影響範囲の不明確さといった問題が生じていました。

1.2 実際のコードの問題点

特に問題が顕著だったのが「配信先決定」を担うgetDestinationsメソッドです。このメソッドは、プッシュ通知をタップしたときにユーザーをどの画面に遷移させるかを決定する役割を持っています。クーポンが利用可能であればクーポン詳細画面へ、在庫切れや利用期限外であればブランド一覧画面へ遷移させます。

以下は、リファクタリング前のコードの一部です。

// Before: 配信先決定ロジックが80行以上に肥大化
private function getDestinations($notifications): array
{
    // 【問題1】ドメインロジックと、インフラ層の実装詳細が分離されないまま同一メソッドに混在
    $userDestinations = NotificationTransition::getNotificationTransitions();
    $couponRemainingCounts = EloquentCoupon::checkRemainingCount();

    foreach ($notifications as $notificationId => $notification) {
        $transitionId = $notification->transition_id;
        $columns = $this->transitionManager->getTransitionColumns($transitionId);
        $targetUsers = [];

        foreach ($notification->users as $user) {
            // 【問題2】変数の初期化が冗長 - 意図が不明確
            $couponId = "";
            $couponIdHash = "";
            $brandIdHash = "";
            $brandName = "";
            $genreId = "";
            $couponStartTime = "";
            $couponEndTime = "";

            // 【問題3】マーケティング用通知/定期通知の分岐が複雑
            if (!is_null($notification->transition_coupon_id) &&
                !is_null($notification->transition_coupon_id_hash) &&
                !is_null($notification->transition_coupon_brand_id_hash) &&
                // ... 7つもの null チェックが続く
            ) {
                // マーケティング用の通知の場合: 通知に紐づくクーポン情報をそのまま使用
                $couponId = $notification->transition_coupon_id;
                // ... 変数への代入が続く
            } else {
                // 定期通知の場合: ユーザーごとに動的にクーポンを計算
                // ... 動的計算のロジック
            }

            // 【問題4】ビジネスルール(利用可否判定)が漏れ出している
            if ($remainingCount->is_remaining_user_can_use_count &&  // 利用回数制限
                $remainingCount->is_remaining_stock &&               // 在庫
                $couponStartTime <= $now &&                          // 開始日時
                $couponEndTime >= $now) {                            // 終了日時
                // クーポンが利用可能 → クーポン詳細画面へ
                $params['pageName'] = config('notification.page.coupon_detail');
            } else {
                // クーポンが利用不可 → ブランド一覧画面へ
                $params['pageName'] = config('notification.page.brand_list');
            }
        }
    }
    return $notifications;
}

このコードには4つの問題がありました。
まず可読性の低下です。何をしているのか把握するのに時間がかかります。
次にテストが困難という問題。このメソッドだけを単体テストすることができません。
またドメインロジックの流出も深刻でした。利用可否判定などのビジネスルールがコマンドクラスに埋もれており、本来あるべきドメイン層に存在していませんでした。
そして変更の影響範囲が不明であること。1箇所の修正が他に影響するリスクが常にありました。

1.3 拡張性の欠如

これらの問題は、新機能追加時にさらに顕在化しました。マーケティング用の通知と定期通知の区別がコード内に散らばっており、新しい配信条件を追加するには複数箇所を修正する必要がありました。また、ドメインロジックがインフラ層に漏れ出しているため、ビジネスルールを1つ変更するだけでも、データアクセス層にまで影響が波及してしまう状態でした。


2. なぜDDDを導入すると課題が解決するのか

2.1 DDDの基本原則

DDD(ドメイン駆動設計)を導入するメリットの一つとしては、ビジネスロジックをドメイン層に集中させ、技術的な関心事から分離することにあります。これにより、ビジネスルールの変更がインフラ層に波及することを防ぎ、逆にデータベースやフレームワークの変更がビジネスロジックに影響することも防げます。

層 責務 禁止事項
Domain ビジネスルール SQLやフレームワーク依存
UseCase ユースケースの実現、オーケストレーション ビジネスロジックの直接実装
Infrastructure 外部サービス連携、永続化詳細 ドメインロジック

この層の分離を守ることで、各層を独立してテストでき、変更の影響範囲を限定できます。

2.2 解決のアプローチ

では、この原則を今回のプッシュ通知システムに適用するとどうなるでしょうか。Before/Afterで比較してみましょう。

Before: 1つのコマンドクラスに全ての処理

[プッシュ通知送信コマンド]
├── 通知取得
├── ユーザーフィルタリング
├── 条件評価
├── 配信先決定
├── 通知送信
└── 結果更新

リファクタリング前は、すべての処理が1つのコマンドクラスに詰め込まれていました。

After: DDDに基づいた責務分離

[コマンド] プッシュ通知送信
    │
    ├── [UseCase] マーケティング用の通知送信ユースケース
    │       └── オーケストレーションのみ
    │
    ├── [UseCase] 定期通知送信ユースケース
    │       └── オーケストレーションのみ
    │
    ├── [ドメインサービス] 受信者選定サービス (RecipientSelector)
    │       └── 受信者選定ロジック
    │
    ├── [ドメインサービス] 通知クーポン選定サービス (NotificationCouponSelector)
    │       └── クーポン選定ロジック
    │
    ├── [ドメインサービス] 遷移先選定サービス (TransitionDestinationSelector)
    │       └── 遷移先選定ロジック
    │
    └── [Entity/ValueObject] スケジュール通知, クーポンデータ, 遷移先...
            └── ビジネスルール

リファクタリング後は、コマンドクラスは薄いエントリポイントとなり、実際の処理はUseCaseやドメインサービス、Entity/Value Objectに分散しています。各クラスが明確な責務を持つことで、変更時の影響範囲が限定され、テストも書きやすくなります。


3. DDDを導入しながらリファクタリングした結果

3.1 ドメインモデル図

以下はリファクタリング後のドメインモデルの一部です。

このドメインモデルのポイントは、各集約が明確な境界を持ち、ビジネスルールがEntity/Value Objectに集約されている点です。また、配信状態の遷移(PENDING → SENDING → SUCCESS/FAILED)がドメイン内で管理されるため、状態変更のルールがコード上で明確になります。

3.2 複雑なロジックの改善例

Before: クーポン利用可否判定

// Before: 判定ロジックがコマンドクラスに散在
if ($remainingCount->is_remaining_user_can_use_count &&
    $remainingCount->is_remaining_stock &&
    $couponStartTime <= $now &&
    $couponEndTime >= $now) {
    $params['pageName'] = config('notification.page.coupon_detail');
} else {
    $params['pageName'] = config('notification.page.brand_list');
}

After: CouponData Entityにビジネスルールを集約

// After: CouponData Entity
final readonly class CouponData
{
    public function __construct(
        private int $couponId,
        private ?string $couponIdHash,
        private ?string $brandIdHash,
        private ?string $brandName,
        private ?int $genreId,
        private UsageLimit $usageLimit,    // Value Object
        private Stock $stock,               // Value Object
        private CouponValidityPeriod $validityPeriod,  // Value Object
    ) {
    }

    /**
     * クーポンが利用可能かどうか
     *
     * 以下の条件をすべて満たす場合にtrue:
     * - 利用回数制限内(usageLimit.isWithinLimit())
     * - 在庫あり(stock.hasStock())
     * - 有効期間内(validityPeriod.isWithinPeriod())
     */
    public function isAvailable(?DateTimeImmutable $now = null): bool
    {
        return $this->usageLimit->isWithinLimit()
            && $this->stock->hasStock()
            && $this->validityPeriod->isWithinPeriod($now);
    }

    /**
     * 有効なブランド情報を持っているか
     */
    public function hasValidBrandInfo(): bool
    {
        return !empty($this->brandIdHash) && !empty($this->brandName);
    }
}

このリファクタリングにより、利用可否判定のビジネスルールが「クーポンデータ」Entityに凝集されました。各判定条件は「利用回数制限」「在庫」「有効期間」といったValue Objectとして独立しており、Entityはこれらを組み合わせて利用可否を判定します。メソッド名 isAvailable() が「何をしているか」を明確に表現しています。

Before: 配信先決定ロジックがコマンドに埋もれている

// Before: 配信先の決定がコマンドクラス内に直接記述
if ($couponData->isAvailable()) {
    $params['pageName'] = config('notification.page.coupon_detail');
    $params['couponId'] = $couponIdHash;
} else {
    $params['pageName'] = config('notification.page.brand_list');
    $params['genreId'] = $genreId;
}
$targetUsers[$user->user_id] = $params;

リファクタリング前は、配信先(どのページに遷移させるか)を決定するロジックがコマンドクラス内に直接書かれていました。この方法では、配信先のルールを変更するたびにコマンドクラスを修正する必要があり、ビジネスロジックとプレゼンテーション層が密結合していました。

After: 遷移先選定をドメインサービスに委譲

// After: TransitionDestinationSelector(ドメインサービス)
final class TransitionDestinationSelector
{
    /**
     * 遷移先を選定する
     *
     * 遷移先ロジック:
     * - クーポンが利用可能 → クーポン詳細
     * - クーポンが利用不可 → ブランド一覧
     */
    public function select(
        CouponData $couponData,
    ): ?TransitionDestination {
        // ブランド情報が無効な場合は遷移不可
        if (!$couponData->hasValidBrandInfo()) {
            return null;
        }

        // クーポンが利用可能な場合はクーポン詳細画面へ
        if ($couponData->isAvailable()) {
            return TransitionDestination::toCouponDetail(
                brandId: $couponData->getBrandIdHash(),
                brandName: $couponData->getBrandName(),
                couponId: $couponData->getCouponIdHash(),
            );
        }

        // クーポンが利用不可の場合はブランド一覧画面へ
        return TransitionDestination::toBrandList(
            brandId: $couponData->getBrandIdHash(),
            brandName: $couponData->getBrandName(),
            genreId: (int) $couponData->getGenreId(),
        );
    }
}

遷移先選定のロジックが独立したクラスになったことで、「クーポンデータ」Entityの isAvailable() メソッドを呼び出すだけでビジネスルールを適用できるようになりました。このドメインサービスは依存が明確なため、単体テストも容易に書くことができます。

3.3 マーケティング用の通知と定期通知の分離

最も大きな設計変更は、UseCaseの分離です。

なぜ分離が必要だったのか

元のコードでは、マーケティング用の通知と定期通知が同じ処理フローで扱われていました。しかし、この2つは本質的に異なる特性を持っています。

観点 マーケティング用の通知 定期通知
クーポン指定 静的(事前に指定) 動的(ユーザーごとに計算)
SQL実行 軽量 動的計算SQL
対象セグメント 全ユーザー セグメント別

マーケティング用の通知は指定したクーポンをそのまま配信するため、処理がシンプルです。一方、定期通知は「1ヶ月以内で最も利用されたクーポン」のようにユーザーごとに動的に計算するため、処理が複雑になります。この違いを無視して同じコードで扱おうとすると、条件分岐が増えてコードが複雑化します。そこで、UseCaseを分離することにしました。

After: 分離されたUseCase

// SendMarketingNotificationsUseCase(静的クーポン配信)
class SendMarketingNotificationsUseCase
{
    public function execute(): NotificationDeliveryResults
    {
        // 1. マーケティング用の通知をフィルタリング(ドメインロジック)
        $allNotifications = $this->notificationRepository->findScheduled();
        $notificationCollection = $allNotifications->filterMarketing();

        // 2. 重複を除外
        $result = $notificationCollection->removeDuplicates();
        $targetNotificationCollection = $result['notifications'];

        // 3. 受信者を一度だけ取得(全通知で共通)
        $firstNotification = $targetNotificationCollection->first();
        $recipients = $this->recipientSelector->selectForNotification($firstNotification);

        // 4. 各通知を処理(静的クーポン)
        foreach ($targetNotificationCollection->toArray() as $notification) {
            $deliveryResults = $this->processNotification($notification, $recipients);
            // ...
        }

        return NotificationDeliveryResults::fromArray($notificationResults);
    }

    private function resolveTargets(
        ScheduledNotification $notification,
        Recipients $recipients,
        array $couponAvailabilities
    ): array {
        foreach ($recipients->toArray() as $recipient) {
            // クーポンを選定(ドメインサービスに委譲)
            $couponData = $this->notificationCouponSelector->select(
                $notification,
                $recipient,
                $couponAvailabilities
            );
            // 遷移先を選定(ドメインサービスに委譲)
            $transitionDestination = $this->transitionDestinationSelector->select($couponData);
            // ...
        }
    }
}
// SendRetentionNotificationsUseCase(動的クーポン配信)
class SendRetentionNotificationsUseCase
{
    public function execute(): NotificationDeliveryResults
    {
        // 1. 定期通知をフィルタリング(ドメインロジック)
        $allNotifications = $this->notificationRepository->findScheduled();
        $notificationCollection = $allNotifications->filterRetention();

        // 2. 重複を除外
        $result = $notificationCollection->removeDuplicates();
        $targetNotificationCollection = $result['notifications'];

        // 3. 各通知を処理(動的クーポン計算)
        foreach ($targetNotificationCollection->toArray() as $notification) {
            $deliveryResults = $this->processNotification($notification);
            // ...
        }

        return NotificationDeliveryResults::fromArray($notificationResults);
    }

    private function resolveTargets(
        ScheduledNotification $notification,
        Recipients $recipients,
        array $couponAvailabilities
    ): array {
        foreach ($recipients->toArray() as $recipient) {
            // クーポンを選定(ドメインサービスに委譲)
            $couponData = $this->notificationCouponSelector->select(
                $notification,
                $recipient,
                $couponAvailabilities
            );
            // ...
        }
    }
}

この分離により、各UseCaseが単一の責務を持つようになりました。マーケティング用の通知の変更が定期通知に影響することはなく、その逆も同様です。将来、新しい通知タイプを追加する場合も、既存のUseCaseに手を加えることなく、新しいUseCaseを追加するだけで対応できます。

通知クーポン選定サービスの役割

UseCaseを分離したとはいえ、マーケティング用の通知と定期通知の間には共通の処理も存在します。その共通部分を抽象化し、差異を吸収するのが「通知クーポン選定サービス」というドメインサービスの役割です。このクラスは、通知の種類に応じて適切な方法でクーポンデータを取得します。

// NotificationCouponSelector: マーケティング用通知/定期通知の違いを吸収
class NotificationCouponSelector
{
    /**
     * クーポンを選定する
     *
     * 通知の種類に応じて適切な選定方法を選択する。
     * - マーケティング用の通知: 通知に紐づくクーポンを直接返す(静的)
     * - 定期通知: ユーザーごとに動的に計算
     */
    public function select(
        ScheduledNotification $notification,
        Recipient $recipient,
        array $couponAvailabilities
    ): ?CouponData {
        // 通知の種類に応じた選定方法を選択(ドメインロジック)
        if ($notification->isMarketingNotification()) {
            return $this->selectStatic($notification, $couponAvailabilities);
        }

        return $this->selectDynamic($notification, $recipient, $couponAvailabilities);
    }

    // private メソッドとして内部実装を隠蔽
    private function selectStatic(...): CouponData { /* 静的選定 */ }
    private function selectDynamic(...): ?CouponData { /* 動的選定 */ }
}

ここで重要なのは、UseCaseが selectStatic() と selectDynamic() のどちらを呼ぶか判断しないことです。通知の種類に応じた選定方法の選択はドメインサービス内で行われます。UseCaseは統一された select() メソッドを呼び出すだけで、「どのように取得するか」を意識する必要がありません。これにより、ドメインロジックがUseCaseに漏れ出すことを防いでいます。


4. 今後起きる"変更"に耐えうる設計

DDDの真価は、将来の変更への対応力にあります。想定される要件変更を例に、どのように対応できるかを示します。

4.1 要件例: 企業非表示制限設定

「企業非表示制限設定があるクーポンの場合は、該当企業ユーザーへはプッシュ通知配信できないようにする」

この要件が将来追加された場合、DDDに基づいた設計であれば以下のように対応できます。

Step 1: CouponDataにVisibility情報を追加

// CouponData Entity
final readonly class CouponData
{
    public function __construct(
        private int $couponId,
        private ?string $couponIdHash,
        private ?string $brandIdHash,
        private ?string $brandName,
        private ?int $genreId,
        private UsageLimit $usageLimit,
        private Stock $stock,
        private CouponValidityPeriod $validityPeriod,
        private CouponVisibility $visibility,  // 新規追加
    ) {
    }

    /**
     * 指定された受信者にクーポンを表示可能か
     *
     * 受信者の所属企業が表示制限に含まれていないかをチェック
     */
    public function isVisibleToRecipient(Recipient $recipient): bool
    {
        return $this->visibility->isVisibleToCompany($recipient->getCompanyId());
    }
}

Step 2: CouponVisibility Value Objectを作成

// CouponVisibility Value Object
final readonly class CouponVisibility
{
    private function __construct(
        private bool $hasCompanyRestriction,
        private array $restrictedCompanyIds,
    ) {
    }

    /**
     * 全ユーザーに表示可能(制限なし)
     */
    public static function unrestricted(): self
    {
        return new self(
            hasCompanyRestriction: false,
            restrictedCompanyIds: [],
        );
    }

    /**
     * 指定された企業IDに対して表示可能か
     */
    public function isVisibleToCompany(?int $companyId): bool
    {
        if (!$this->hasCompanyRestriction) {
            return true;
        }

        // 企業に所属していないユーザーには表示可能
        if ($companyId === null) {
            return true;
        }

        // ユーザーの所属企業IDが制限リストに含まれていないこと
        return !in_array($companyId, $this->restrictedCompanyIds, true);
    }
}

Step 3: TransitionDestinationSelectorを修正

// TransitionDestinationSelector
final class TransitionDestinationSelector
{
    public function select(
        CouponData $couponData,
        Recipient $recipient,  // 企業制限チェック用に追加
    ): ?TransitionDestination {
        // 企業制限により表示不可の場合は遷移不可(新規追加)
        if (!$couponData->isVisibleToRecipient($recipient)) {
            return null;
        }

        // ブランド情報が無効な場合は遷移不可
        if (!$couponData->hasValidBrandInfo()) {
            return null;
        }

        // クーポンが利用可能な場合はクーポン詳細へ
        if ($couponData->isAvailable()) {
            return TransitionDestination::toCouponDetail(/* ... */);
        }

        // クーポンが利用不可の場合はブランド一覧へ
        return TransitionDestination::toBrandList(/* ... */);
    }
}

注目すべきは、UseCaseの変更が不要である点です。ビジネスルールの追加はValue Objectとドメインサービスの修正で完結し、UseCaseのテストはそのまま動作します。このように、DDDに基づいた設計では新しい要件を局所的な変更で対応できるのです。

4.2 変更容易性を実現する設計原則

上記の例で示したように、DDDに基づいた設計は変更に強いです。この変更容易性は、以下の設計原則に支えられています。

原則 実現方法
開放閉鎖原則 新機能はValue Object/Entityの追加で対応
依存性逆転 UseCaseはインターフェースに依存
単一責任 各クラスが1つの責務のみ持つ

開放閉鎖原則により、既存コードを修正せずに機能を拡張できます。依存性逆転により、具体的な実装に依存せず、インターフェースを通じて柔軟に差し替えが可能です。そして単一責任により、変更の影響が局所化されます。これらの原則が組み合わさることで、「触ると何が壊れるかわからない」という恐怖から解放されるのです。


5. まとめ

リファクタリングの成果

今回のリファクタリングにより、コードの品質は大きく向上しました。以下の表は、Before/Afterの比較です。

観点 Before After
責務 6つが混在 1クラス1責務
テスト容易性 困難 各クラスで単体テスト可能
拡張性 全体に影響 局所的な変更で対応

数値だけでなく、開発者の体験も改善されました。新しい要件が来たときに「どこを修正すればいいか」が明確になり、可読性の向上とテストコードの存在により、既存コードを壊す心配を減らすことができました。

学んだこと

今回のリファクタリングを通じて、いくつかの教訓を得ました。

まず、ビジネスルールはドメイン層に置くということ。isAvailable() のような判定ロジックはEntity/Value Objectに集約することで、ルールの所在が明確になります。
次に、UseCaseは薄く保つということ。UseCaseはオーケストレーションのみを担当し、ビジネスロジックを持たせないことで、テストしやすく変更に強い設計になります。
また、Value Objectの力を実感しました。「利用回数制限」「在庫」「有効期間」のような小さな単位で責務を分離することで、各クラスがシンプルになり、再利用性も高まります。

私たちのチームではこれからもDDDのアプローチを継続し、新しい要件に対応しながらドメインモデルを改善していきたいと思います。

カンリーテックブログ

Discussion