如何优雅地管理PHP应用中的时间与日期？ghostwriter/clock助你实现可测试、可控的时间流！

可以通过一下地址学习composer：学习地址

在日常的php项目开发中，我们经常需要处理各种与时间相关的逻辑。比如，判断一个用户会话是否过期，检查一个优惠券是否仍在有效期内，或者记录某个操作发生的确切时间。这些看似简单的需求，在实际操作中却常常让我们头疼不已。

我曾遇到的痛点：时间流逝的“不可控”

还记得有一次，我负责开发一个用户会话管理模块。其中有一个关键功能是判断用户的登录状态是否有效，这需要根据会话的创建时间加上一个固定的有效期来计算。最初，我的代码是这样的：

class SessionManager
{
    public function isValid(Session $session): bool
    {
        $expirationTime = $session->getCreatedAt()->modify('+30 minutes');
        return new DateTimeImmutable() < $expirationTime; // 直接使用当前时间
    }
}

这段代码在生产环境看似运行良好，但在编写单元测试时，问题就浮现了。我需要测试会话在过期前和过期后的两种情况。这意味着我必须“模拟”时间的流逝。

一开始，我尝试了一些笨拙的方法：

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

1. 修改系统时钟：这显然是不可行的，会影响到整个测试环境，甚至其他正在运行的测试。
2. 使用

   sleep()

   函数：在测试中加入

   sleep(30 * 60)

   来等待会话过期，这不仅让测试变得极其缓慢，而且不确定性高，容易导致测试失败。
3. 手动创建

   DateTimeImmutable

   实例：在测试中传入一个“假”的当前时间，但这需要修改

   isValid

   方法的签名，或者在每个测试用例中都手动创建不同的时间对象，代码变得冗余且难以维护。

更糟糕的是，如果我的应用部署在不同的服务器上，或者在处理跨时区用户时，

new DateTimeImmutable()

Composer的魔法：引入

ghostwriter/clock

就在我为这些时间管理难题焦头烂额之际，我发现了

ghostwriter/clock

ClockInterface

composer require ghostwriter/clock

安装完成后，我们就可以利用它来解决上述问题了。

ghostwriter/clock

new DateTimeImmutable()

1. SystemClock

   : 代表系统当前的真实时间，会根据PHP的

   date_default_timezone_get()

   或

   date_default_timezone_set()

   来确定时区。

2. LocalizedClock

   : 允许你指定一个固定的时区，无论系统默认时区是什么，它都会在这个指定时区内获取当前时间。

3. FrozenClock

   : 这是测试的利器！它可以将时间“冻结”在某个特定的

   DateTimeImmutable

   实例上，无论你调用多少次

   now()

   方法，它都返回同一个预设的时间。

如何使用

ghostwriter/clock

为了解决会话管理的测试难题和时区一致性问题，我首先重构了

SessionManager

ClockInterface

ClippingMagic

魔术般地去除图片背景

下载

use Ghostwriter\Clock\ClockInterface;
use DateTimeImmutable;

class SessionManager
{
    private ClockInterface $clock;

    public function __construct(ClockInterface $clock)
    {
        $this->clock = $clock;
    }

    public function isValid(Session $session): bool
    {
        $expirationTime = $session->getCreatedAt()->modify('+30 minutes');
        return $this->clock->now() < $expirationTime; // 通过ClockInterface获取当前时间
    }
}

现在，我的代码变得更加灵活和可测试了！

1. 生产环境中的时间管理（使用

SystemClock

LocalizedClock

在生产环境中，我通常会使用

SystemClock

LocalizedClock

LocalizedClock

use Ghostwriter\Clock\LocalizedClock;
use DateTimeZone;

// 在应用启动时配置，或者通过依赖注入容器注入
$utcClock = LocalizedClock::new(new DateTimeZone('UTC'));
$sessionManager = new SessionManager($utcClock);

// 无论服务器的默认时区是什么，isValid都将以UTC时间进行判断
$sessionManager->isValid($someSession);

如果我希望它跟随系统默认时区，则使用

SystemClock

use Ghostwriter\Clock\SystemClock;

// 假设系统默认时区已设置为 'America/Los_Angeles'
date_default_timezone_set('America/Los_Angeles');
$systemClock = SystemClock::new();
$sessionManager = new SessionManager($systemClock);

// 获取当前时间，时区为 'America/Los_Angeles'
echo $sessionManager->clock->now()->getTimezone()->getName(); // America/Los_Angeles

2. 单元测试的救星（使用

FrozenClock

FrozenClock

use Ghostwriter\Clock\FrozenClock;
use DateTimeImmutable;
use DateTimeZone;
use PHPUnit\Framework\TestCase;

class SessionManagerTest extends TestCase
{
    public function testSessionIsValidBeforeExpiration(): void
    {
        // 冻结时间到 2023-01-01 10:00:00 UTC
        $frozenTime = new DateTimeImmutable('2023-01-01 10:00:00', new DateTimeZone('UTC'));
        $frozenClock = FrozenClock::new($frozenTime);

        // 模拟一个在 2023-01-01 09:50:00 创建的会话
        $sessionCreatedAt = new DateTimeImmutable('2023-01-01 09:50:00', new DateTimeZone('UTC'));
        $session = new Session($sessionCreatedAt); // 假设Session类有getCreatedAt方法

        $sessionManager = new SessionManager($frozenClock);

        // 在冻结时间（10:00:00）下，会话（09:50:00创建，30分钟有效期）是有效的
        $this->assertTrue($sessionManager->isValid($session));
    }

    public function testSessionIsInvalidAfterExpiration(): void
    {
        // 冻结时间到 2023-01-01 10:21:00 UTC (超过30分钟有效期)
        $frozenTime = new DateTimeImmutable('2023-01-01 10:21:00', new DateTimeZone('UTC'));
        $frozenClock = FrozenClock::new($frozenTime);

        // 模拟一个在 2023-01-01 09:50:00 创建的会话
        $sessionCreatedAt = new DateTimeImmutable('2023-01-01 09:50:00', new DateTimeZone('UTC'));
        $session = new Session($sessionCreatedAt);

        $sessionManager = new SessionManager($frozenClock);

        // 在冻结时间（10:21:00）下，会话已过期
        $this->assertFalse($sessionManager->isValid($session));
    }
}

通过

FrozenClock

总结其优势和实际应用效果

ghostwriter/clock

• 卓越的可测试性：

  FrozenClock

  是单元测试的利器，它允许我们精确控制“当前时间”，轻松测试时间敏感的业务逻辑，避免了传统时间处理方式带来的不确定性和复杂性。
• 高度的灵活性和可控性：通过

  ClockInterface

  ，我们可以在

  SystemClock

  、

  LocalizedClock

  和

  FrozenClock

  之间轻松切换，无论是跟随系统时间、固定在特定时区，还是冻结在某个时刻，都变得轻而易举。
• 代码一致性和可维护性：将时间获取抽象化，确保了整个应用都通过统一的接口获取时间，避免了因不同地方直接调用

  new DateTimeImmutable()

  而可能导致的时区或时间不一致问题。
• 面向接口编程的典范：

  ClockInterface

  的设计完美契合依赖注入原则，使得我们的代码更加解耦，易于扩展和维护。

自从引入

ghostwriter/clock

ghostwriter/clock