萬盛學電腦網

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

PHP 5 魔術方法完整指南:9 大魔術方法、觸發時機、實戰應用與最佳實踐

魔術方法概覽

PHP 中以雙底線 __ 開頭的方法稱為魔術方法,在特定生命週期自動被呼叫。不可主動呼叫,保留字請勿自定同名方法。

方法觸發時機典型用途
__construct()物件實例化 new Class()初始化屬性、建立連線、註冊事件
__destruct()物件銷毀 (引用計數歸零、腳本結束)釋放資源、關閉連線、寫入日誌
__call($name, $args)呼叫不可存取的實例方法動態方法代理、API 介面轉發
__callStatic($name, $args)呼叫不可存取的靜態方法靜態工廠、Fluent 介面
__get($name)讀取不可存取的屬性唯讀屬性、虛擬屬性、資料轉換
__set($name, $value)寫入不可存取的屬性屬性驗證、自動儲存、關聯更新
__isset($name)isset()/empty() 檢查不可存取屬性配合 __get 實作虛擬屬性存在性檢查
__unset($name)unset() 不可存取屬性清除快取、解除關聯
__sleep()serialize() 序列化前清理資源句柄、指定序列化屬性清單
__wakeup()unserialize() 反序列化後重建資源連線、初始化狀態
__toString()物件被當作字串使用 (echo, print, 字串連接)物件字串表現、除錯輸出
__invoke()物件被當作函數呼叫 $obj()可呼叫物件、閉包替代、策略模式
__set_state($array)var_export() 匯出類別時自定義匯出還原邏輯
__clone()clone $obj 複製物件時深度複製、重置唯一識別碼
__debugInfo()var_dump() 輸出物件時 (PHP 5.6+)控制除錯輸出內容、隱藏敏感資料

註:原文列出 9 個,實際 PHP 5.6+ 有 16 個,以上列出完整清單。

核心魔術方法詳細範例

1. __construct() / __destruct()

<?php
class ResourceManager {
    private $handle;
    public function __construct($resourceName) {
        $this->handle = fopen($resourceName, 'w');
        echo "資源開啟\n";
    }
    public function __destruct() {
        if (is_resource($this->handle)) {
            fclose($this->handle);
            echo "資源釋放\n";
        }
    }
}
$obj = new ResourceManager('log.txt');
// 腳本結束或 unset($obj) 時自動呼叫 __destruct
?>

2. __get / __set / __isset / __unset (屬性重載)

<?php
class Entity {
    private $data = [];
    private $changed = [];

    public function __get($name) {
        if (array_key_exists($name, $this->data)) {
            return $this->data[$name];
        }
        // 可拋出例外或回傳 null
        return null;
    }

    public function __set($name, $value) {
        $this->data[$name] = $value;
        $this->changed[$name] = true; // 標記髒資料
    }

    public function __isset($name) {
        return isset($this->data[$name]);
    }

    public function __unset($name) {
        unset($this->data[$name], $this->changed[$name]);
    }

    public function getChanged() { return $this->changed; }
}

$e = new Entity();
$e->name = 'John';      // 觸發 __set
echo $e->name;          // 觸發 __get → John
echo isset($e->name);   // 觸發 __isset → true
unset($e->name);        // 觸發 __unset
echo isset($e->name);   // false
?>

3. __call / __callStatic (方法重載)

<?php
class APIClient {
    private $endpoint = 'https://api.example.com/';

    public function __call($method, $args) {
        // 動態代理所有未定義方法至 API endpoint
        $url = $this->endpoint . $method;
        // 實際應用使用 cURL/Guzzle 發送請求
        return "Calling $url with args: " . json_encode($args);
    }

    public static function __callStatic($method, $args) {
        return "Static call to $method";
    }
}

$api = new APIClient();
echo $api->getUser(123);        // Calling https://api.example.com/getUser ...
echo APIClient::ping();         // Static call to ping
?>

4. __toString()

<?php
class User {
    public $name;
    public function __construct($name) { $this->name = $name; }
    public function __toString() {
        return "User: {$this->name}";
    }
}
$user = new User('Alice');
echo $user; // 自動呼叫 __toString() → User: Alice
// 注意:__toString 必須回傳字串,否則拋出 E_RECOVERABLE_ERROR
?>

5. __clone() 深度複製

<?php
class Profile {
    public $name;
    public $tags = [];
    public function __construct($name) { $this->name = $name; }
    public function __clone() {
        // 深度複製 tags 陣列
        $this->tags = array_map(function($t) { return clone $t; }, $this->tags);
        // 重置唯一 ID
        $this->id = uniqid();
    }
}
$p1 = new Profile('John');
$p2 = clone $p1; // 觸發 __clone()
?>

6. __sleep / __wakeup 序列化控制

<?php
class DBConnection {
    public $dsn;
    public $user;
    public $password;
    private $pdo; // PDO 物件無法序列化

    public function __construct($dsn, $user, $pass) {
        $this->dsn = $dsn; $this->user = $user; $this->password = $pass;
        $this->connect();
    }

    private function connect() {
        $this->pdo = new PDO($this->dsn, $this->user, $this->password);
    }

    // 序列化前:只儲存連線參數,排除 $pdo
    public function __sleep() {
        return ['dsn', 'user', 'password'];
    }

    // 反序列化後:重新建立連線
    public function __wakeup() {
        $this->connect();
    }
}
?>

7. __invoke() 可呼叫物件

<?php
class Multiplier {
    private $factor;
    public function __construct($factor) { $this->factor = $factor; }
    public function __invoke($value) {
        return $value * $this->factor;
    }
}
$double = new Multiplier(2);
echo $double(5); // 10 (呼叫 $double(5) 觸發 __invoke)
// 可用於 array_map, usort 等接受 callable 的函數
$arr = [1,2,3];
print_r(array_map(new Multiplier(10), $arr)); // [10,20,30]
?>

8. __debugInfo() 除錯資訊控制 (PHP 5.6+)

<?php
class SecureUser {
    public $username;
    private $passwordHash;
    private $apiKey;

    public function __construct($u, $p, $k) {
        $this->username = $u; $this->passwordHash = $p; $this->apiKey = $k;
    }

    public function __debugInfo() {
        return [
            'username' => $this->username,
            'password' => '********', // 隱藏敏感資訊
            'apiKey' => substr($this->apiKey, 0, 4) . '****',
        ];
    }
}
$user = new SecureUser('john', 'hash123', 'sk_live_abcdef');
var_dump($user);
/* 輸出不含真實 passwordHash 完整值 */
?>

__autoload() 與現代自動載入 (補充)

__autoload() 已棄用 (PHP 7.2) 並移除 (PHP 8.0)。現代標準為 PSR-4 自動載入 配合 Composer:

// composer.json
{
    "autoload": {
        "psr-4": {
            "App\\": "src/"
        }
    }
}
// 執行 composer dump-autoload
// 專案啟動 require_once 'vendor/autoload.php'; 即可自動載入

魔術方法使用黃金法則

  1. 明確語意:只在真正需要「攔截不可存取成員」或「生命週期鉤子」時使用。
  2. 文件化:使用 @property, @method 註解讓 IDE 支援自動完成。
  3. 效能:魔術方法有呼叫開銷,高頻路徑避免使用。
  4. 封裝性:__get/__set 不要破壞封裝,內部仍用私有屬性儲存。
  5. 序列化安全:__sleep 必須排除資源、連線、閉包等不可序列化屬性。

結語

魔術方法是 PHP 物件模型的強大擴充,賦予類別「元編程」能力。掌握 16 個魔術方法的觸發時機與正確用法,能實作出優雅的 ActiveRecord、動態代理、資源管理、可序列化物件等進階模式。但請謹記:魔力越大,責任越重,濫用會導致難以除錯的隱性行為。

copyright © 萬盛學電腦網 all rights reserved