最近在项目中,我们使用doctrine orm管理数据库,其中涉及大量的日期时间字段。由于datetime对象的特性,在某些情况下,我们无意中修改了日期时间值,导致数据不一致,甚至程序崩溃。这种问题难以调试,严重影响了开发效率。
例如,在获取实体的创建时间后,如果不小心修改了这个DateTime对象,数据库中的数据也会被修改,而我们并没有通过Doctrine的持久化机制进行更新,这就会导致数据与数据库不同步。 更糟糕的是,这种错误可能在代码运行一段时间后才暴露出来,排查起来非常困难。
为了解决这个问题,我们决定使用不可变的DateTimeImmutable对象替代DateTime对象。 幸运的是,我们找到了vasek-purchart/doctrine-date-time-immutable-types这个优秀的composer库。 这个库为Doctrine提供了DateTimeImmutable、DateImmutable、TimeImmutable和DateTimeTzImmutable等类型,完美解决了我们的问题。
安装这个库非常简单,只需要使用Composer:
composer require vasek-purchart/doctrine-date-time-immutable-types
接下来,我们需要注册这些新的类型:
use DoctrineDBALTypesType;use VasekPurchartDoctrineTypeDateTimeImmutableDateImmutableType;use VasekPurchartDoctrineTypeDateTimeImmutableDateTimeImmutableType;use VasekPurchartDoctrineTypeDateTimeImmutableDateTimeTzImmutableType;use VasekPurchartDoctrineTypeDateTimeImmutableTimeImmutableType;Type::addType(DateImmutableType::NAME, DateImmutableType::class);Type::addType(DateTimeImmutableType::NAME, DateTimeImmutableType::class);Type::addType(DateTimeTzImmutableType::NAME, DateTimeTzImmutableType::class);Type::addType(TimeImmutableType::NAME, TimeImmutableType::class);
你也可以选择覆盖Doctrine默认的日期时间类型:
Type::overrideType(Type::DATETIMETZ, DateTimeTzImmutableType::class);
最后,在实体映射中,将字段类型改为datetime_immutable (或者date_immutable, time_immutable, datetimetz_immutable):
<?phpuse DoctrineORMMapping as ORM;/<strong> <em> @ORMEntity() </em>/class LogRow{ /</strong> <em> @ORMColumn(type="datetime_immutable") </em> @var DateTimeImmutable */ private $createdDate; public function getCreatedDate(): DateTimeImmutable { return $this->createdDate; }}
现在,即使你尝试修改getCreatedDate()返回的DateTimeImmutable对象,也不会影响到数据库中的数据,因为DateTimeImmutable对象是不可变的。 这极大地提升了代码的健壮性,避免了因意外修改日期时间字段而导致的bug。
通过使用vasek-purchart/doctrine-date-time-immutable-types,我们成功地解决了DateTime对象的可变性问题,显著提高了代码的可维护性和可靠性。 在处理日期时间相关的业务逻辑时,强烈推荐使用这个库,以避免潜在的错误和提高开发效率。 此外,如果你正在使用symfony框架,还可以考虑使用vasek-purchart/doctrine-date-time-immutable-types-bundle,它可以更方便地集成这个库。 记住,选择合适的工具,可以让你事半功倍!