PHP 8.1 readonly 属性详解：构建不可变对象的现代实践

php 8.1 引入的 `readonly` 关键字，旨在简化不可变对象的创建。它允许属性在初始化后保持不变，有效防止意外修改，减少传统 getter 方法的样板代码，并提升代码的清晰度和安全性。php 8.2 进一步引入了 `readonly` 类，使得整个类的公共属性默认为只读，为构建更健壮的应用提供了强大支持。

引言：不可变性与 readonly 属性

在软件开发中，不可变性（Immutability）是一个重要的概念，它指的是对象在创建后，其内部状态不能被修改。不可变对象带来了诸多好处，例如提高并发安全性、简化状态管理、减少错误等。然而，在 PHP 中实现不可变属性往往需要编写额外的样板代码。

为了解决这一痛点，PHP 8.1 引入了 readonly 关键字，允许开发者在属性声明时明确指定其为只读。这意味着一旦属性被初始化（通常在构造函数中），其值便不能再被修改。这一特性显著提升了代码的简洁性和安全性，为构建不可变对象提供了原生支持。

readonly 属性的核心价值

readonly 属性的主要价值体现在以下几个方面：

• 强制不可变性：readonly 关键字确保了属性在对象生命周期中，其值在初始化后不会被意外或恶意修改。这对于表示配置、ID、创建时间等不应变动的数据尤为重要。
• 减少样板代码：在 readonly 出现之前，实现不可变属性通常需要将属性声明为 private，并通过一个公共的 getter 方法来访问。readonly 属性结合构造函数属性提升（Constructor Property Promotion）可以极大地简化这一过程。
• 提高代码可读性与意图明确性：通过 readonly 关键字，开发者可以一目了然地知道某个属性是只读的，这有助于团队成员更好地理解代码的设计意图和数据流向。
• 辅助静态分析工具：编辑器和静态分析工具可以识别 readonly 属性，从而提供更准确的代码检查和建议。

readonly 与 const：关键区别解析

readonly 属性与 const（常量）都用于定义不可变的值，但它们之间存在重要的区别：

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

• 初始化时机：
  • const：常量在“编译时”定义，其值必须在代码编写阶段就确定，并且在整个应用程序生命周期中保持不变。它们不能在运行时动态赋值。
  • readonly：只读属性在“运行时”定义，通常在对象实例化时通过构造函数进行初始化。这意味着不同的对象实例可以拥有不同的只读属性值。
• 作用域：
  • const：类常量绑定到类本身，不属于任何特定的对象实例。全局常量则在全局作用域中。
  • readonly：只读属性是对象实例的一部分，其值与特定的对象实例相关联。
• 灵活性：
  • const：一旦定义，其值固定不变，无法根据运行时逻辑进行调整。
  • readonly：允许在对象创建时根据传入的参数动态设置初始值，提供了更大的灵活性。

实践演进：从手动实现到 readonly 简化

为了更好地理解 readonly 带来的便利，我们来看一下实现不可变属性的演进过程。

传统不可变属性的实现方式

在 PHP 8.1 之前，如果我们需要一个在创建后不能被修改的属性，通常会将其声明为私有，并提供一个公共的只读访问器（getter）：

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 = new DateTimeImmutable(); // 错误：不能访问私有属性

这种方式虽然实现了不可变性，但需要为每个不可变属性编写额外的私有属性声明和公共 getter 方法，增加了不少样板代码。

代悟

开发者专属的AI搜索引擎

68

查看详情

PHP 8.1 readonly 属性的应用

PHP 8.1 引入 readonly 关键字后，结合构造函数属性提升，可以大大简化上述代码：

class Foo
{
    public function __construct(
        public readonly DateTimeImmutable $createdAt = new DateTimeImmutable()
    ) { }
}

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

// 尝试修改会抛出错误：
// Fatal error: Uncaught Error: Cannot modify readonly property Foo::$createdAt
// $f->createdAt = new DateTimeImmutable();

通过 public readonly 声明，createdAt 属性在构造函数中初始化后便不可修改。代码变得更加简洁，意图也更加明确。

PHP 8.2 readonly 类的引入

PHP 8.2 更进一步，引入了 readonly 类。当一个类被声明为 readonly 时，该类中的所有公共（public）属性都将自动变为只读，无需为每个属性单独添加 readonly 关键字。

readonly class Foo
{
    public function __construct(
        public string $name,
        public DateTimeImmutable $createdAt = new DateTimeImmutable()
    ) { }
}

$f = new Foo('My Foo Instance');
echo $f->name . ' created at ' . $f->createdAt->format('Y-m-d H:i:s');

// 尝试修改 $f->name 会抛出错误：
// Fatal error: Uncaught Error: Cannot modify readonly property Foo::$name
// $f->name = 'New Name';

// 尝试修改 $f->createdAt 也会抛出错误：
// Fatal error: Uncaught Error: Cannot modify readonly property Foo::$createdAt
// $f->createdAt = new DateTimeImmutable();

readonly 类使得创建完全不可变的对象变得异常简单，尤其适用于值对象（Value Objects）或数据传输对象（DTOs）等场景。

使用 readonly 的注意事项

在使用 readonly 属性和类时，需要注意以下几点：

• 类型声明是必需的：readonly 属性必须具有明确的类型声明。
• 初始化一次：只读属性只能在声明时或在构造函数中初始化一次。一旦被赋值，就不能再次赋值。
• 不能重新赋值：尝试在构造函数之外重新赋值一个只读属性会导致 Error。
• readonly 类中的私有属性：在一个 readonly 类中，私有（private）属性虽然不能被外部访问，但其值同样只能在构造函数中初始化一次，之后也不能在类内部的其他方法中被修改。
• 不能与 static 结合：readonly 关键字不能用于静态属性。
• 不能与 unset() 结合：不能对 readonly 属性使用 unset()。

总结

PHP 8.1 引入的 readonly 属性以及 PHP 8.2 扩展的 readonly 类，是 PHP 语言在支持不可变性方面迈出的重要一步。它们提供了一种简洁、安全且高效的方式来创建不可变对象，有效减少了样板代码，提升了代码的清晰度和可维护性。通过合理利用 readonly 特性，开发者可以构建出更健壮、更易于理解和测试的 PHP 应用程序。

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