test-driven-development

test-driven-development

热门

在实现任何功能或修复缺陷之前使用,先编写测试代码

23万Star
2.2万Fork
更新于 2026/5/4
原文已更新,当前译文正在重新翻译。
SKILL.md
readonly只读
name
test-driven-development
description

在实现任何功能或修复缺陷之前使用,先编写测试代码

测试驱动开发(TDD)

概述

先编写测试。观察它失败。编写最简代码使其通过。

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

违反规则的文字就是违反规则的精神。

何时使用

始终使用:

  • 新功能
  • 缺陷修复
  • 重构
  • 行为变更

例外情况(请询问你的人类伙伴):

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

想着“就这一次跳过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('失败操作重试3次', async () => {
  let attempts = 0;
  const operation = () => {
    attempts++;
    if (attempts < 3) throw new Error('fail');
    return 'success';
  };

  const result = await retryOperation(operation);

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

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

<坏>

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

确认:

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

测试通过了? 你在测试已有行为。修正测试。

测试报错了? 修复错误,重新运行直到正确失败。

绿 - 最简代码

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

<好>

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('unreachable');
}

刚好能通过
</好>

<坏>

async function retryOperation<T>(
  fn: () => Promise<T>,
  options?: {
    maxRetries?: number;
    backoff?: 'linear' | 'exponential';
    onRetry?: (attempt: number) => void;
  }
): Promise<T> {
  // YAGNI
}

过度设计
</坏>

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

验证绿 - 观察它通过

必须执行。

npm test path/to/test.test.ts

确认:

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

测试失败了? 修复代码,而不是测试。

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

重构 - 清理代码

仅在绿色之后:

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

保持测试绿色。不要添加行为。

重复

下一个功能的失败测试。

好的测试

质量
最简 一件事。名称中有“和”?拆开。 test('validates email and domain and whitespace')
清晰 名称描述行为 test('test1')
展示意图 演示期望的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('Email required');
});

验证红

$ npm test
FAIL: expected 'Email required', got undefined

绿

function submitForm(data: FormData) {
  if (!data.email?.trim()) {
    return { error: 'Email required' };
  }
  // ...
}

验证绿

$ npm test
PASS

重构
如果需要,提取验证逻辑以支持多个字段。

验证清单

在标记工作完成之前:

  • [ ] 每个新函数/方法都有测试
  • [ ] 在实现之前观察了每个测试失败
  • [ ] 每个测试因预期原因失败(功能缺失,而非拼写错误)
  • [ ] 编写了最简代码使每个测试通过
  • [ ] 所有测试通过
  • [ ] 输出干净(无错误、无警告)
  • [ ] 测试使用真实代码(除非不可避免,否则不用mock)
  • [ ] 覆盖了边缘情况和错误

不能勾选所有项?你跳过了TDD。重新开始。

遇到困难时

问题 解决方案
不知道如何测试 编写期望的API。先写断言。询问你的人类伙伴。
测试太复杂 设计太复杂。简化接口。
必须mock所有东西 代码耦合太紧。使用依赖注入。
测试设置庞大 提取辅助函数。仍然复杂?简化设计。

调试集成

发现缺陷?编写失败的测试复现它。遵循TDD周期。测试证明修复并防止回归。

永远不要在没有测试的情况下修复缺陷。

测试反模式

当添加mock或测试工具时,阅读 @testing-anti-patterns.md 以避免常见陷阱:

  • 测试mock行为而非真实行为
  • 在生产类中添加仅测试用的方法
  • 在不理解依赖的情况下mock

最终规则

生产代码 → 测试存在且先失败
否则 → 不是TDD

未经人类伙伴许可,没有例外。