PHP readonly 关键字：构建不可变对象的现代实践

php 8.1引入的`readonly`关键字及其在8.2中扩展到类，提供了一种声明不可变属性和对象的强大机制。它允许属性仅在初始化时赋值，之后便不能修改，有效防止了意外的数据变更。本文将深入探讨`readonly`的用途、与传统实现方式的对比，以及与`const`常量的区别，并通过代码示例展示其如何简化代码并提升数据完整性。

理解 readonly 关键字及其核心价值

readonly 关键字的核心目的是帮助开发者创建不可变（immutable）对象或至少是不可变属性。这意味着一旦一个 readonly 属性被初始化赋值后，在其生命周期内将无法被再次修改。这种机制对于构建数据传输对象（DTO）、值对象（Value Objects）或任何需要保证数据完整性和一致性的场景都至关重要，它能够有效防止因意外修改属性值而引入的潜在错误。

传统实现不可变性的方式

在 readonly 关键字出现之前，要实现属性的不可变性，通常需要采用私有属性（private property）配合公共获取器（public getter）的方法。这种方式虽然有效，但会引入大量的样板代码（boilerplate code），尤其是在类中包含多个需要不可变性的属性时。

考虑以下示例，一个 Foo 类需要确保 createdAt 属性在对象创建后不可更改：

class Foo
{
    private DateTimeImmutable $createdAt;

    public function __construct()
    {
        $this->createdAt = new DateTimeImmutable();
    }

    public function getCreatedAt(): DateTimeImmutable
    {
        return $this->createdAt;
    }
}

$f = new Foo();
echo $f->getCreatedAt()->format('Y-m-d H:i:s');
// 尝试修改 $f->createdAt 将会失败，因为它是私有属性且没有setter

这种方法要求为每个不可变属性手动编写私有声明和公共获取器，增加了代码的冗余和维护成本。

立即学习“PHP免费学习笔记（深入）”；

PHP 8.1 readonly 属性的引入

PHP 8.1 引入了 readonly 关键字，可以直接应用于类的属性。通过在属性声明前加上 readonly，该属性就成为了不可变的。它只能在属性声明时或在类的构造函数中初始化赋值一次。

使用 readonly 属性，上述 Foo 类可以大大简化：

class Foo
{
    public function __construct(
        public readonly DateTimeImmutable $createdAt = new DateTimeImmutable()
    ) {
        // createdAt 属性在这里被初始化
    }
}

$f = new Foo();
echo $f->createdAt->format('Y-m-d H:i:s');

// 尝试修改 readonly 属性将会抛出错误：
// $f->createdAt = new DateTimeImmutable(); // Fatal error: Readonly property Foo::$createdAt cannot be reinitialized

这个例子展示了 readonly 属性如何减少样板代码，同时保持了属性的不可变性。现在，createdAt 属性是公共的，可以直接访问，但其值在对象实例化后不能被修改。

PHP 8.2 readonly 类的扩展

PHP 8.2 更进一步，引入了 readonly 类。当一个类被声明为 readonly 时，该类中的所有属性都将自动被视为 readonly 属性，无需为每个属性单独添加 readonly 关键字。这对于创建完全不可变的对象（如值对象）尤其有用。

Natural Language Playlist

探索语言和音乐之间丰富而复杂的关系，并使用 Transformer 语言模型构建播放列表。

67

查看详情

以下是使用 readonly 类的示例：

readonly class User
{
    public function __construct(
        public string $name,
        public DateTimeImmutable $createdAt = new DateTimeImmutable()
    ) {
        // name 和 createdAt 属性在此处被初始化
    }
}

$user = new User('Alice');
echo $user->name . ' created at ' . $user->createdAt->format('Y-m-d H:i:s');

// 尝试修改任何属性都会抛出错误：
// $user->name = 'Bob'; // Fatal error: Readonly property User::$name cannot be reinitialized
// $user->createdAt = new DateTimeImmutable(); // Fatal error: Readonly property User::$createdAt cannot be reinitialized

通过将类声明为 readonly，开发者可以更简洁地定义不可变的数据结构，确保对象一旦创建，其内部状态就无法被外部或内部方法意外更改。

readonly 与 const 常量的区别

虽然 readonly 属性和 const 常量都旨在提供不可变的值，但它们之间存在几个关键的区别：

1. 初始化时间：

   • const 常量：在“编译时”定义，其值在代码执行前就已经确定。它们是静态的，不能在运行时动态赋值。
   • readonly 属性：在“运行时”定义，通常在对象实例化（即构造函数）期间赋值。这意味着不同的对象实例可以拥有不同的 readonly 属性值。

2. 作用域：

   • const 常量：存在于全局作用域或类作用域。类常量的值绑定到类本身，而不是类的特定实例。
   • readonly 属性：绑定到类的特定实例。每个对象实例都可以有自己独立的 readonly 属性值。

3. 应用场景：

   • const 常量：适用于表示固定不变的全局配置、数学常数或在整个应用程序生命周期中保持不变的值。
   • readonly 属性：适用于表示对象状态的一部分，这些状态在对象创建后不应改变，但不同对象实例可以有不同的状态值。

注意事项与最佳实践

• 仅在构造函数中初始化： readonly 属性只能在声明时或在构造函数中进行初始化。一旦初始化完成，任何尝试修改其值的操作都将导致致命错误。
• 类型声明是强制的： readonly 属性必须具有类型声明，因为这有助于编译器和运行时环境理解其预期行为并强制执行不可变性。
• 适用于值对象和DTO： readonly 关键字是实现值对象和数据传输对象（DTO）的理想选择，它们的主要目的是封装数据并确保数据的完整性。
• 与引用类型： readonly 属性本身是不可变的，但如果它存储的是一个对象（引用类型），那么该对象内部的状态仍然可能是可变的，除非该对象本身也是不可变的（例如 DateTimeImmutable）。
• 继承： readonly 类可以被继承，但子类也必须是 readonly 的。

总结

PHP 8.1 引入的 readonly 属性和 PHP 8.2 扩展的 readonly 类是语言向更安全、更易于维护的代码迈进的重要一步。它们提供了一种简洁、高效的方式来声明不可变的数据结构，从而减少了意外修改数据的风险，降低了调试难度，并提升了代码的健壮性。通过合理利用 readonly 关键字，开发者可以编写出更具表达力、更少错误的PHP应用程序。

以上就是PHP readonly 关键字：构建不可变对象的现代实践的详细内容，更多请关注php中文网其它相关文章！