编写可测试的JavaScript代码及最佳实践指南

编写可测试的JavaScript代码并非后期补救，而是从设计之初就应贯彻的核心理念——通过纯函数封装逻辑、参数化依赖（如时间与API客户端）、避免全局状态、模块化拆分职责、可控处理异步行为，并借助Jest、jsdom等工具模拟环境，让代码天然具备可预测性、可替换性和可分割性，从而实现高效、稳定、可持续维护的单元测试。

编写可测试的JavaScript代码关键在于让代码具备高内聚、低耦合、职责清晰和易于模拟依赖的特点。测试友好性不是事后添加的，而是设计时就要考虑的。以下是具体做法和最佳实践。

1. 函数应保持纯函数或明确副作用

纯函数是指相同的输入始终产生相同的输出，并且不修改外部状态。这类函数最容易测试。

• 尽量将逻辑封装在无副作用的函数中，比如数据处理、格式转换等。
• 将有副作用的操作（如DOM操作、API调用、localStorage）隔离到单独的函数或模块。
• 例如：

可测试写法：

function calculateTax(amount, rate) {
  return amount * rate;
}
function saveUserToStorage(user) {
localStorage.setItem('user', JSON.stringify(user));
}

第一个函数可以直接断言结果；第二个虽然有副作用，但职责单一，便于通过模拟 localStorage 来测试。

2. 避免全局状态和隐式依赖

全局变量或隐式依赖（如直接使用 Date、Math.random）会使测试不可靠，因为它们难以控制。

• 通过参数传入依赖，而不是在函数内部直接引用。
• 例如，不要在函数里直接用 new Date()，而是接受一个时间戳或日期对象。

改进示例：

// 不推荐
function isToday(dateString) {
  const today = new Date();
  const inputDate = new Date(dateString);
  return today.toDateString() === inputDate.toDateString();
}
// 推荐：允许注入当前时间
function isToday(dateString, now = new Date()) {
const inputDate = new Date(dateString);
return now.toDateString() === inputDate.toDateString();
}

测试时可以传入固定的 now 值，避免因时间变化导致测试失败。

3. 使用依赖注入解耦模块

当函数或类依赖外部服务（如API客户端、数据库）时，应通过参数传入，而不是在内部创建。

• 构造函数或函数参数接收依赖项，便于替换为模拟对象（mock）。
• 例如：

class UserService {
  constructor(apiClient) {
    this.apiClient = apiClient;
  }
async getUser(id) {
const response = await this.apiClient.get(/users/${id});
return response.data;
}
}

测试时可以传入一个模拟的 apiClient，验证调用行为而不发真实请求。

4. 模块化设计，单一职责

每个文件或函数只做一件事。这样测试用例更专注，维护也更容易。

• 拆分大函数为小函数，每个函数完成一个明确任务。
• 使用 ES 模块或 CommonJS 明确导出可测试的部分。
• 避免在一个文件中混合逻辑、DOM操作和事件绑定。

例如，把表单验证逻辑独立出来，而不是写在事件回调里。

5. 编写可预测的异步代码

异步操作（Promise、async/await）是测试难点，关键是让它们可控制。

• 返回 Promise 的函数应始终处理错误，避免未捕获异常。
• 使用 setTimeout 的场景，考虑将其抽象为可配置的延迟函数，方便测试跳过。
• 测试异步代码时，使用 done 回调或 async/await 断言。

示例：

function delay(ms, callback) {
  return new Promise(resolve => {
    setTimeout(() => {
      resolve(callback());
    }, ms);
  });
}

测试时可将 ms 设为 0 或 mock setTimeout。

6. 使用测试友好的工具和结构

选择合适的测试框架和辅助工具能大幅提升效率。

• 使用 Jest、Vitest 等现代测试框架，支持快照、mock、覆盖率报告。
• 利用 beforeEach 和 afterEach 隔离测试上下文。
• 对 DOM 操作使用 jsdom 或 Testing Library 进行模拟。
• 为第三方库（如 fetch、axios）设置 mock 实现。

基本上就这些。核心是让代码行为可预测、依赖可替换、逻辑可分割。只要设计时多花一点心思，后续测试就会轻松很多。

以上就是《编写可测试的JavaScript代码及最佳实践指南》的详细内容，更多关于的资料请关注golang学习网公众号！