レガシーPHPリファクタ 25:SmartyFactory::create() の採用理由 —— 公式サンプルや書籍の歴史的背景を超えて

2007年に共著として執筆した『速習Webテクニック Smarty動的Webサイト構築入門』のサンプルコードリポジトリ(ninton/smartybook)では、PHP 5.2 / Smarty 2 から PHP 8.5 / Smarty 5 への現代化を進めています。

前回の記事で、各チャプタのエンドポイントPHPにおける Smarty の初期化処理を SmartyFactory::create() へ一元化しました。本記事では、Smarty界隈で長年普及している「AppSmarty(継承アプローチ)」ではなく、なぜあえて「SmartyFactory::create()(ファクトリーアプローチ)」を採用したのか、その設計上の理由を歴史的背景とともに解説します。


1. 2つのアプローチの比較

Smartyのインスタンス生成と初期化において、代表的な2つのアプローチを比較します。

(1) AppSmarty(継承アプローチ)

Smarty界隈でよく見られる伝統的な書き方です。

class AppSmarty extends Smarty
{
    public function __construct()
    {
        parent::__construct();
        $this->setTemplateDir(SMARTY_TEMPLATE_DIR);
        $this->setCompileDir(SMARTY_COMPILE_DIR);
        $this->setCacheDir(SMARTY_CACHE_DIR);
    }
}

// 呼び出し側
$smarty = new AppSmarty();

(2) SmartyFactory::create()(ファクトリーアプローチ)

オブジェクト指向の原則である「継承よりコンポジション(委譲)」やSOLID原則に沿ったモダンなアプローチです。 https://github.com/ninton/smartybook/blob/main/app/Smarty/SmartyFactory.php

final readonly class SmartyFactory
{
    public static function create(): Smarty
    {
        $smarty = new Smarty();
        $smarty->setTemplateDir(SMARTY_TEMPLATE_DIR);
        $smarty->setCompileDir(SMARTY_COMPILE_DIR);
        $smarty->setCacheDir(SMARTY_CACHE_DIR);
        return $smarty;
    }
}

// 呼び出し側
$smarty = SmartyFactory::create();

2. 比較表

評価項目(1) AppSmarty (継承)(2) SmartyFactory::create() (ファクトリー)
デザインパターン継承 (Inheritance)ファクトリー / コンポジション (Delegation)
クラスの結合度高い (Smartyの内部構造に強く依存)低い (インスタンスを生成して返すだけ)
インスタンスの型AppSmarty (独自のサブタイプになる)Smarty (本家Smartyの純粋なインスタンス)
LSP(置換原則)の懸念あり(Smartyの仕様変更リスクを背負う)なし(本家クラスをそのまま返すため問題にならない)
モダンPHPへの適合普通非常に高い (final readonly class を活用可能)

3. なぜ「AppSmarty(継承)」が選ばれてきたのか?

当時のPHP界隈で継承アプローチが主流だったのは、Smarty公式のサンプルアプリケーションや、当時の代表的な解説書において、継承パターンが標準的なプラクティスとして紹介されていたからです。

  • 公式サンプルの存在 Smarty公式のサンプルアプリケーション(Guestbook_Smarty)では、次のように Smarty を継承したクラス定義が公式の作法として示されていました。 https://www.smarty.net/sampleapp2
class Guestbook_Smarty extends Smarty {
    function __construct() {
      parent::__construct();
      $this->setTemplateDir(GUESTBOOK_DIR . 'templates');
      // ...
    }
}

親クラスを拡張してコンストラクタでディレクトリを一括設定する手法は、当時においては「公式に推奨された正しいお作法」でした。

4. モダンな視点における「継承」の罠と「ファクトリー」の優位性

それから約20年が経過し、PHPの言語仕様(PHP 8の final readonly )やオブジェクト指向設計のベストプラクティスは大きく進化しました。長期にわたる保守・運用を見据えたとき、継承アプローチには次のような設計上の課題が生じます。

懸念点:LSP(リスコフの置換原則)とサードパーティ依存

「設定済みのSmartyが欲しいだけ」であるにもかかわらず、わざわざサブクラス(AppSmarty)を作ってしまうと、「親クラス(Smarty)の契約を本当に完璧に満たせているか」という余計な設計上の検証コストとリスクを背負うことになります。サードパーティ製ライブラリの内部仕様がバージョンアップによって変わった際、予期せぬ挙動を引き起こす原因にもなり得ます。

解決策:ファクトリーによるカプセル化と疎結合

一方、SmartyFactory::create() はクラスを拡張(継承)せず、ただ「設定を施した本家のインスタンスを組み立てて返す」だけです。

  • 生成されるインスタンスは常に純粋な Smarty そのものであるため、LSP違反の懸念が構造的に発生しません。
  • PHP 8以降の final readonly class や静的メソッドを組み合わせることで、「インスタンス化させないための、生成専用の責任を持つクラス」として安全に設計できます。

5. まとめ —— 「ムズムズ感」の正体とファクトリーへの移行判断

実は、今回のリファクタリングでも最初は AppSmarty を使って実装を進めていました。しかし、どうにもコードに「ムズムズする感覚」が拭えませんでした。

そのムズムズの正体は、「AppSmarty と少しだけ違う設定をしたいケースに出くわしたとき、過去の経験則から class AppSmarty2 extends AppSmarty とさらに派生クラスを増やしてしまいがちであり、実際にそれをやったことがあったから」でした。

そこで AI と壁打ちを行い、思い切ってファクトリーパターン(SmartyFactory::create())へとリファクタリングを行いました。

ファクトリーへの移行は、やるべきか?

エンドポイントで 素の Smarty を new しているなら、ファクトリーに集約したほうがすっきりします。

すでに AppSmarty を使っている場合は、ファクトリーへの移行は、「やったほうが望ましいが、絶対に must(必須)というほどではない」と考えています。

動いているコードを無理にすべて書き換える必要はありません。しかし、次のような兆候がある場合は話が別です。

  • class AppSmarty2 extends AppSmarty のような、継承の多重化・派生クラスがコードベース内に散見される

もしこのような状態に陥っているなら、カオスになりかけた継承関係を一度きれいに解きほぐし、SmartyFactory によるコンポジション(委譲)へ寄せ直す価値は十分にあるといえます。過去のベストプラクティスを、今のコードベースの健康状態に合わせて適切にアップデートしていきましょう。

参考コード

smartybook/app/Smarty/SmartyFactory.php at main · ninton/smartybook
Smarty動的Webサイト構築入門サンプルソース. Contribute to ninton/smartybook development by creating an account on GitHub.
レガシーPHPリファクタ 25:SmartyFactory::create() の採用理由 —— 公式サンプルや書籍の歴史的背景を超えて
Smarty動的Webサイト構築入門サンプルソース. Contribute to ninton/smartybook development by creating an account on GitHub.
タイトルとURLをコピーしました