Carbon setTime 方法的陷阱：理解可变性与 copy() 的应用

Carbon 对象的可变性：一个常见陷阱

在使用 carbon 库处理日期和时间时，开发者可能会遇到一个常见的困惑：当对一个 carbon 实例进行时间修改（如 settime）并将其赋值给另一个变量时，原始变量和新变量似乎会同步变化。这并非错误，而是 carbon 对象默认的可变性（mutable）特性所致。在 php 中，对象默认是通过引用传递的。这意味着当你将一个 carbon 实例赋值给另一个变量时，这两个变量实际上指向的是内存中的同一个对象。

考虑以下场景，我们试图基于一个 $date 对象创建两个不同的时间点：$this->temp_mon_start 和 $this->temp_mon_end：

use Carbon\Carbon;

// 假设 $date 初始为 '2021-11-15 00:00:00.0 Asia/Singapore (+08:00)'
$date = Carbon::parse('2021-11-15 00:00:00.0', 'Asia/Singapore');

$this->temp_mon_start = $date->setTime(8, 0); // 设置为 8:00
$this->temp_mon_end = $date->setTime(3, 0);   // 设置为 3:00

// 预期 $this->temp_mon_start 是 8:00， $this->temp_mon_end 是 3:00
// 实际输出：
dd($this->temp_mon_start, $this->temp_mon_end);

运行上述代码，你会发现 $this->temp_mon_start 和 $this->temp_mon_end 都显示为 2021-11-15 03:00:00.0 Asia/Singapore (+08:00)。这与我们的预期不符，因为它们都反映了最后一次 setTime 操作的结果。

问题分析：setTime 方法的工作原理

Carbon 的 setTime() 方法以及许多其他修改时间的方法（如 addDay(), subHours() 等），在执行时并不会创建一个新的 Carbon 实例，而是直接修改调用该方法的当前实例，并返回对该实例自身的引用。

在上述示例中：

1. $this->temp_mon_start = $date->setTime(8, 0);
   • $date 对象被修改，其时间变为 8:00。
   • setTime() 方法返回的是被修改后的 $date 对象本身。
   • $this->temp_mon_start 现在引用的是这个已经变为 8:00 的 $date 对象。
2. $this->temp_mon_end = $date->setTime(3, 0);
   • 注意：这里操作的依然是内存中同一个 $date 对象。
   • $date 对象再次被修改，其时间变为 3:00。
   • setTime() 方法再次返回对这个被修改后的 $date 对象的引用。
   • $this->temp_mon_end 现在引用的是这个已经变为 3:00 的 $date 对象。

由于 $this->temp_mon_start 和 $this->temp_mon_end 最终都指向了内存中同一个 $date 对象，并且这个对象在第二次 setTime 调用后被更新为 3:00，因此它们最终都显示为 3:00。

解决方案：使用 copy() 方法创建独立实例

要解决这个问题，我们需要在对 Carbon 实例进行修改之前，先创建一个它的独立副本。Carbon 提供了 copy() 方法，它会返回当前 Carbon 实例的一个全新且独立的副本。对副本的任何修改都不会影响原始实例。

AppMall应用商店

AI应用商店，提供即时交付、按需付费的人工智能应用服务

56

查看详情

修正后的代码示例如下：

use Carbon\Carbon;

// 假设 $date 初始为 '2021-11-15 00:00:00.0 Asia/Singapore (+08:00)'
$date = Carbon::parse('2021-11-15 00:00:00.0', 'Asia/Singapore');

// 先复制 $date，再对副本进行时间修改
$this->temp_mon_start = $date->copy()->setTime(8, 0);

// 再次复制 $date，再对副本进行时间修改
$this->temp_mon_end = $date->copy()->setTime(3, 0);

// 预期 $this->temp_mon_start 是 8:00， $this->temp_mon_end 是 3:00
// 实际输出：
dd($this->temp_mon_start, $this->temp_mon_end);

现在，dd() 的输出将是：

   date: 2021-11-15 08:00:00.0 Asia/Singapore (+08:00)
   date: 2021-11-15 03:00:00.0 Asia/Singapore (+08:00)

这符合了我们的预期。

理解 copy() 的作用

copy() 方法在底层实现上，会创建一个新的 Carbon 对象，并将其所有属性（包括日期、时间、时区等）从原始对象复制过来。这样，你就拥有了一个与原始对象内容相同但完全独立的实例。之后对这个新实例进行的任何操作，都不会影响到原始的 $date 对象。

最佳实践与注意事项

• 理解对象可变性： 这是 PHP 中对象操作的一个核心概念。当一个对象默认是可变的时，直接修改它会影响所有引用该对象的变量。
• 防御性编程： 当你需要基于一个已有的日期时间对象创建多个不同的日期时间点时，始终考虑使用 copy() 方法，以避免意外的副作用。
• 链式调用： copy() 方法可以很方便地与其他 Carbon 方法进行链式调用，如 $date->copy()->addDays(1)->setTime(9, 0);。
• 不可变日期时间对象： PHP 8 引入了 DateTimeImmutable 和 CarbonImmutable。如果你的项目允许，并且你需要一种默认不可变的行为，可以考虑使用这些类。它们在修改时总是返回一个新的实例，而不是修改原实例。

总结

Carbon 对象默认是可变的，其 setTime() 等修改方法会直接操作并返回当前实例。为了在基于同一原始 Carbon 实例创建多个不同时间点时避免数据污染，务必使用 copy() 方法来生成一个独立的副本。理解并正确运用 copy() 是高效且无误地处理 Carbon 日期时间对象的关键。

以上就是Carbon setTime 方法的陷阱：理解可变性与 copy() 的应用的详细内容，更多请关注php中文网其它相关文章！