在 Deno 中模拟 new Date() 的实用指南

理解 globalThis 与全局对象覆盖

在 javascript（包括 deno 环境）中，globalthis 提供了一种标准化的方式来访问全局对象。这意味着无论在浏览器环境（window）、node.js 环境（global）还是 deno 环境，globalthis 都指向相同的全局上下文。由于 date 是一个全局可用的构造函数，它实际上是 globalthis 的一个属性。更重要的是，globalthis 上的属性通常是可写的，这为我们直接替换全局对象提供了可能。

当需要模拟 new Date() 的行为时，例如在单元测试中固定时间，传统的模拟库可能无法直接拦截 new Date() 的调用。在这种情况下，直接覆盖 globalThis.Date 成为一种有效且直接的解决方案。

Deno 中模拟 Date 的实现步骤

要成功模拟 Date 对象，我们需要遵循以下核心步骤：

1. 定义模拟 Date 类：创建一个自定义类，该类将作为新的 Date 构造函数。这个类可以继承自原生的 Date，并重写其构造函数或静态方法（如 Date.now()），以返回我们期望的固定时间或模拟行为。
2. 保存原始 Date 对象：在替换之前，务必将原生的 globalThis.Date 存储在一个变量中。这是为了在模拟结束后能够将其恢复。
3. 替换全局 Date：将自定义的模拟 Date 类赋值给 globalThis.Date。
4. 提供恢复机制：创建一个函数或方法，用于将 globalThis.Date 重新设置为之前保存的原始 Date 对象。

示例代码

以下是一个在 Deno 中实现 Date 模拟的详细示例。我们将创建一个 MockDate 类，它在不传入参数时会默认返回一个固定的时间，并提供替换和恢复全局 Date 的函数。

// 定义一个 MockDate 类，继承自原生的 Date
// 当不传入参数时，它将返回一个固定的时间
class MockDate extends Date {
  constructor(dateString?: string | number | Date) {
    // 如果没有提供日期字符串，则默认使用一个固定的时间
    if (dateString === undefined) {
      super("2023-01-01T10:00:00.000Z"); // 固定的模拟时间
    } else {
      super(dateString);
    }
  }

  // 静态方法 now() 也应该被模拟，以确保 Date.now() 返回固定时间
  static now(): number {
    return new MockDate().getTime();
  }

  // 可以根据需要重写其他 Date 方法，例如 toString()
  toString(): string {
    if (this.getTime() === new Date("2023-01-01T10:00:00.000Z").getTime()) {
      return "Mon Jan 01 2023 10:00:00 GMT+0000 (Coordinated Universal Time) [MOCKED]";
    }
    return super.toString();
  }
}

/**
 * 替换全局的 Date 对象为模拟实现，并返回一个恢复函数。
 * @param mockImpl 可选参数，指定用于模拟的 Date 实现，默认为 MockDate。
 * @returns 一个函数，调用它可以将全局 Date 恢复到原始状态。
 */
function mockGlobalDate(mockImpl: typeof Date = MockDate): () => void {
  const originalDate = globalThis.Date; // 保存原始 Date 对象
  globalThis.Date = mockImpl; // 替换为模拟实现

  // 返回一个闭包函数，用于恢复原始 Date
  return () => {
    globalThis.Date = originalDate;
  };
}

// --- 演示如何使用模拟功能 ---

console.log("--- 原始 Date 对象行为 ---");
console.log(`当前时间: ${new Date().toString()}`);
console.log(`Date.now(): ${Date.now()}`);

// 执行模拟
const restoreDate = mockGlobalDate();
console.log("\n--- 模拟后的 Date 对象行为 ---");
// 此时 new Date() 和 Date.now() 将返回模拟的时间
console.log(`模拟时间: ${new Date().toString()}`);
console.log(`模拟 Date.now(): ${Date.now()}`);

// 再次创建一个 Date 对象，并传入参数，验证继承行为
console.log(`模拟 Date (带参数): ${new MockDate("2024-07-20T12:30:00Z").toString()}`);


// 恢复原始 Date 对象
restoreDate();
console.log("\n--- 恢复后的 Date 对象行为 ---");
// 此时 new Date() 和 Date.now() 将恢复到实际的当前时间
console.log(`恢复后时间: ${new Date().toString()}`);
console.log(`恢复后 Date.now(): ${Date.now()}`);

注意事项与最佳实践

1. 全局副作用管理：直接修改 globalThis 是一个全局性的操作。如果不对其进行妥善管理，可能会影响到应用程序的其他部分或同一测试套件中的其他测试。因此，恢复机制至关重要。

2. 及时恢复：在完成需要模拟 Date 的操作（例如，一个单元测试）后，务必立即调用恢复函数，将 globalThis.Date 恢复到其原始状态。在测试框架中，这通常通过 afterEach 或 teardown 钩子来实现。

   

   凹凸工坊-AI手写模拟器

   AI手写模拟器，一键生成手写文稿

   359

   查看详情

3. 模拟的复杂性：上述 MockDate 示例相对简单，仅覆盖了无参数构造函数和 now() 静态方法。如果你的代码依赖 Date 对象的其他复杂方法（如 getFullYear(), getMonth(), setDate() 等），你的 MockDate 类需要相应地重写这些方法，以提供一致的模拟行为。

4. 测试框架集成：在实际的测试场景中，建议将 mockGlobalDate 函数的调用和恢复封装在测试框架提供的设置（setup）和清理（teardown）钩子中，以确保每个测试用例都能在一个干净、可预测的环境中运行。例如，在 Deno 的 Deno.test 中，可以这样使用：

   Deno.test("我的测试用例", () => {
     const restore = mockGlobalDate(); // 在测试开始前模拟 Date
     try {
       // 执行需要模拟 Date 的测试逻辑
       const fixedDate = new Date();
       console.assert(fixedDate.getFullYear() === 2023, "年份应为 2023");
     } finally {
       restore(); // 确保在测试结束后恢复 Date，无论测试是否成功
     }
   });

   登录后复制

总结

在 Deno 环境中，通过直接操作 globalThis.Date，我们可以有效地模拟 new Date() 的行为，这对于编写可预测的单元测试尤其有用。核心在于定义一个自定义的 Date 类，替换全局 Date，并提供一个可靠的机制来恢复原始 Date 对象。虽然这种方法功能强大，但由于其全局性，务必谨慎使用，并确保每次模拟操作后都能正确清理和恢复，以避免引入难以调试的副作用。

以上就是在 Deno 中模拟 new Date() 的实用指南的详细内容，更多请关注php中文网其它相关文章！