魔術方法是 PHP 面向對象的特有特性,以雙下劃線 `__` 開頭,在特定生命週期或操作時自動觸發。本文系統梳理 12 個魔術方法的觸發條件、參數、返回值與實戰應用場景。
| 方法 | 觸發時機 | 典型用途 | 返回值要求 |
|---|---|---|---|
| __construct | 實例化對象時 | 初始化屬性、依賴注入 | 無 |
| __destruct | 對象銷毀/腳本結束 | 釋放資源、關閉連接、寫日誌 | 無 |
| __get | 讀取不可訪問/不存在屬性 | 動態屬性、代理訪問、懶加載 | 屬性值 |
| __set | 寫入不可訪問/不存在屬性 | 屬性驗證、日誌記錄、虛擬屬性 | 無 |
| __isset | isset()/empty() 檢測不可訪問屬性 | 動態屬性存在性判斷 | bool |
| __unset | unset() 不可訪問屬性 | 清理動態屬性、緩存失效 | 無 |
| __call | 調用不可訪問/不存在實例方法 | 方法代理、動態方法、API 客戶端 | 任意 |
| __callStatic | 調用不可訪問/不存在靜態方法 | 靜態工廠、門面模式 | 任意 |
| __sleep | serialize() 序列化前 | 指定序列化屬性、關閉資源 | string[] 屬性名數組 |
| __wakeup | unserialize() 反序列化後 | 重建連接、初始化資源 | 無 |
| __clone | clone 關鍵字複製對象時 | 深拷貝、重置標識、解除引用 | 無 |
| __toString | 對象作為字符串使用時 | 友好顯示、調試輸出 | string |
| __invoke | 對象作為函數調用時 | 可調用對象、閉包替代、策略模式 | 任意 |
| __set_state | var_export() 導出類時 (static) | 還原對象狀態、單例模式 | object |
| __debugInfo | var_dump() 輸出對象時 (PHP 5.6+) | 隱藏敏感屬性、自定義調試視圖 | array |
<?php
class MagicDemo {
public $publicProp = 'public';
protected $protectedProp = 'protected';
private $privateProp = 'private';
private $dynamicData = [];
public function __construct() {
echo "__construct: 對象創建\n";
}
public function __destruct() {
echo "__destruct: 對象銷毀\n";
}
public function __set(string $name, $value): void {
echo "__set: 設置 \$this->$name = " . var_export($value, true) . "\n";
$this->dynamicData[$name] = $value;
}
public function __get(string $name): mixed {
echo "__get: 讀取 \$this->$name\n";
return $this->dynamicData[$name] ?? null;
}
public function __isset(string $name): bool {
echo "__isset: 檢查 \$this->$name\n";
return isset($this->dynamicData[$name]);
}
public function __unset(string $name): void {
echo "__unset: 刪除 \$this->$name\n";
unset($this->dynamicData[$name]);
}
public function __call(string $name, array $arguments): mixed {
echo "__call: 調用 $name(" . implode(', ', $arguments) . ")\n";
return "Called $name with " . count($arguments) . " args";
}
public static function __callStatic(string $name, array $arguments): mixed {
echo "__callStatic: 靜態調用 $name(" . implode(', ', $arguments) . ")\n";
return "Static $name called";
}
public function __sleep(): array {
echo "__sleep: 準備序列化\n";
return ['publicProp', 'dynamicData']; // 僅序列化這些屬性
}
public function __wakeup(): void {
echo "__wakeup: 反序列化恢復\n";
$this->dynamicData['restored'] = true;
}
public function __clone(): void {
echo "__clone: 對象克隆\n";
$this->publicProp .= '_cloned';
}
public function __toString(): string {
return "__toString: MagicDemo@" . spl_object_id($this);
}
public static function __set_state(array $properties): object {
echo "__set_state: var_export 還原\n";
$obj = new self();
foreach ($properties as $k => $v) $obj->$k = $v;
return $obj;
}
public function __debugInfo(): array {
echo "__debugInfo: var_dump 定制\n";
return [
'public' => $this->publicProp,
'dynamic_keys' => array_keys($this->dynamicData),
'hidden' => '***PROTECTED***' // 隱藏敏感信息
];
}
}
// 測試所有魔術方法
$obj = new MagicDemo(); // __construct
$obj->dynamic = 'test'; // __set
echo $obj->dynamic; // __get
isset($obj->dynamic); // __isset
unset($obj->dynamic); // __unset
$obj->undefinedMethod(1, 2); // __call
MagicDemo::staticMethod('test'); // __callStatic
$serialized = serialize($obj); // __sleep
$unserialized = unserialize($serialized); // __wakeup
$cloned = clone $obj; // __clone
echo $obj; // __toString
$obj(); // __invoke
eval('$restored = ' . var_export($obj, true) . ';'); // __set_state
var_dump($obj); // __debugInfo
?>
<?php
class Model {
private $attributes = [];
private $original = [];
public function __get($name) {
return $this->attributes[$name] ?? null;
}
public function __set($name, $value) {
$this->attributes[$name] = $value;
}
public function isDirty($name = null) {
if ($name) return ($this->attributes[$name] ?? null) !== ($this->original[$name] ?? null);
return $this->attributes !== $this->original;
}
public function syncOriginal() { $this->original = $this->attributes; }
}
?>
<?php
class QueryBuilder {
private $query = [];
public function __call($method, $args) {
$this->query[$method] = $args;
return $this; // 鏈式調用
}
public function __invoke() {
return $this->build();
}
private function build() { /* 生成 SQL */ return 'SELECT * FROM users'; }
}
$sql = (new QueryBuilder())->select('*')->from('users')->where('id', 1)->orderBy('name')->();
?>
<?php
class SecureModel {
private $passwordHash;
private $apiToken;
public $username;
public function __sleep(): array {
// 排除敏感字段
return ['username']; // 只序列化 username
}
public function __wakeup(): void {
// 反序列化後重新初始化敏感字段
$this->passwordHash = null;
$this->apiToken = null;
}
}
?>
__get 遞歸調用導致無限循環:訪問不存在屬性觸發 __get,內部再訪問同屬性__sleep 返回父類私有屬性名導致錯誤:只能返回當前類可見屬性__wakeup 中依賴外部資源 (DB 連接) 可能失效__debugInfo 隱藏密碼、Token 等敏感信息__serialize/__unserialize (PHP 7.4+) 替代舊版序列化機制