シングルトンパターン(Singleton)をPHPで使う

はじめに
シングルトンパターンの基本概念
シングルトンパターンをPHPで実装
シングルトンパターンの利点
注意点
まとめ

はじめに

オブジェクト指向プログラミングなんかで使われる設計パターンに、デザインパターンというものがあります。

数々のエンジニアが工夫を重ねてきた設計が23種類ほどあり、その中の1つにシングルトンパターンというデザインパターンがあります。

データベース接続する際などに使うシングルトンパターンについて、今回はまとめていきます。

シングルトンパターンの基本概念

シングルトンパターンはソフトウェア開発において、特定のクラスのインスタンスが1つだけであることを保証するデザインパターンです。

これにより、特定のリソースや設定がグローバルに一貫して管理されることを可能にします。

このパターンは特にデータベース接続や設定ファイルの読み込み、ログの管理などで有用です。

シングルトンパターンの目的

シングルトンパターンの目的としては以下のようなものが挙げられます。

1.クラスのインスタンスが一つだけであることを保証
2.この唯一のインスタンスにグローバルにアクセスできる
　

シングルトンパターンの特徴

目的を達成するために、シングルトンクラスは以下のような特徴を持ちます。

1.プライベートなコンストラクタ
クラスの外部からインスタンスが作成されないようにするため。

2.静的なインスタンス
クラス内で唯一のインスタンスを保持。

3.静的なメソッド
インスタンスへのアクセスを提供する。

シングルトンパターンをPHPで実装

具体的にデータベース接続を例としてPHPでシングルトンパターンを実装してみます。

<?php
class Database {
    // 唯一のインスタンスを保持するためのプライベート静的プロパティ
    private static $instance = null;
    
    // データベース接続を保持するプロパティ
    private $connection;

    // コンストラクタはプライベートにして外部からのインスタンス化を防ぐ
    private function __construct() {
        $host = 'localhost';
        $dbname = 'my_database';
        $username = 'myname';
        $password = 'abc123';

        try {
            $this->connection = new PDO("mysql:host=$host;dbname=$dbname", $username, $password);
            $this->connection->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
        } catch (PDOException $e) {
            echo "Connection failed: " . $e->getMessage();
        }
    }

    // 唯一のインスタンスを取得するための静的メソッド
    public static function getInstance() {
        if (self::$instance === null) {
            self::$instance = new self();
        }
        return self::$instance;
    }

    // データベース接続を取得するメソッド
    public function getConnection() {
        return $this->connection;
    }

　　// クローンメソッドはプライベートにしてクローン化を防ぐ
    private function __clone() {}

    // シリアライズメソッドはプライベートにしてシリアライズを防ぐ
    private function __wakeup() {}
}

// データベース接続の取得例
$db = Database::getInstance();
$connection = $db->getConnection();

// クエリの実行例
$stmt = $connection->prepare("SELECT * FROM users");
$stmt->execute();
$results = $stmt->fetchAll(PDO::FETCH_ASSOC);

foreach ($results as $row) {
    echo $row['name'] . "<br>";
}
?>