萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 單例模式完整指南:定義、實作細節、資料庫連線實戰、防止克隆與序列化

前言

單例模式確保類別在全域僅有一個實例,並提供全域存取點。在 PHP 中最常見的應用是資料庫連線管理,避免重複建立連線消耗資源。本文詳細解析單例三要素、完整實作細節、防止克隆/序列化破壞、實戰資料庫類別、以及現代依賴注入容器下的替代方案。

一、單例三要素(鐵律)

  1. 私有建構子:private function __construct(),防止外部 new Class()
  2. 靜態實例屬性:private static $instance = null;,儲存唯一實例
  3. 靜態取得方法:public static function getInstance(),延遲初始化並回傳實例

二、標準實作(PHP 8.1+ 型別提示)

<?php
declare(strict_types=1);

final class Database
{
    // 1. 靜態實例屬性
    private static ?self $instance = null;

    // 2. 私有建構子
    private function __construct(
        private string $host,
        private string $user,
        private string $pass,
        private string $dbname,
        private int $port = 3306,
        private string $charset = 'utf8mb4'
    ) {
        $this->connect();
    }

    // 3. 靜態取得方法(延遲初始化)
    public static function getInstance(string $host = 'localhost', string $user = 'root', string $pass = '', string $dbname = 'test', int $port = 3306): self
    {
        if (self::$instance === null) {
            self::$instance = new self($host, $user, $pass, $dbname, $port);
        }
        return self::$instance;
    }

    // 4. 防止克隆
    private function __clone(): void {}

    // 5. 防止序列化/反序列化破壞單例
    public function __serialize(): array
    {
        throw new \Exception('單例不可序列化');
    }
    public function __unserialize(array $data): void
    {
        throw new \Exception('單例不可反序列化');
    }

    // --- 業務方法 ---
    private \mysqli $link;

    private function connect(): void
    {
        $this->link = new \mysqli($this->host, $this->user, $this->pass, $this->dbname, $this->port);
        if ($this->link->connect_errno) {
            throw new \RuntimeException("資料庫連線失敗: {$this->link->connect_error}");
        }
        $this->link->set_charset($this->charset);
    }

    public function query(string $sql): \mysqli_result|false
    {
        return $this->link->query($sql);
    }

    public function fetchAll(string $sql): array
    {
        $res = $this->query($sql);
        return $res ? $res->fetch_all(MYSQLI_ASSOC) : [];
    }

    public function fetchOne(string $sql): array|false
    {
        $res = $this->query($sql);
        return $res ? $res->fetch_assoc() : false;
    }

    public function execute(string $sql): bool
    {
        return $this->link->query($sql);
    }

    public function lastInsertId(): int
    {
        return $this->link->insert_id;
    }

    public function close(): void
    {
        $this->link->close();
    }
}

三、使用範例

<?php
require_once 'Database.php';

// 任何地方取得同一實例
$db = Database::getInstance('localhost', 'root', 'password', 'my_db');

$users = $db->fetchAll('SELECT * FROM users WHERE status = 1 LIMIT 10');
foreach ($users as $user) {
    echo $user['name'] . "\n";
}

// 第二次呼叫回傳同一實例
$db2 = Database::getInstance();
var_dump($db === $db2); // true

四、進階:支援多資料庫連線(多例模式)

final class DatabasePool
{
    /** @var array */
    private static array $instances = [];

    private function __construct(private string $key, private \mysqli $link) {}

    public static function get(string $key, array $config): self
    {
        if (!isset(self::$instances[$key])) {
            $link = new \mysqli(
                $config['host'],
                $config['user'],
                $config['pass'],
                $config['dbname'],
                $config['port'] ?? 3306
            );
            if ($link->connect_errno) {
                throw new \RuntimeException("DB [$key] 連線失敗: {$link->connect_error}");
            }
            $link->set_charset($config['charset'] ?? 'utf8mb4');
            self::$instances[$key] = new self($key, $link);
        }
        return self::$instances[$key];
    }

    // 代理 mysqli 方法...
    public function query(string $sql): \mysqli_result|false
    {
        return $this->link->query($sql);
    }
    // ...防止克隆、序列化同單例
}

五、現代替代方案:依賴注入容器 (PSR-11)

現代框架(Laravel、Symfony、Yii2、Slim)皆使用 DI 容器管理共享實例,而非靜態單例:

<?php
// 容器設定(以 PHP-DI 為例)
$container = new \DI\Container();
$container->set(\PDO::class, function () {
    return new \PDO('mysql:host=localhost;dbname=test', 'root', 'pass');
});

// 使用
class UserRepository
{
    public function __construct(private \PDO $pdo) {}
    public function findAll(): array { /* ... */ }
}

$userRepo = $container->get(UserRepository::class); // 自動注入共享 PDO

DI 容器優於靜態單例的優點

  • 可測試性:單元測試可輕鬆替換為 Mock 物件
  • 解耦:類別不依賴具體單例類別,依賴介面
  • 生命週期控制:容器管理 singleton、prototype、request 等範圍
  • 避免全域狀態:減少隱性依賴,利於微服務遷移

六、單例模式適用與不適用場景

適用 ✅不適用 ❌
資料庫連線池、Redis 連線、Logger需保持多種狀態的服務類別
配置管理、快取管理器需並發不同參數初始化的類別
硬體裝置驅動(單一連接埠)單元測試難以隔離的場景
舊專案快速重構現代框架專案(請用 DI 容器)

結語

單例模式在 PHP 中以私有建構子 + 靜態實例 + 靜態取得方法實現,並必須防止克隆與序列化破壞。資料庫連線是經典應用場景,但現代專案強烈建議改用 DI 容器管理共享實例,獲得更好的可測試性、解耦與生命週期控制。理解單例本質與替代方案,才能在架構決策中做出最佳選擇。

copyright © 萬盛學電腦網 all rights reserved