测试驱动开发 (TDD)

概述

先写测试。看着它失败。编写最少的代码使其通过。

核心原则：如果你没有看到测试失败，你就不知道它是否测试了正确的东西。

违背规则的文字表述就是违背规则的精神。

何时使用

始终：

• 新功能
• Bug 修复
• 代码重构
• 行为变更

例外情况（需征得你的伙伴同意）：

• 一次性原型
• 生成的代码
• 配置文件

心里想着“就这一次跳过 TDD”？打住。那是在找借口。

铁律

没有先编写一个失败的测试，就不能编写任何生产代码

在测试之前写了代码？删掉它。重新开始。

没有例外：

• 不要把它留作“参考”
• 不要在编写测试时去“改编”它
• 不要看它
• 删掉就是删掉

根据测试重新实现。没有商量余地。

红-绿-重构

digraph tdd_cycle {
    rankdir=LR;
    red [label="红\n编写失败的测试", shape=box, style=filled, fillcolor="#ffcccc"];
    verify_red [label="验证\n失败原因正确", shape=diamond];
    green [label="绿\n编写最少代码", shape=box, style=filled, fillcolor="#ccffcc"];
    verify_green [label="验证\n测试通过", shape=diamond];
    refactor [label="重构\n清理代码", shape=box, style=filled, fillcolor="#ccccff"];
    next [label="下一个", shape=ellipse];

    red -> verify_red;
    verify_red -> green [label="是"];
    verify_red -> red [label="失败\n原因错误"];
    green -> verify_green;
    verify_green -> refactor [label="是"];
    verify_green -> green [label="否"];
    refactor -> verify_green [label="保持\n通过"];
    verify_green -> next;
    next -> red;
}

红 – 编写一个失败的测试

编写一个最小化的测试，展示应该发生什么。

test<>('在失败 2 次后重试成功', async () => {
  let attempts = 0;
  const operation = async () => {
    attempts++;
    if (attempts < 3) throw new Error('失败');
    return 'success';
  };

  const result = await retryOperation(operation);

  expect(result).toBe('success');
  expect(attempts).toBe(3);
});

<好>
名称清晰，测试真实行为，只测一件事

<坏>
```typescript
test('重试有效', async () => {
  const mock = jest.fn()
    .mockRejectedValueOnce(new Error())
    .mockRejectedValueOnce(new Error())
    .mockResolvedValueOnce('success');
  await retryOperation(mock);
  expect(mock).toHaveBeenCalledTimes(3);
});

名称模糊，测试的是 Mock 而不是代码

要求：

• 只测一个行为
• 名称清晰
• 使用真实代码（除非无法避免，否则不要用 Mock）

验证红 – 看着它失败

必须执行。绝不能跳过。

npm test path/to/test.test.ts

确认：

• 测试失败（而不是报错）
• 失败信息符合预期
• 失败是因为功能缺失（而不是拼写错误）

测试通过了？ 你测的是已有行为。修改测试。

测试报错了？ 修复错误，重新运行直到它正确地失败。

绿 – 编写最少代码

编写能让测试通过的最简单的代码。

不要添加功能、重构其他代码，或做超出测试范围的“改进”。

验证绿 – 看着它通过

必须执行。

npm test path/to/test.test.ts

确认：

• 测试通过
• 其他测试仍然通过
• 输出干净（无错误、警告）

测试失败了？ 修复代码，而不是测试。

其他测试失败了？ 立即修复。

重构 – 清理代码

仅在测试通过后进行：

• 消除重复
• 改进命名
• 提取辅助函数

保持测试通过。不要添加行为。

重复

为下一个功能编写下一个会失败的测试。

好的测试

为什么顺序很重要

“我之后会写测试来验证它有效”

代码之后写的测试会立即通过。立即通过什么都证明不了：

• 可能测错了东西
• 可能测的是实现，而不是行为
• 可能漏掉了你忘记的边界情况
• 你从没见过它捕获过 bug

测试先行迫使你看到测试失败，证明它确实在测试某些东西。

“我已经手动测试了所有边界情况”

手动测试是随意的。你以为你测试了所有，但是：

• 没有记录你测试了什么
• 代码更改后无法重新运行
• 在压力下容易忘记测试用例
• “我试过，它能用” ≠ 全面覆盖

自动化测试是系统性的。它们每次都以相同的方式运行。

“删掉 X 小时的工作太浪费了”

沉没成本谬误。时间已经花掉了。你现在面临选择：

• 删掉并用 TDD 重写（再花 X 小时，高信心）
• 保留它，之后添加测试（30 分钟，低信心，很可能有 bug）

真正的“浪费”是保留你不信任的代码。没有真实测试的可用代码就是技术债。

“TDD 太教条了，务实意味着要适应”

TDD 本身就是务实的：

• 在提交前发现 bug（比之后调试更快）
• 防止回归（测试能立刻捕捉到破坏）
• 记录行为（测试展示了如何使用代码）
• 支持重构（自由更改，测试会捕捉问题）

走“务实”捷径 = 在生产环境调试 = 更慢。

“后写测试能达到同样的目标——重要的是精神，不是形式”

不。后写测试回答的是“这段代码是做什么的？”先写测试回答的是“这段代码应该做什么？”

后写测试会被你的实现所影响。你测试的是你构建的东西，而不是需求。你验证的是你记得的边界情况，而不是你发现的。

先写测试强制你在实现之前去发现边界情况。后写测试只是验证你记住了所有东西（但你并没有）。

花 30 分钟后写测试 ≠ TDD。你得到了覆盖率，但失去了证明测试有效的证据。

常见的借口

危险信号 – 停止并重新开始

• 先写代码后写测试
• 实现之后才写测试
• 测试立即通过
• 无法解释测试为何失败
• “稍后”添加测试
• 找借口“就这一次”
• “我已经手动测试过了”
• “后写测试能达到同样的目的”
• “重要的是精神，不是形式”
• “留着做参考”或“改编现有代码”
• “已经花了 X 小时，删掉太浪费”
• “TDD 太教条，我这是在务实”
• “这次情况不同，因为……”

所有这些都意味着：删掉代码。用 TDD 重新开始。

示例：Bug 修复

Bug： 允许提交空邮箱

红

test('拒绝空邮箱', async () => {
  const result = await submitForm({ email: '' });
  expect(result.error).toBe('邮箱是必填项');
});

验证红

$ npm test
失败：期望得到 '邮箱是必填项'，实际得到 undefined

绿

function submitForm(data: FormData) {
  if (!data.email?.trim()) {
    return { error: '邮箱是必填项' };
  }
  // ...
}

验证绿

$ npm test
通过

重构
如果需要，可以为多个字段提取验证逻辑。

验证清单

在标记工作完成前：

• 每个新函数/方法都有对应的测试
• 在实现前，看到了每个测试失败
• 每个测试失败的原因符合预期（功能缺失，而非拼写错误）
• 编写了最少的代码使每个测试通过
• 所有测试通过
• 输出干净（无错误、警告）
• 测试使用真实代码（除非无法避免，否则不使用 Mock）
• 涵盖了边界情况和错误处理

无法勾选所有项？你跳过了 TDD。重新开始。

卡住时怎么办

调试集成

发现 Bug？编写一个能复现它的失败测试。遵循 TDD 周期。测试既能证明修复有效，也能防止回归。

修复 Bug 必须有测试。

测试反模式

在添加 Mock 或测试工具时，请阅读 @testing-anti-patterns.md 以避免常见陷阱：

• 测试 Mock 行为而非真实行为
• 为生产类添加仅用于测试的方法
• 在不了解依赖关系的情况下使用 Mock

最终规则

生产代码 → 对应的测试必须存在并且先失败过
否则 → 就不是 TDD

未经你的伙伴允许，不得有任何例外。