PHP Readonly Properties：不可变对象设计

PHP Readonly Properties：打造你的金钟罩，让对象“坚如磐石”！

各位观众老爷们，大家好！👋 今天咱们来聊点儿高阶玩意儿，但保证不烧脑，反而会让你的代码功力瞬间提升一个档次！那就是PHP的 Readonly Properties，中文名叫“只读属性”。

想象一下，你辛辛苦苦创建了一个对象，里面装着珍贵的数据，结果一不小心，被别人给篡改了！😱 就像你精心雕刻的玉石，被人偷偷地划了一刀，心疼不？

Readonly Properties 就相当于给你的对象穿上了一件金钟罩，任何人都休想轻易修改它内部的数据。它能让你的对象变得 不可变 (Immutable)，坚如磐石，稳定可靠！

为什么我们需要不可变对象？

在深入探讨 Readonly Properties 的用法之前，咱们先来聊聊为什么要费这么大劲儿，让对象不可变？

• 避免意外修改： 这是最直接的好处。想想看，如果你写了一个处理金钱的类，里面的金额属性被人不小心改成了负数，那岂不是要赔死？不可变对象可以有效防止这种意外发生。
• 更容易推理和调试： 不可变对象的状态是固定的，你不用担心它在程序的某个地方被悄悄地改变了。这使得代码的逻辑更加清晰，调试起来也更加轻松。就像你有一个不变的参照物，总能知道对象最初的状态。
• 线程安全： 在多线程环境下，多个线程可以同时访问不可变对象，而无需担心数据竞争的问题。这极大地简化了并发编程的复杂度。想象一下，多个线程同时读取同一本书，总比同时在一张纸上涂写要安全得多吧？
• 更适合函数式编程： 函数式编程强调无副作用，而不可变对象是实现无副作用的重要基础。如果你想尝试函数式编程，那么掌握不可变对象是必不可少的。

Readonly Properties：闪亮登场！

PHP 8.1 引入了 Readonly Properties，让我们能够轻松地创建不可变对象。使用方法非常简单，只需要在属性声明前加上 readonly 关键字即可。

class Point {
    public readonly int $x;
    public readonly int $y;

    public function __construct(int $x, int $y) {
        $this->x = $x;
        $this->y = $y;
    }
}

$point = new Point(10, 20);

echo $point->x; // 输出：10

// 尝试修改 readonly 属性，会抛出 Error 异常
try {
    $point->x = 30;
} catch (Error $e) {
    echo "错误：不能修改 readonly 属性！n"; // 输出：错误：不能修改 readonly 属性！
}

看到了吗？一旦属性被声明为 readonly，除了在构造函数中初始化之外，任何地方都不能修改它的值！就像给属性上了锁，只有创建者才能设置初始值。

Readonly Properties 的限制

当然，Readonly Properties 也不是万能的，它有一些限制需要注意：

• 只能在构造函数或属性声明时初始化： readonly 属性必须在对象创建时或属性声明时赋值，之后就不能再修改了。
• 不能在魔术方法 __set() 中修改： 如果你定义了 __set() 方法，尝试在其中修改 readonly 属性，同样会抛出错误。
• 只能用于属性，不能用于方法或类常量： readonly 关键字只能修饰类的属性，不能用于方法或类常量。

Readonly Properties 的应用场景

Readonly Properties 在很多场景下都非常有用，下面是一些常见的应用场景：

• 值对象 (Value Object)： 值对象表示一个不可变的概念，例如货币、日期、颜色等。使用 Readonly Properties 可以确保值对象的完整性和一致性。
• 数据传输对象 (Data Transfer Object, DTO)： DTO 用于在不同的系统或层之间传递数据。使用 Readonly Properties 可以防止数据在传输过程中被意外修改。
• 配置对象： 配置对象存储应用程序的配置信息。使用 Readonly Properties 可以确保配置信息在运行时不会被修改。
• 缓存对象： 缓存对象存储计算结果，以便后续使用。使用 Readonly Properties 可以确保缓存对象的数据一致性。

Readonly Properties vs Const 关键字

你可能会问，PHP 还有 const 关键字，也可以定义常量，那 Readonly Properties 和 const 有什么区别呢？

特性	const	readonly
作用域	类常量	对象属性
初始化时间	编译时	运行时
可变性	绝对不可变，值必须是字面量或常量表达式	对象创建后不可变，但值可以是任何表达式或对象
使用场景	定义类级别的常量，例如版本号、数学常数等	定义对象级别的不可变属性，例如 ID、名称等

简单来说，const 用于定义类级别的常量，在编译时就确定了值，而 readonly 用于定义对象级别的不可变属性，在运行时初始化。

更深入的探讨：浅拷贝与深拷贝

使用 Readonly Properties 可以确保对象本身的数据不可变，但这并不意味着对象内部的引用类型属性也是不可变的。

class Address {
    public string $street;

    public function __construct(string $street) {
        $this->street = $street;
    }
}

class Person {
    public readonly string $name;
    public readonly Address $address;

    public function __construct(string $name, Address $address) {
        $this->name = $name;
        $this->address = $address;
    }
}

$address = new Address("某某大街1号");
$person = new Person("张三", $address);

// 修改 Address 对象的 street 属性
$address->street = "某某大街2号";

echo $person->address->street; // 输出：某某大街2号

在这个例子中，Person 对象的 address 属性是 readonly 的，但是 Address 对象本身是可以被修改的。这就是所谓的 浅拷贝 (Shallow Copy)，只复制了对象的引用，而不是对象本身。

如果想要实现真正的不可变，需要使用 深拷贝 (Deep Copy)，复制对象的所有属性，包括引用类型的属性。

class Address {
    public readonly string $street;

    public function __construct(string $street) {
        $this->street = $street;
    }

    // 深拷贝方法
    public function __clone() {
        // 不需要做任何操作，因为 Address 对象本身就是不可变的
    }
}

class Person {
    public readonly string $name;
    public readonly Address $address;

    public function __construct(string $name, Address $address) {
        $this->name = $name;
        // 深拷贝 Address 对象
        $this->address = clone $address;
    }
}

$address = new Address("某某大街1号");
$person = new Person("张三", $address);

// 修改 Address 对象的 street 属性
$address->street = "某某大街2号";

echo $person->address->street; // 输出：某某大街1号

在这个例子中，我们在 Person 类的构造函数中使用了 clone 关键字，对 Address 对象进行了深拷贝。这样，即使修改了原始的 Address 对象，也不会影响 Person 对象的 address 属性。

实际案例：打造一个不可变的配置类

咱们来用 Readonly Properties 打造一个不可变的配置类，模拟一个数据库连接配置：

class DatabaseConfig {
    public readonly string $host;
    public readonly string $username;
    public readonly string $password;
    public readonly string $database;
    public readonly int $port;

    public function __construct(
        string $host,
        string $username,
        string $password,
        string $database,
        int $port = 3306
    ) {
        $this->host = $host;
        $this->username = $username;
        $this->password = $password;
        $this->database = $database;
        $this->port = $port;
    }

    // 可以添加一些获取配置信息的方法，但不能修改属性

    public function getDsn(): string {
        return "mysql:host={$this->host};port={$this->port};dbname={$this->database}";
    }

    public function getCredentials(): array {
        return [
            'username' => $this->username,
            'password' => $this->password,
        ];
    }
}

// 创建配置对象
$config = new DatabaseConfig(
    'localhost',
    'root',
    'password',
    'mydatabase'
);

// 获取数据库连接信息
$dsn = $config->getDsn();
$credentials = $config->getCredentials();

echo "DSN: " . $dsn . "n";
echo "Username: " . $credentials['username'] . "n";

// 尝试修改配置，会抛出错误
try {
    $config->host = '127.0.0.1';
} catch (Error $e) {
    echo "错误：不能修改 readonly 属性！n";
}

这个配置类使用了 Readonly Properties，确保数据库连接信息在创建后不会被修改。这可以防止恶意代码或意外错误修改数据库连接信息，从而保证应用程序的安全性。

总结

Readonly Properties 是 PHP 8.1 引入的一项非常实用的功能，它可以帮助我们轻松地创建不可变对象，提高代码的可靠性和可维护性。

记住，使用 Readonly Properties 就像给你的对象穿上了一件金钟罩，让它们坚如磐石！💪

希望这篇文章能够帮助你更好地理解和使用 Readonly Properties。 感谢大家的观看，我们下期再见！ 😉