name: 测试驱动开发 description: 在编写实现代码之前,先编写测试用例,观察它失败,然后编写最小代码以通过;通过首先要求失败,确保测试实际验证行为
测试驱动开发 (TDD)
概述
先写测试用例。观察它失败。编写最小代码以通过。
核心原则: 如果你没有观察测试失败,你就不知道它测试的是正确的事情。
违反规则的字面意思就是违反规则的精神。
何时使用
总是:
- 新功能
- 错误修复
- 重构
- 行为变更
例外情况(询问您的人类伙伴):
- 一次性原型
- 生成的代码
- 配置文件
认为“这次跳过TDD”?停止。那是理性化。
铁律
没有先有失败测试的生产代码
在测试之前写代码?删除它。重新开始。
没有例外:
- 不要保留它作为“参考”
- 不要“适配”它当写测试时
- 不要看它
- 删除意味着删除
从测试开始全新实现。句号。
红-绿-重构
digraph tdd_cycle {
rankdir=LR;
red [label="红
写失败测试", shape=box, style=filled, fillcolor="#ffcccc"];
verify_red [label="验证失败
正确", shape=diamond];
green [label="绿
最小代码", shape=box, style=filled, fillcolor="#ccffcc"];
verify_green [label="验证通过
全部绿色", shape=diamond];
refactor [label="重构
清理", shape=box, style=filled, fillcolor="#ccccff"];
next [label="下一步", shape=ellipse];
red -> verify_red;
verify_red -> green [label="是"];
verify_red -> red [label="错误
失败"];
green -> verify_green;
verify_green -> refactor [label="是"];
verify_green -> green [label="否"];
refactor -> verify_green [label="保持
绿色"];
verify_green -> next;
next -> red;
}
红 - 写失败测试
写一个最小测试展示应该发生什么。
<好>
test('重试失败操作3次', async () => {
let attempts = 0;
const operation = () => {
attempts++;
if (attempts < 3) throw new Error('失败');
return '成功';
};
const result = await retryOperation(operation);
expect(result).toBe('成功');
expect(attempts).toBe(3);
});
清晰名称,测试真实行为,一件事情 </好>
<坏>
test('重试有效', async () => {
const mock = jest.fn()
.mockRejectedValueOnce(new Error())
.mockRejectedValueOnce(new Error())
.mockResolvedValueOnce('成功');
await retryOperation(mock);
expect(mock).toHaveBeenCalledTimes(3);
});
模糊名称,测试模拟而非代码 </坏>
要求:
- 一个行为
- 清晰名称
- 真实代码(除非不可避免,不使用模拟)
验证红 - 观察它失败
强制。永远不要跳过。
npm test 路径/到/test.test.ts
确认:
- 测试失败(非错误)
- 失败消息是预期的
- 因功能缺失失败(非拼写错误)
测试通过? 您在测试现有行为。修复测试。
测试错误? 修复错误,重新运行直到它正确失败。
绿 - 最小代码
编写最简单代码以通过测试。
<好>
async function retryOperation<T>(fn: () => Promise<T>): Promise<T> {
for (let i = 0; i < 3; i++) {
try {
return await fn();
} catch (e) {
if (i === 2) throw e;
}
}
throw new Error('不可达');
}
仅足以通过 </好>
<坏>
async function retryOperation<T>(
fn: () => Promise<T>,
options?: {
maxRetries?: number;
backoff?: 'linear' | 'exponential';
onRetry?: (attempt: number) => void;
}
): Promise<T> {
// YAGNI
}
过度工程 </坏>
不要添加功能、重构其他代码,或“改进”超出测试范围。
验证绿 - 观察它通过
强制。
npm test 路径/到/test.test.ts
确认:
- 测试通过
- 其他测试仍然通过
- 输出纯净(无错误、警告)
测试失败? 修复代码,非测试。
其他测试失败? 立即修复。
重构 - 清理
仅在绿色后:
- 移除重复
- 改进名称
- 提取辅助函数
保持测试绿色。不要添加行为。
重复
为下一个功能编写下一个失败测试。
好测试
| 质量 | 好 | 坏 |
|---|---|---|
| 最小 | 一件事情。名称中有“和”?分开它。 | test('验证电子邮件和域名和空格') |
| 清晰 | 名称描述行为 | test('测试1') |
| 显示意图 | 演示期望的API | 模糊代码应做什么 |
为何顺序重要
“我之后会写测试来验证它有效”
代码后写的测试立即通过。立即通过证明不了什么:
- 可能测试错误的事情
- 可能测试实现,而非行为
- 可能遗漏您忘记的边缘情况
- 您从未看到它捕获错误
测试先行强制您观察测试失败,证明它确实测试了某些东西。
“我已经手动测试了所有边缘情况”
手动测试是随机的。您认为测试了所有但:
- 没有记录您测试了什么
- 代码更改时无法重新运行
- 在压力下容易忘记案例
- “我试时有效” ≠ 全面
自动化测试是系统的。它们每次以相同方式运行。
“删除X小时工作是浪费的”
沉没成本谬误。时间已经过去。您现在选择:
- 删除并用TDD重写(X更多小时,高置信度)
- 保留它并在后添加测试(30分钟,低置信度,可能错误)
“浪费”是保留您无法信任的代码。没有真实测试的工作代码是技术债务。
“TDD是教条的,务实意味着适应”
TDD是务实的:
- 提交前发现错误(比之后调试快)
- 防止回归(测试立即捕获中断)
- 记录行为(测试显示如何使用代码)
- 支持重构(自由更改,测试捕获中断)
“务实”捷径 = 生产中调试 = 更慢。
“后写测试达到相同目标 - 是精神非仪式”
不。后写测试回答“这做什么?” 先写测试回答“这应做什么?”
后写测试被您的实现偏见。您测试您构建的,非所需的。您验证记得的边缘情况,非发现的。
先写测试强制在实现前发现边缘情况。后写测试验证您记住了所有(您没有)。
30分钟后写测试 ≠ TDD。您获得覆盖,失去证明测试有效。
常见理性化
| 借口 | 现实 |
|---|---|
| “太简单无需测试” | 简单代码会破坏。测试需30秒。 |
| “我后写测试” | 测试立即通过证明不了什么。 |
| “后写测试达到相同目标” | 后写测试 = “这做什么?” 先写测试 = “这应做什么?” |
| “已经手动测试” | 随机 ≠ 系统。无记录,无法重新运行。 |
| “删除X小时是浪费的” | 沉没成本谬误。保留未验证代码是技术债务。 |
| “保留作为参考,先写测试” | 您会适配它。那是后写测试。删除意味着删除。 |
| “需要先探索” | 好。丢弃探索,用TDD开始。 |
| “测试难 = 设计不清晰” | 倾听测试。难测试 = 难使用。 |
| “TDD会慢下来” | TDD比调试快。务实 = 测试先行。 |
| “手动测试更快” | 手动不证明边缘情况。您会为每个更改重新测试。 |
| “现有代码无测试” | 您正在改进它。为现有代码添加测试。 |
红色标志 - 停止并重新开始
- 代码在测试前
- 实现后写测试
- 测试立即通过
- 无法解释测试为何失败
- 测试“后”添加
- 理性化“仅此一次”
- “我已经手动测试了它”
- “后写测试达到相同目的”
- “是精神非仪式”
- “保留作为参考”或“适配现有代码”
- “已经花了X小时,删除是浪费的”
- “TDD是教条的,我是务实的”
- “这不同因为…”
所有这些意味着:删除代码。用TDD重新开始。
示例:错误修复
错误: 空电子邮件被接受
红
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
通过
重构 如果需要,为多个字段提取验证。
验证清单
在标记工作完成前:
- [ ] 每个新函数/方法有测试
- [ ] 观察每个测试失败在实现前
- [ ] 每个测试因预期原因失败(功能缺失,非拼写错误)
- [ ] 编写最小代码以通过每个测试
- [ ] 所有测试通过
- [ ] 输出纯净(无错误、警告)
- [ ] 测试使用真实代码(除非不可避免,使用模拟)
- [ ] 覆盖边缘情况和错误
无法勾选所有框?您跳过了TDD。重新开始。
当卡住
| 问题 | 解决方案 |
|---|---|
| 不知如何测试 | 写期望的API。先写断言。询问您的人类伙伴。 |
| 测试太复杂 | 设计太复杂。简化接口。 |
| 必须模拟所有 | 代码耦合太紧。使用依赖注入。 |
| 测试设置巨大 | 提取辅助函数。仍然复杂?简化设计。 |
调试集成
发现错误?写失败测试重现它。遵循TDD循环。测试证明修复并防止回归。
没有测试永不修复错误。
最终规则
生产代码 → 测试存在且首先失败
否则 → 非TDD
没有例外除非您的人类伙伴允许。