FactoryMethodパターンを理解した気になる

※前提
PHP（Laravel）で実装しています。

デザインパターンを勉強するときに、[こちらの記事](https://refactoring.guru/ja/design-patterns/factory-method)をよく参考にするのですが、今回はFactory Methodパターンについて学ぶ機会があったのでまとめます。

デザインパターンの書籍や記事は体感Javaで書かれていることが多いイメージですが、私は業務でJavaをほとんど書いたことがないので、今回は言語はPHPで動かしてみます。

## Factory Methodパターンってなにもの？
Factory Methodパターンは23種類あるデザインパターンのうち、生成系に分類されるデザインパターンの一種です。一言で言うと、

**スーパークラスでオブジェクトを作成するためのインターフェースが決まっている。 しかし、 サブクラスでは作成されるオブジェクトの型を変更することができる。**
とか、

**具体的なオブジェクトの生成をサブクラスに任せることで、親クラスとサブクラスの間の疎結合を実現する。**

といった説明があるのですが、いまいちピンとこなかったので、実際に書きながら説明します。結論、確かに1言でまとめると↑のようになります。笑

## 今回の例
今回は、「通知機能を持つアプリケーションの作成」という例で説明します。具体的には、
- アプリケーションを作成する段階で**Eメール通知**と**SMS通知**の機能を実装することが決まっている。
- 少したって、**Slack**による通知もしたいという要望もあり、追加でSlack通知の実装も必要なった。
- さらに追加の通知機能を実装することがこの先もありそう...

といった状況・要件だと仮定します。
つまり作成する機能は
1. Eメール通知機能
2. SMS通知機能
3. Slack通知機能
4. その他通知機能

です。これをFactory Methodパターンを利用して実現していきます。

## 実装例
まず、完成系のコードを下図に示します。（PHP（Laravel）で試しています。）

![スクリーンショット 2024-06-22 17.32.59.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3655825/d1f8ee8c-b945-0831-b3f6-7b58637c9403.png)

細かいディレクトリ構成は一旦置いておいて、まず`app/Notifications`ディレクトリを作成して`Notification.php`（インターフェース）と、　`〇〇Notification.php`（実装クラス）を用意します。
インターフェースは`send(string $message)`メソッドを持ち、引数のメッセージを受け取って　send（送る）機能を持ちます。
``` 〇〇Notification.php
<?php

namespace App\Notifications;

interface Notification
{
    public function send(string $message);
}
```
その他の実装クラス（例えば`EmailNotification`）ではNotificationインターフェースを委譲して、send()メソッドを実装します。今回はわかりやすくするためにロジックは単純に`echo $message;`とします。
```EmailNotification.php
<?php

namespace App\Notifications;

class EmailNotification implements Notification
{
    public function send(string $message)
    {
        echo "Sending Email: " . $message;
    }
}
```
次に`app/Factories`ディレクトリを作成して、そこに　`NotificationFactory.php`（抽象クラス）と`〇〇NotificationFactory.php`（具象クラス）を作成します。抽象クラスでは`createNotification()`（抽象メソッド）と`sendNotification()`（のちにコントローラー側から呼び出す）メソッドを定義しておきます。
```NotificationFactory.php
<?php

namespace App\Factories;

use App\Notifications\Notification;

abstract class NotificationFactory
{
    // 戻り値はNotificationインターフェース
    abstract public function createNotification(): Notification;

    public function sendNotification(string $message)
    {
        $notification = $this->createNotification();
        $notification->send($message);
    }
}
```

```EmailNotificationFactory.php
<?php

namespace App\Factories;

use App\Notifications\Notification;
use App\Notifications\EmailNotification;

// NotificationFactoryクラスを継承
class EmailNotificationFactory extends NotificationFactory
{
    // createNotification()をオーバーライドしてEmailNotificationインスタンスを返す
    public function createNotification(): Notification
    {
        return new EmailNotification;
    }
}

```

最後にコントローラー側から呼んであげます。（route/api(web).phpは追加しておいてください）（ResourceクラスやRequestクラスは省いてます）

```NotificationController.php
<?php

namespace App\Http\Controllers;

use App\Factories\EmailNotificationFactory;
use App\Factories\SMSNotificationFactory;
use App\Factories\SlackNotificationFactory;
use Illuminate\Http\Request;

class NotificationController extends Controller
{
    public function sendEmail(Request $request)
    {
        $factory = new EmailNotificationFactory;
        $factory->sendNotification('Hello via Email!');
    }

    // public function sendSMS(Request $request)
    // {
    //     $factory = new SMSNotificationFactory();
    //     $factory->sendNotification('Hello via SMS!');
    // }

    // public function sendSlack(Request $request)
    // {
    //     $factory = new SlackNotificationFactory();
    //     $factory->sendNotification('Hello via Slack!');
    // }
}

```
コントローラ側では`EmailNotificationFactory`をインスタンス化して`＄factory`に入れています。
その後、`$factory->sendNotification(message);`でオーバーライドした`createNotification()`を呼び出し、さらに`send()`でechoされるという流れですね。


実際にルートを定義して、Email,SMS、Slackのパターンを作成してみたのですが、ちゃんと表示されました。

![スクリーンショット 2024-06-22 17.49.19.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3655825/185ceadc-340a-f7f0-76f0-cfbca123be4b.png)


![スクリーンショット 2024-06-22 17.49.26.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3655825/fc7b73d5-3cde-575e-8c70-230d3ea07efb.png)

![スクリーンショット 2024-06-22 17.49.35.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3655825/eb7ae8fc-ae0e-679f-a043-0e602861e2a3.png)


 ## 流れ
 1. まずコントローラー側で`sendEmail()`が呼ばれると`EmailNotificationFactory`をインスタンス化します。（ここでまず〇〇NotificationFactoryをインスタンス化する）
 1. `EmailNotificationFactory`クラスは`NotificationFactory`を継承したクラスで、`createNotification()`をオーバーライドして、`return new EmailNotification;`しています。このサブクラスで Emailのオブジェクトを生成します。（←これが「具体的なオブジェクトの生成をサブクラスに任せる」という部分です）
 1. ↑のよって`sendNotification()`の`$notification = $this->createNotification();`の部分で`$notification`の部分には、`EmailNotification`インスタンスが入ってきます。
 1. `$notification->send($message);`は`EmailNotification`クラスの`send()`メソッドが呼ばれ`echo "Sending Email: " . 〇〇`が実行されます。


## メリット

- **SOLID原則である、"単一責任原則"を守ることができる**
Factory Methodパターンを使用するとスーパークラスの`NotificationFactory`は通知の共通の操作（sendNotification）に集中していて、サブクラス(EmailNotificationFactory)は具体的な通知の生成に集中しています。
これによって、各クラスが単一の責任に集中し、シンプルになります。
<br>

- **依存性を逆転させることができる**
これもSOLID原則の1つですが、依存性逆転の原則を守ることができます。具体的な通知方法（Eメール、SMS、Slackなど）に依存せず、抽象クラスNotificationに依存することで、コードの柔軟性と拡張性が向上します。（Laravelの場合は、サービスコンテナでもDIを実現できます）

<br>

- **新しいサブクラスの追加される時に楽になる**
この場合、新しい通知方法が追加された場合に、〇〇NotificationFactoryクラスを作成するだけで済みます。既存のコードに影響を与えずに新機能を追加できるため、拡張が容易になります。


## まとめ
Factory Methodパターンを使うことで、オブジェクト生成の責任をサブクラスに委譲し、コードの柔軟性や拡張性を高めることができます。特に、将来的に通知方法が追加される可能性がある場合には、このパターンを使用することで、コードのメンテナンス性を向上させることができます。似たようで違う考え方でStrategyパターンやTemplate methodパターンもあると思うのでそちらも追々まとめていきたいと思います。