在 php 8.1 发布之后,
readonly属性无疑成为了许多开发者心头好。它强制了属性在初始化后不可更改,这对于构建可靠的不可变对象(immutable objects)和值对象(value objects)来说简直是福音。想象一下,你的
user对象、
order对象或者
configuration对象,一旦创建,其核心属性就无法被意外修改,这大大提升了代码的健壮性和可预测性。
然而,在实际开发中,我们常常会遇到一个看似矛盾的需求:我有一个不可变对象,但我想基于它创建一个“新版本”,仅仅修改其中一两个属性,而保持原始对象不变。例如,一个
Post对象,我想创建一个新的
Post实例,它拥有相同的内容,但标题略有不同。
class Post
{
public readonly string $title;
public readonly string $author;
public readonly string $content;
public function __construct(string $title, string $author, string $content)
{
$this->title = $title;
$this->author = $author;
$this->content = $content;
}
}
$originalPost = new Post('旧标题', '张三', '这是一篇旧文章的内容。');
// 试图克隆并修改标题,但 readonly 属性不允许重新赋值!
// $newPost = clone $originalPost;
// $newPost->title = '新标题'; // 这会抛出错误!直接对
readonly属性进行重新赋值显然是不被允许的。那么,难道每次都需要手动创建一个全新的对象,把所有未修改的属性一一复制过去吗?这不仅繁琐,而且容易出错,尤其当对象属性很多时,简直是噩梦。这种“克隆并修改”的需求,在函数式编程范式中被称为“withers”方法,它允许我们基于现有对象创建新对象,同时修改特定属性。
救星驾到:spatie/php-cloneable
正当我为这种重复而无趣的代码感到沮丧时,开源社区再次展现了它的强大力量。
spatie/php-cloneable这个 Composer 包,正是为了解决 PHP 8.1 中
readonly属性的克隆难题而生。它提供了一个简洁优雅的 Trait,让你能够轻松地实现带有修改功能的克隆。
这个包的核心思想是:通过一个
with方法,以“不可变更新”的方式,基于当前对象创建一个新的对象实例,并允许你指定要修改的属性值。
立即学习“PHP免费学习笔记(深入)”;
如何使用 spatie/php-cloneable
首先,通过 Composer 轻松安装它:
composer require spatie/php-cloneable
接下来,在你的类中引入
Spatie\Cloneable\CloneableTrait 即可:
use Spatie\Cloneable\Cloneable;
class Post
{
use Cloneable; // 引入 Cloneable Trait
public readonly string $title;
public readonly string $author;
public readonly string $content;
public function __construct(string $title, string $author, string $content)
{
$this->title = $title;
$this->author = $author;
$this->content = $content;
}
}
$originalPost = new Post('旧标题', '张三', '这是一篇旧文章的内容。');
// 现在,我们可以使用 with 方法来创建一个新 Post 实例,并修改其标题
$newPost = $originalPost->with(title: '新标题'); // 注意:这里必须使用命名参数!
echo "原始文章标题: " . $originalPost->title . PHP_EOL; // 输出: 旧标题
echo "新文章标题: " . $newPost->title . PHP_EOL; // 输出: 新标题
// 也可以同时修改多个属性
$postByLiSi = $originalPost->with(title: '李四的文章', author: '李四');
echo "李四的文章标题: " . $postByLiSi->title . ", 作者: " . $postByLiSi->author . PHP_EOL;
// 为了更好的可读性和封装性,你可以在类中定义特定的 with* 方法
class PostWithHelpers
{
use Cloneable;
public readonly string $title;
public readonly string $author;
public readonly string $content;
public function __construct(string $title, string $author, string $content)
{
$this->title = $title;
$this->author = $author;
$this->content = $content;
}
public function withTitle(string $title): self
{
return $this->with(title: $title);
}
public function withAuthor(string $author): self
{
return $this->with(author: $author);
}
}
$anotherPost = new PostWithHelpers('原创标题', '王五', '内容...');
$modifiedPost = $anotherPost->withTitle('修改后的标题')->withAuthor('赵六');
echo "修改后的文章标题: " . $modifiedPost->title . ", 作者: " . $modifiedPost->author . PHP_EOL;spatie/php-cloneable的
with方法会在底层创建一个新的对象实例,然后将原始对象的所有属性复制过去,最后再用你提供的参数覆盖对应的属性。由于它在内部巧妙地处理了
readonly属性的限制,你无需担心任何错误。
优势与实际应用效果
-
优雅地处理不可变对象更新: 这是其最核心的优势。它让 PHP 8.1 的
readonly
属性与“克隆并修改”的需求完美结合,避免了手动复制属性的繁琐和潜在错误。 -
代码更清晰、意图更明确: 使用
with(propertyName: $value)
或自定义的withPropertyName($value)
方法,代码的意图一目了然,明确表示我们正在基于现有对象创建一个新版本。 -
提高代码可维护性: 当你的对象属性发生变化时,你只需要修改
with
方法的调用或对应的with*
辅助方法,而不需要修改所有手动复制属性的地方。 -
适用于多种场景: 无论是构建值对象、配置对象,还是在 DDD 中处理聚合根的不可变状态,
spatie/php-cloneable
都能提供极大的便利。它让你的代码在享受readonly
带来的安全性的同时,保持了应有的灵活性。
小提示
需要注意的是,
spatie/php-cloneable的
with方法执行的是浅克隆。这意味着如果你的对象中包含其他对象引用,那么这些嵌套的对象并不会被递归克隆,而是会共享同一个引用。在大多数情况下这已经足够,但如果需要深克隆,你可能需要额外的处理。
总结
spatie/php-cloneable是一个虽小但功能强大的 Composer 包,它巧妙地解决了 PHP 8.1
readonly属性在对象克隆和修改时遇到的痛点。通过引入一个简单的 Trait,它让不可变对象的使用变得更加灵活和愉快,大大提升了开发效率和代码质量。如果你正在使用 PHP 8.1 并拥抱不可变性,那么这个库绝对值得你尝试!










