PHP 魔术方法 - __sleep()

封面图 • 2025-10-28 • PHP

在 PHP 中，**魔术方法（Magic Methods）** 是一些具有特殊用途的函数，它们以双下划线 `__` 开头。其中，`__sleep()` 是一个非常有用的魔术方法，用于在对象被 **序列化（serialize）** 之前执行某些操作。

---

## ✅ `__sleep()` 方法的作用

当使用 `serialize($object)` 函数将一个对象转换为字符串时，PHP 会自动调用该对象的 `__sleep()` 方法。

> ⚠️ 注意：`__sleep()` 必须返回一个数组，其中包含对象中希望被序列化的属性名列表。如果 `__sleep()` 没有返回任何值，或者返回的不是数组，会导致错误。

---

## 🧠 `__sleep()` 的典型用途

- **清理资源**：比如关闭数据库连接、文件句柄等。
- **限制序列化属性**：只序列化部分属性，避免敏感数据泄露。
- **自定义序列化逻辑**：根据需要对属性进行处理后再序列化。

---

## 💡 示例代码

```php
class User {
    public $name;
    private $password;
    private $dbConnection;

public function __construct($name, $password) {
        $this->name = $name;
        $this->password = $password;
        // 假设这里有一个数据库连接
        $this->dbConnection = new PDO("mysql:host=localhost;dbname=test", "user", "pass");
    }

public function __sleep() {
        // 只序列化 name 属性
        return ['name'];
    }

public function __wakeup() {
        // 在反序列化时重新建立数据库连接
        $this->dbConnection = new PDO("mysql:host=localhost;dbname=test", "user", "pass");
    }
}

$user = new User("Alice", "secret");
$serialized = serialize($user);
echo $serialized;

// 反序列化
$unserialized = unserialize($serialized);
echo $unserialized->name; // 输出: Alice
// echo $unserialized->password; // 报错：不可访问的私有属性
```

---

## 🔁 相关魔术方法

| 魔术方法 | 描述 |
|----------|------|
| `__sleep()` | 序列化前调用 |
| `__wakeup()` | 反序列化后调用 |
| `__destruct()` | 对象销毁时调用 |
| `__toString()` | 对象被当作字符串使用时调用 |

---

## 📌 小结

- `__sleep()` 在对象被 `serialize()` 时调用。
- 它应该返回一个数组，列出要被序列化的属性。
- 通常用于清理资源或限制序列化内容。
- 和 `__wakeup()` 配合使用，可以实现更安全的对象反序列化。

如果你有具体的使用场景或问题，欢迎继续提问！