萬盛學電腦網

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

PHP 設計模式實戰:單例模式完整指南與最佳實踐

單例模式在 PHP 中的正確姿勢

單例模式確保一個類僅有一個實例,並提供全局訪問點。在 PHP 中,由於請求隔離特性,單例的生命周期僅限於單次請求,但對資源密集型對象(數據庫連接、配置管理、日志記錄器)仍有顯著價值。

一、標準單例實現(PHP 7.4+ 推薦寫法)

<?php
declare(strict_types=1);

namespace App\Patterns;

final class DatabaseConnection {
    // 1. 私有靜態實例屬性
    private static ?self $instance = null;
    
    // 2. 私有構造函數,防止外部 new
    private function __construct(
        private string $host,
        private string $username,
        private string $password,
        private string $database,
        private int $port = 3306
    ) {
        // 實際連接邏輯
        $this->connect();
    }
    
    // 3. 私有克隆方法,防止 clone
    private function __clone(): void {
        throw new \LogicException('單例模式禁止克隆');
    }
    
    // 4. 私有反序列化方法,防止 unserialize
    public function __wakeup(): void {
        throw new \LogicException('單例模式禁止反序列化');
    }
    
    // 5. 公共靜態獲取實例方法
    public static function getInstance(string $host, string $username, string $password, string $database, int $port = 3306): self {
        if (self::$instance === null) {
            self::$instance = new self($host, $username, $password, $database, $port);
        }
        return self::$instance;
    }
    
    // 6. 實際業務方法
    public function query(string $sql): array {
        // 執行查詢...
        return [];
    }
    
    private function connect(): void {
        // PDO 連接邏輯
    }
}

// 使用方式
$db = DatabaseConnection::getInstance('localhost', 'user', 'pass', 'dbname');
$results = $db->query('SELECT * FROM users');
?>

二、支持不同配置的多實例單例(Multiton 模式)

<?php
declare(strict_types=1);

final class ConfigManager {
    /** @var array<string, self> */
    private static array $instances = [];
    
    private function __construct(
        private readonly string $environment,
        private readonly array $config
    ) {}
    
    private function __clone(): void {}
    public function __wakeup(): void {}
    
    public static function getInstance(string $environment = 'default'): self {
        if (!isset(self::$instances[$environment])) {
            $configFile = __DIR__ . "/config/{$environment}.php";
            $config = is_file($configFile) ? require $configFile : [];
            self::$instances[$environment] = new self($environment, $config);
        }
        return self::$instances[$environment];
    }
    
    public function get(string $key, mixed $default = null): mixed {
        return $this->config[$key] ?? $default;
    }
    
    public function set(string $key, mixed $value): void {
        $this->config[$key] = $value;
    }
}

// 使用
$prodConfig = ConfigManager::getInstance('production');
$devConfig = ConfigManager::getInstance('development');
?>

三、依賴注入容器中的單例(現代最佳實踐)

現代 PHP 框架(Laravel、Symfony)通過 DI 容器管理單例,而非手寫單例類:

<?php
// Laravel 服務提供者註冊
// App\Providers\AppServiceProvider.php
public function register(): void {
    $this->app->singleton(DatabaseConnection::class, function ($app) {
        return new DatabaseConnection(
            config('database.connections.mysql.host'),
            config('database.connections.mysql.username'),
            config('database.connections.mysql.password'),
            config('database.connections.mysql.database')
        );
    });
}

// 控制器中自動注入(非單例寫法,但容器保證單例)
class UserController {
    public function __construct(
        private DatabaseConnection $db // 容器自動解析單例
    ) {}
    
    public function index() {
        $users = $this->db->query('SELECT * FROM users');
        return view('users.index', compact('users'));
    }
}
?>

四、單例模式在 PHP 中的適用場景與爭議

✅ 適合場景

  • 資源密集型連接:PDO、Redis、Memcached、Elasticsearch 客戶端
  • 配置管理器:全局配置只需加載一次
  • 日志記錄器:統一日誌輸出通道
  • 緩存管理器:統一緩存操作入口
  • 事件調度器:全局事件總線

❌ 不適合/反模式場景

  • 業務邏輯類:UserService、OrderService 等應支持多實例、可測試
  • 狀態可變對象:單例的全局狀態導致測試隔離困難
  • 需並發不同配置:如多租戶不同數據庫連接
  • 單純為了「省 new」:現代 PHP 對象創建開銷極小,過度優化得不償失

五、測試友好的單例設計

<?php
final class Logger {
    private static ?self $instance = null;
    private array $logs = [];
    
    private function __construct() {}
    private function __clone() {}
    public function __wakeup() {}
    
    // 測試專用:重置實例
    public static function resetForTesting(): void {
        self::$instance = null;
    }
    
    // 測試專用:注入模擬實例
    public static function setInstance(self $instance): void {
        self::$instance = $instance;
    }
    
    public static function getInstance(): self {
        return self::$instance ??= new self();
    }
    
    public function log(string $level, string $message): void {
        $this->logs[] = "[$level] $message";
    }
    
    public function getLogs(): array {
        return $this->logs;
    }
}

// 測試代碼
class LoggerTest extends \PHPUnit\Framework\TestCase {
    protected function tearUp(): void {
        Logger::resetForTesting();
    }
    
    public function testLog() {
        $logger = Logger::getInstance();
        $logger->log('info', 'test');
        $this->assertCount(1, $logger->getLogs());
    }
    
    public function testWithMock() {
        $mockLogger = $this->createMock(Logger::class);
        Logger::setInstance($mockLogger);
        
        $mockLogger->expects($this->once())
            ->method('log')
            ->with('error', 'test error');
            
        Logger::getInstance()->log('error', 'test error');
    }
}
?>

六、PHP 請求隔離特性說明

重要:PHP 的單例生命周期 = 單次 HTTP 請求。每次請求重新初始化,不像 Java/Spring 的應用級單例。因此:

  • 無法跨請求共享狀態(需用 Redis/數據庫/文件)
  • 「避免重複 new 節省資源」僅限於單請求內多次調用
  • 長運行腳本(CLI、Swoole、RoadRunner)中單例才真正跨請求持久

七、總結:現代 PHP 單例檢查清單

  1. 類標記 final 防止繼承破壞單例
  2. 構造函數、克隆、反序列化均為 private
  3. 提供 getInstance() 靜態方法
  4. 考慮 resetForTesting() 支持單元測試
  5. 優先使用 DI 容器管理單例,而非手寫
  6. 文檔說明單例原因(資源共享、全局狀態等)
  7. 避免在單例中存儲請求級狀態(用戶信息、請求數據)
copyright © 萬盛學電腦網 all rights reserved