PHP 中的 readonly：深入理解与最佳实践

一、基础概念

在 PHP 8.1 中引入的 readonly 关键字为类的属性提供了一种新的语义，用于表示这些属性是只读的。一旦一个属性被声明为 readonly，它只能在对象的构造函数中被赋值，之后不能再被修改。这有助于创建不可变的数据结构，增强数据的完整性和可维护性。

二、使用方法

（一）类属性声明

声明一个 readonly 属性非常简单，只需在属性声明前加上 readonly 关键字。

class Person {
    readonly public string $name;

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

$person = new Person('John');
// 以下代码会导致错误，因为 $name 是只读属性
// $person->name = 'Jane';

在上述示例中，$name 属性被声明为 readonly，只能在构造函数中赋值。尝试在对象创建后修改该属性会引发错误。

（二）构造函数参数声明

readonly 关键字也可以直接在构造函数参数中使用，这会自动创建一个同名的只读属性。

class Book {
    public function __construct(readonly public string $title, readonly public string $author) {
    }
}

$book = new Book('The Great Gatsby', 'F. Scott Fitzgerald');
// 以下代码会导致错误，因为 $title 和 $author 是只读属性
// $book->title = 'Another Book'; 
// $book->author = 'Another Author';

这种方式更为简洁，直接在构造函数参数处声明属性为 readonly，无需额外的属性声明。

三、常见实践

（一）不可变数据对象

使用 readonly 属性可以创建不可变的数据对象，确保对象的状态在创建后不会被意外修改。这在处理需要保持一致性的数据时非常有用，比如配置对象或表示常量数据的对象。

class Configuration {
    readonly public string $databaseHost;
    readonly public string $databaseName;
    readonly public string $databaseUser;
    readonly public string $databasePassword;

    public function __construct(string $host, string $name, string $user, string $password) {
        $this->databaseHost = $host;
        $this->databaseName = $name;
        $this->databaseUser = $user;
        $this->databasePassword = $password;
    }
}

$config = new Configuration('localhost', 'my_database', 'user', 'password');
// 确保配置在整个应用中不会被意外修改

（二）数据保护

readonly 属性可以防止外部代码意外修改重要的数据，保护对象的内部状态。例如，在一个表示用户信息的类中，用户的唯一标识符可能是只读的。

class User {
    readonly public int $id;
    public string $username;

    public function __construct(int $id, string $username) {
        $this->id = $id;
        $this->username = $username;
    }
}

$user = new User(1, 'Alice');
// 防止修改用户的唯一标识符
// $user->id = 2; // 这会导致错误

四、最佳实践

（一）与依赖注入结合

在依赖注入场景中，readonly 属性可以确保注入的依赖在对象的生命周期内不会被改变。这有助于提高代码的可测试性和可维护性。

class Logger {
    public function log(string $message) {
        echo $message.PHP_EOL;
    }
}

class Service {
    readonly private Logger $logger;

    public function __construct(Logger $logger) {
        $this->logger = $logger;
    }

    public function doSomething() {
        $this->logger->log('Something happened');
    }
}

$logger = new Logger();
$service = new Service($logger);
$service->doSomething();

（二）提高代码可读性

使用 readonly 关键字可以使代码的意图更加清晰，让阅读代码的人能够快速了解哪些属性是不可变的。

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

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

$point = new Point(10.5, 20.7);
// 从代码结构上可以清楚知道 $x 和 $y 是不可变的

五、小结

PHP 中的 readonly 关键字为开发者提供了一种强大的工具，用于创建不可变的数据结构和保护对象的内部状态。通过在类属性和构造函数参数中使用 readonly，可以提高代码的可读性、可维护性和数据的完整性。在实际开发中，结合依赖注入等设计模式，合理运用 readonly 可以打造出更加健壮和可靠的应用程序。希望本文的介绍和示例能帮助读者更好地理解和应用 PHP 中的 readonly 特性。