# DateTime与时间相依性测试指南 ## 核心原则 ### 原则一：时间抽象化 - 以 TimeProvider 取代 DateTime **传统问题程序代码**： // ❌ 无法测试 - 直接使用静态时间公共类订单服务 { 公共 bool CanPlaceOrder() { var now = DateTime.Now; 返回 now.Hour >= 9 && now.Hour < 17; } } **可开发的重构**： // ✅ 可测试 - 跨境依赖注入接收 TimeProvider 公共类订单服务 { 私有只读TimeProvider _timeProvider；公共 OrderService(TimeProvider timeProvider) { _timeProvider = 时间提供者 ??抛出新的 ArgumentNullException(nameof(timeProvider)); } 公共 bool CanPlaceOrder() { var now = _timeProvider.GetLocalNow(); 返回 now.Hour >= 9 && now.Hour < 17; } } **依赖注入设定**： // Program.cs - 生产环境使用系统时间 services.AddSingleton(TimeProvider.System); services.AddScoped(); ### 原则二：FakeTimeProvider 控制测试时间 FakeTimeProvider提供完整的时间控制能力：方法 | 用途 | 使用时机 ---|---|--- `SetUtcNow(DateTimeOffset)` | 设定 UTC 时间 | 需要准确的 UTC 时间 `设置本地时区（时区信息）` | 设定本地时区 | 测试时区相关逻辑 `提前（时间跨度）` | 时间快转 | 测试延迟、延迟逻辑 `GetUtcNow()` | 获取 UTC 时间 | 读取当前模拟时间 `GetLocalNow()` | 获取本地时间 | 读取本地模拟时间 **建议增强方法**：公共静态类 FakeTimeProviderExtensions { /// <摘要> /// 设置 FakeTimeProvider 的本地时间 /// 公共静态无效SetLocalNow（此FakeTimeProvider fakeTimeProvider，DateTime localDateTime） { fakeTimeProvider.SetLocalTimeZone(TimeZoneInfo.Local); var utcTime = TimeZoneInfo.ConvertTimeToUtc(localDateTime, TimeZoneInfo.Local); fakeTimeProvider.SetUtcNow(utcTime); } } ### 原则三：每个人测试使用独立的时间环境 // ✅ 正确：每个测试独立都建立了 FakeTimeProvider 公共类 OrderServiceTests { [事实] public void CanPlaceOrder_在营业期限_应回传True() { // 安排 - 独立实例 var fakeTimeProvider = new FakeTimeProvider(); fakeTimeProvider.SetLocalNow(new DateTime(2024, 3, 15, 14, 0, 0)); var sut = new OrderService(fakeTimeProvider); // 行动 var 结果 = sut.CanPlaceOrder(); // 断言结果.Should().BeTrue(); } } // ❌ 避免：多次测试占用静态实例公共类 BadTestClass { 私有静态只读 FakeTimeProvider SharedProvider = new(); // 会互相干扰 } ** ** ## 进阶时间控制技术 ### 时间静止当需要验证多个操作发生在「同一时间点」时： [事实] public void ProcessBatch_在固定时间点_应产生相同时钟() { var fakeTimeProvider = new FakeTimeProvider(); var 固定时间 = 新日期时间(2024, 12, 25, 10, 30, 0); fakeTimeProvider.SetLocalNow(fixedTime); var 处理器 = new BatchProcessor(fakeTimeProvider); var result1 = 处理器.ProcessItem("Item1"); var result2 = 处理器.ProcessItem("Item2"); // 时间被冻结，两次操作的时间相同 result1.Timestamp.Should().Be(result2.Timestamp); } ### 时间快转（提前）测试快取到期、Token失效等时间敏感逻辑： [事实] public void Cache_经过过渡时间_应清除项目() { var fakeTimeProvider = new FakeTimeProvider(); fakeTimeProvider.SetLocalNow(new DateTime(2024, 3, 15, 10, 0, 0)); var cache = new TimedCache(fakeTimeProvider, TimeSpan.FromMinutes(5)); 缓存.Set(“键”,“值”); // 3 分钟后 - 尚未过渡 fakeTimeProvider.Advance(TimeSpan.FromMinutes(3)); cache.Get("key").Should().Be("value"); // 再3分钟后（共6分钟）- 已过渡 fakeTimeProvider.Advance(TimeSpan.FromMinutes(3)); cache.Get("key").Should().BeNull(); } > **重要**：`Advance()`是非阻塞的，瞬间完成时间跳跃，不会真正等待。 ### 时间倒转测试数据历史处理或重播场景： [事实] public void HistoricalDataProcessor_回到过去时间_应正确处理() { var fakeTimeProvider = new FakeTimeProvider(); var HistoricalTime = new DateTime(2020, 1, 15, 9, 0, 0); fakeTimeProvider.SetLocalNow(历史时间); var 处理器 = 新的 HistoricalDataProcessor(fakeTimeProvider); var 结果=processor.ProcessDataForDate(historicalTime.Date); result.ProcessedAt.Should().Be(历史时间); } ** ** ## 实战测试模式 ### 模式一：参数化边界测试 [理论] [InlineData(8, false)] // 上午8点 - 营业时间前 [InlineData(9, true)] // 上午9点 - 刚开始营业 [InlineData(12, true)] // 中午 12 点 - 营业期限 [InlineData(16, true)] // 下午 4 点 - 营业期限 [InlineData(17, false)] // 下午 5 点 - 刚结束营业 [InlineData(18, false)] // 下午 6 点 - 营业时间后 public void CanPlaceOrder_不同时间点_应回传正确结果(int hour, bool Expected) { var fakeTimeProvider = new FakeTimeProvider(); fakeTimeProvider.SetLocalNow(new DateTime(2024, 3, 15, 小时, 0, 0)); var sut = new OrderService(fakeTimeProvider); sut.CanPlaceOrder().Should().Be(预期); } ###模式二：交易时间窗口测试 [理论] [InlineData("09:30:00", true)] // 上午交易时间 [InlineData("12:00:00", false)] // 中午休息 [InlineData("14:30:00", true)] // 下午交易时间 [InlineData("15:30:00", false)] // 交易结束后 public void IsInTradingHours_不同时间_应回传正确结果(string timeStr, bool预期) { var fakeTimeProvider = new FakeTimeProvider(); var testTime = DateTime.Today.Add(TimeSpan.Parse(timeStr)); fakeTimeProvider.SetLocalNow(testTime); var sut = new TradingService(fakeTimeProvider); sut.IsInTradingHours().Should().Be(预期); } ### 模式三：排程触发逻辑测试 [理论] [InlineData("2024-03-15 14:30:00", "2024-03-15 14:00:00", true)] // 已到执行时间 [InlineData("2024-03-15 13:30:00", "2024-03-15 14:00:00", false)] // 尚未到时间 public void ShouldExecuteJob_根据时间判断_应回传正确结果( 字符串 currentTimeStr、字符串 ScheduledTimeStr、预计为 bool） { var fakeTimeProvider = new FakeTimeProvider(); fakeTimeProvider.SetLocalNow(DateTime.Parse(currentTimeStr)); var Schedule = new JobSchedule { NextExecutionTime = DateTime.Parse(scheduledTimeStr) }; var sut = new ScheduleService(fakeTimeProvider); sut.ShouldExecuteJob(schedule).Should().Be(预期); } ** ** ## AutoFixture 整合 ### FakeTimeProvider定制公共类 FakeTimeProviderCustomization ：ICustomization { public void 自定义（IFixture 夹具） { Fixture.Register(() => new FakeTimeProvider()); } } ### AutoDataWithCustomization 属性公共类 AutoDataWithCustomizationAttribute ： AutoDataAttribute { 公共 AutoDataWithCustomizationAttribute() : 基础(CreateFixture) { } 私有静态 IFixture CreateFixture() { 返回新的夹具() .Customize(新的 AutoNSubstituteCustomization()) .Customize(new FakeTimeProviderCustomization()); } } ### 使用 Matching.DirectBaseType [理论] [自动数据自定义] public void GetTimeBasedDiscount_周五_应回传九折优惠( [冻结（Matching.DirectBaseType）] FakeTimeProvider fakeTimeProvider， OrderService 苏） { // Matching.DirectBaseType 让 AutoFixture 知道： // 当需要 TimeProvider（选定类型）时，使用 FakeTimeProvider（衍生类型） var fridayTime = new DateTime(2024, 3, 15, 14, 0, 0); // 周五 fakeTimeProvider.SetLocalNow(fridayTime); sut.GetTimeBasedDiscount().Should().Be("周五快乐：九折优惠"); } > **关键**：必须使用 `[Frozen(Matching.DirectBaseType)]`，否则 AutoFixture 无法正确将 FakeTimeProvider 注入到需要 TimeProvider 的当前式中。 ** ** ## 最佳实践检查清单 ### 方案码设计 *所有时间相依类别查看当前方式接收`TimeProvider` * 使用 `_timeProvider.GetLocalNow()` 替换 `DateTime.Now` * 使用 `_timeProvider.GetUtcNow()` 替换 `DateTime.UtcNow` * DI 容器注册 `TimeProvider.System` 作为生产环境实作 ### 测试设计 * 每个测试方法都使用独立的 `FakeTimeProvider` 实例 * 使用 `SetLocalNow()` 增强方法简化时间设置 * 使用 `Advance()` 测试时间敏感逻辑（快取、过渡、延迟） * 测试边界条件（开始时间、结束时间、临界点） ### 进阶考量 * FakeTimeProvider 是执行绪安全的，可用于工具测试 * 使用 `IDisposable` 模式正确释放 FakeTimeProvider * 时区测试使用 `SetLocalTimeZone()` 设定明确时区 ** ** ## 输出格式 * 产生使用 TimeProvider 抽象的服务类别 * 产生使用 FakeTimeProvider 的测试类别 * 包含时间冻结、快速转场、时区转换测试示例 * 提供.csproj套件参考（Microsoft.Bcl.TimeProvider） ## 参考资源 ### 原始文章本技能内容提炼自「老派软体工程师的测试修练 - 30天挑战」系列文章： * **第 16 天 - 测试日期与时间：Microsoft.Bcl.TimeProvider 取代 DateTime** * 铁人赛文章： * 示例程序代码： ### 官方文件 * [TimeProvider API]() * [Microsoft.Bcl.TimeProvider NuGet]() * [Microsoft.Extensions.TimeProvider.Testing NuGet]() ### 相关技能 * `autofixture-basics` \- AutoFixture自动测试数据生成 * `nsubstitute-mocking` \- 测试替身与模拟 * `autodata-xunit-integration` \- xUnit 与 AutoFixture 的 AutoData 集成

Dotnet 测试日期时间测试时间提供程序

包含技能