
前言先明確一點模板方法模式Template Method Pattern不是 PHP 8.2 的特性。它是《設計模式》里的行為型模式靠繼承和抽象類實現(xiàn)與語言版本無關。標題里帶PHP8.2的合理理解是在 PHP 8.2 環(huán)境下怎么寫本文按這個角度展開并順帶用上 PHP 8.2 新增的幾項語言能力——readonly類、DNF 類型、獨立的null/false/true類型讓代碼更緊湊也更安全。模板方法要解決的問題是流程是固定的但其中若干步驟在不同業(yè)務下實現(xiàn)不同。數(shù)據(jù)導入、支付下單、報表生成、消息推送都屬于這一類。它們的共同特征是骨架順序不能亂——導入必須先校驗再落庫支付必須先凍結再扣款再通知——但每一步的細節(jié)因渠道而異。寫法上模板方法把流程骨架放在父類的一個final方法里把可變部分聲明為abstract必須實現(xiàn)或留成有默認實現(xiàn)的鉤子方法hook method子類按需覆蓋。是父類決定什么時候調(diào)用子類而不是子類決定——這就是好萊塢原則Hollywood PrincipleDont call us, well call you。一、模板方法的四個組成角色職責約束模板方法定義流程骨架按順序調(diào)用各個步驟必須是final否則子類可以破壞流程抽象步驟每個子類都必須實現(xiàn)的差異點abstract protected不能是public鉤子方法hook有默認實現(xiàn)子類按需覆蓋的可選擴展點默認實現(xiàn)通常是空方法或恒等變換子類只實現(xiàn)/覆蓋步驟不碰流程不能重新定義步驟的調(diào)用順序判斷一個方法該做成抽象步驟還是鉤子看每個子類是不是都必須提供不同實現(xiàn)大部分子類實現(xiàn)一致的就給默認實現(xiàn)做成鉤子每個子類都不同且沒有合理默認值的才做成抽象方法。抽象方法給多了子類被迫寫一堆空方法這是模板方法最常見的失敗形態(tài)。二、用 PHP 8.2 寫一個數(shù)據(jù)導入骨架典型場景要支持 CSV 和 JSON 兩種來源但讀 → 校驗 → 變換 → 落庫 → 收尾的順序?qū)烧咭粯印?php // template-method.php —— 需要 PHP 8.2 // 用法php template-method.php declare(strict_types1); /** 只讀結果對象readonly 類是 PHP 8.2 引入的 */ final readonly class ImportReport { public function __construct( public string $source, public int $imported, public int $skipped, ) {} public function summary(): string { return sprintf(來源%-24s 成功%d 跳過%d, $this-source, $this-imported, $this-skipped); } } /** 骨架類流程在這里定死、細節(jié)交給子類run() 是 final流程不允許改寫 */ abstract class AbstractImporter { /** 模板方法固定順序不接受子類修改 */ final public function run(string $path): ImportReport { $this-beforeRun($path); // 鉤子準備階段 $imported 0; $skipped 0; try { foreach ($this-read($path) as $row) { if (!$this-validate($row)) { $skipped; // 數(shù)據(jù)問題跳過這一行 continue; } $this-persist($this-transform($row)); $imported; } } finally { $this-cleanup(); // 無論成功失敗都要收尾 } $report new ImportReport($path, $imported, $skipped); $this-afterRun($report); // 鉤子通知階段 return $report; } // —— 抽象步驟子類必須實現(xiàn) —— abstract protected function read(string $path): iterable; abstract protected function validate(array $row): bool; abstract protected function persist(array $row): void; // —— 鉤子方法有默認實現(xiàn)子類按需覆蓋 —— /** 默認只給字符串做 trim子類可以覆蓋后調(diào)用 parent */ protected function transform(array $row): array { return array_map( static fn(mixed $v): mixed is_string($v) ? trim($v) : $v, $row ); } protected function beforeRun(string $path): void {} protected function afterRun(ImportReport $report): void {} protected function cleanup(): void {} } /** CSV 實現(xiàn)只關心怎么讀 CSV和怎么落庫 */ final class CsvImporter extends AbstractImporter { private array $rows []; protected function read(string $path): iterable { $handle fopen($path, rb); if ($handle false) { throw new RuntimeException(無法打開 CSV 文件: {$path}); } try { $header fgetcsv($handle); if ($header false) { return; // 空文件生成器直接結束 } while (($line fgetcsv($handle)) ! false) { if (count($line) ! count($header)) { continue; // 列數(shù)對不上跳過這一行 } /** var arraystring, string|null $assoc */ $assoc array_combine($header, $line); yield $assoc; } } finally { fclose($handle); } } protected function validate(array $row): bool { return isset($row[name]) $row[name] ! ; } protected function persist(array $row): void { // 真實項目里這里是 INSERT示例中先緩存在內(nèi)存里 $this-rows[] $row; } protected function afterRun(ImportReport $report): void { echo 落庫行數(shù): , count($this-rows), PHP_EOL; } } /** JSON 實現(xiàn)復用同一套流程只覆蓋差異部分 */ final class JsonImporter extends AbstractImporter { protected function read(string $path): iterable { $raw file_get_contents($path); if ($raw false) { throw new RuntimeException(無法讀取 JSON 文件: {$path}); } // JSON_THROW_ON_ERROR 是 PHP 7.3 引入的 $data json_decode($raw, true, 512, JSON_THROW_ON_ERROR); if (!is_array($data)) { return; } foreach ($data as $row) { if (is_array($row)) { yield $row; } } } protected function validate(array $row): bool { return isset($row[name]) is_string($row[name]) $row[name] ! ; } protected function persist(array $row): void { // 真實項目里這里是 INSERT INTO ... } /** 覆蓋鉤子先讓父類做通用清洗再補自己的業(yè)務規(guī)則 */ protected function transform(array $row): array { $row parent::transform($row); // 不要丟掉父類行為 if (isset($row[amount])) { $row[amount] (float) $row[amount]; } return $row; } protected function beforeRun(string $path): void { echo 開始導入 JSON: , basename($path), PHP_EOL; } } // ———— 跑起來 ———— $csv sys_get_temp_dir() . /tm-demo.csv; file_put_contents($csv, name,amount\n 手機 ,1999\n,0\n耳機,299\n); $json sys_get_temp_dir() . /tm-demo.json; file_put_contents($json, json_encode([ [name 鍵盤 , amount 399.5], [name , amount 1], [name 顯示器, amount 1299], ], JSON_UNESCAPED_UNICODE)); // 兩個子類共用同一個模板方法只是傳入的文件不同 echo CsvImporter::class, PHP_EOL; echo (new CsvImporter())-run($csv)-summary(), PHP_EOL, PHP_EOL; echo JsonImporter::class, PHP_EOL; echo (new JsonImporter())-run($json)-summary(), PHP_EOL; unlink($csv); unlink($json);輸出路徑隨臨時目錄不同而變化CsvImporter 落庫行數(shù): 2 來源.../tm-demo.csv 成功2 跳過1 JsonImporter 開始導入 JSON: tm-demo.json 來源.../tm-demo.json 成功2 跳過1這段代碼有幾個設計點run()是final。這是整個模式的立身之本流程順序由父類單方面決定子類只能填空。少了final任何子類都能悄悄改掉先校驗還是先落庫而這種改動在 code review 時極難發(fā)現(xiàn)。抽象步驟是protected而不是public。persist()若設成public外部就能繞過run()直接調(diào)用流程約束形同虛設。鉤子方法提供默認無害行為。transform()默認只做 trimbeforeRun()、cleanup()默認是空方法所以新子類只需實現(xiàn)三個抽象方法。cleanup()放在finally里、read()用iterableyield。前者保證拋異常也會收尾后者讓大文件導入不必把全部行讀進內(nèi)存。PHP 8.2 語言特性在這個模式里的位置PHP 8.2 特性在模板方法里的用途readonly類把ImportReport這類產(chǎn)出物做成不可變對象避免子類在afterRun()里篡改統(tǒng)計數(shù)字DNF 類型 (AB)\C獨立的null/false/true類型鉤子返回值可直接聲明為false不必寫bool再補一句只返回 falseDNF 類型的寫法容易記錯它要求交叉類型部分必須用括號包起來形如(CountableIterator)|array。要留意的是這類交叉類型的要求很具體Generator實現(xiàn)了Iterator但不實現(xiàn)Countable所以不滿足該類型傳進去會拋TypeError。三、和直接寫兩個類比模板方法贏在哪一種常見的反對意見是既然流程一樣直接寫兩個類各復制一份不就行了短期可行長期出問題對比項各自復制的兩個類模板方法流程變更要改 N 處容易漏改一處改父類一處全部生效新增實現(xiàn)復制整個流程再改細節(jié)只實現(xiàn) 3 個抽象方法收尾/異常處理每個類各寫一遍容易漏finally在父類統(tǒng)一處理流程一致性靠約定容易被改壞由final保證測試每個類都要重測流程流程可單測父類子類只測步驟模板方法還讓流程變成可測試的實體寫一個假子類把每個步驟記下來就能斷言校驗一定發(fā)生在落庫之前。常見坑點1. 模板方法沒加final流程被某個子類悄悄改掉// ? 子類可以覆蓋 run()把先校驗改成先落庫出問題很難定位 public function run(string $path): ImportReport { /* ... */ }// ? 模板方法一律 final final public function run(string $path): ImportReport { /* ... */ }2. 抽象步驟寫成public外部可以繞過流程直接調(diào)用// ? 外部能直接 $importer-persist($row)校驗和變換全部被跳過 abstract public function persist(array $row): void;// ? 步驟只對子類開放 abstract protected function persist(array $row): void;3. 覆蓋鉤子時忘了parent::父類行為被整段丟掉// ? 父類做的通用清洗trim 等全部失效只有子類的邏輯生效 protected function transform(array $row): array { $row[amount] (float) $row[amount]; return $row; }// ? 先父后子除非你明確就是要完全替換父類行為 protected function transform(array $row): array { $row parent::transform($row); $row[amount] (float) $row[amount]; return $row; }4. 父類里用self::調(diào)用步驟子類的覆蓋沒生效// ? self:: 綁定在定義它的類上子類覆蓋 step() 也調(diào)不到 abstract class Base { final public function run(): string { return self::step(); } protected static function step(): string { return base; } } final class Child extends Base { protected static function step(): string { return child; } } echo (new Child())-run(); // 輸出 base不是 child// ? 需要子類改寫生效時用 static::晚靜態(tài)綁定 abstract class Base { final public function run(): string { return static::step(); } protected static function step(): string { return base; } }需要說明的是用$this-method()調(diào)用實例方法時走的是虛方法分派不會有這個問題這個坑只出現(xiàn)在self::調(diào)用靜態(tài)方法或靜態(tài)屬性上。5. 抽象方法給太多子類被迫實現(xiàn)一堆空方法// ? 五個抽象方法而大部分子類只關心其中兩個剩下三個只能寫空實現(xiàn) abstract protected function read(string $path): iterable; abstract protected function validate(array $row): bool; abstract protected function transform(array $row): array; abstract protected function beforeRun(string $path): void; abstract protected function cleanup(): void;// ? 只有沒有合理默認值的才做抽象方法其余做成鉤子 abstract protected function read(string $path): iterable; abstract protected function validate(array $row): bool; abstract protected function persist(array $row): void; // 其余四個給默認實現(xiàn)6. 在父類里直接new具體依賴子類無法替換// ? 測試時沒法把 HTTP 客戶端換成替身也沒法換一個日志目標 abstract class AbstractImporter { final public function run(string $path): ImportReport { $logger new FileLogger(/var/log/import.log); // ... } }// ? 依賴從構造函數(shù)注入父類只管調(diào)用 abstract class AbstractImporter { public function __construct(protected LoggerInterface $logger) {} final public function run(string $path): ImportReport { /* 用 $this-logger */ } }7. 繼承層次超過兩層模板方法變成了考古現(xiàn)場// ? 子類又被子類繼承步驟被覆蓋了三層讀代碼要先翻三代父類 class A { final public function run(): void { $this-step(); } protected function step(): void {} } class B extends A { protected function step(): void { parent::step(); /* ... */ } } class C extends B { protected function step(): void { parent::step(); /* ... */ } } // ? 保持一層繼承子類直接繼承骨架需要組合時把可變部分做成對象注入進來 final class CsvImporter extends AbstractImporter { /* 只實現(xiàn)步驟 */ }總結關注點結論模式歸屬設計模式與版本無關標題里的 8.2 指運行環(huán)境而非特性來源骨架方法必須final且只負責調(diào)用順序不負責細節(jié)抽象步驟abstract protected只放每個子類都必須不同的部分鉤子方法有默認實現(xiàn)覆蓋時記得決定要不要parent::調(diào)用方式實例方法用$this-靜態(tài)方法要留擴展點就用static::依賴 / 收尾依賴從構造函數(shù)注入收尾邏輯放在父類的finally中只有一處8.2 加成readonly類保護產(chǎn)出物DNF 類型精確表達參數(shù)結論模板方法的價值在于把流程從實現(xiàn)里抽出來并讓流程不可被破壞。判斷要不要用它只需問一句這段流程的順序是不是業(yè)務契約的一部分如果必須先校驗再落庫這樣的約束必須被保證就該用模板方法并把骨架方法寫成final如果只是幾個獨立算法換來換去、順序本身沒有約束那么組合把算法作為對象注入會比繼承更合適。另外請把抽象方法的數(shù)量壓到最低——鉤子給默認實現(xiàn)、依賴走構造函數(shù)注入、收尾放進finally做到這三條模板方法就能長期保持可讀。