跳转到内容

Spec 与 TDD 开发实践

在现代软件开发中,Spec(规格说明)和 TDD(测试驱动开发)是两种重要的工程实践,它们能够显著提高代码质量、可维护性和团队协作效率。

Spec(Specification,规格说明)是对软件功能、接口或行为的详细描述文档。它是开发团队之间的契约,确保所有人对系统行为有一致的理解。

描述系统应该做什么,通常包括:

  • 用户故事(User Stories)
  • 功能需求
  • 非功能需求(性能、安全性等)

描述系统如何实现,包括:

  • API 接口定义
  • 数据模型设计
  • 架构决策
  • 技术选型

描述系统的具体行为,常用格式:

Given [前置条件]
When [触发动作]
Then [预期结果]
  1. 清晰明确:避免模糊的表述,使用具体的数值和条件
  2. 可测试:每个规格都应该能够被验证
  3. 完整性:覆盖正常流程和边界情况
  4. 可维护:随着项目演进及时更新
  5. 版本控制:将 Spec 纳入版本控制系统
## 用户登录功能规格
### 正常流程
- Given: 用户已注册,邮箱为 [email protected],密码为 Pass123!
- When: 用户输入正确的邮箱和密码并提交
- Then: 系统返回 JWT token,用户成功登录
### 边界情况
- Given: 用户输入错误的密码
- When: 提交登录请求
- Then: 系统返回 401 错误,提示"密码错误"
- Given: 用户连续 5 次输入错误密码
- When: 第 6 次尝试登录
- Then: 账户被锁定 15 分钟

TDD(Test-Driven Development,测试驱动开发)是一种软件开发方法论,核心思想是先写测试,再写实现代码。

┌─────────────┐
│ 1. Red │ 写一个失败的测试
│ (红灯) │ ↓
└─────────────┘
↓
┌─────────────┐
│ 2. Green │ 写最少的代码让测试通过
│ (绿灯) │ ↓
└─────────────┘
↓
┌─────────────┐
│ 3. Refactor │ 重构代码,保持测试通过
│ (重构) │ ↓
└─────────────┘
↓
循环...
  1. 更高的代码覆盖率:测试先行确保每行代码都有对应的测试
  2. 更好的设计:为了可测试性,代码自然趋向低耦合、高内聚
  3. 即时反馈:快速发现问题,减少调试时间
  4. 活文档:测试用例本身就是代码行为的文档
  5. 重构信心:有测试保护,可以大胆重构
// 测试
describe('Calculator', () => {
it('should add two numbers', () => {
expect(add(1, 2)).toBe(3);
});
});
// 实现(最简版本)
function add(a, b) {
return a + b;
}
// ✅ 好的实践:每个测试关注一个行为
it('should return 404 when user not found', () => { ... });
it('should return 200 when user exists', () => { ... });
it('should return user data in response', () => { ... });
// ❌ 避免:一个测试验证多个行为
it('should handle user lookup', () => {
// 验证了太多东西
});
// ✅ 好的命名
it('should throw error when email format is invalid', () => { ... });
it('should hash password before saving to database', () => { ... });
// ❌ 差的命名
it('should work', () => { ... });
it('test1', () => { ... });
it('should withdraw money from account', () => {
// Arrange(准备)
const account = new Account(1000);
// Act(执行)
account.withdraw(300);
// Assert(断言)
expect(account.balance).toBe(700);
});

Spec 和 TDD 是互补的实践,可以结合使用:

1. 编写 Spec
↓
2. 将 Spec 转化为测试用例
↓
3. 运行测试(应该失败)
↓
4. 实现代码让测试通过
↓
5. 重构代码
↓
6. 验证实现是否符合 Spec
## 购物车功能
### 添加商品
- Given: 购物车为空
- When: 添加商品 A(价格 100 元,数量 1)
- Then: 购物车包含 1 件商品,总价 100 元
### 修改数量
- Given: 购物车有商品 A(数量 1)
- When: 将数量改为 3
- Then: 商品 A 数量变为 3,总价 300 元
describe('ShoppingCart', () => {
let cart;
beforeEach(() => {
cart = new ShoppingCart();
});
describe('addItem', () => {
it('should add item to empty cart', () => {
cart.addItem({ id: 'A', price: 100, quantity: 1 });
expect(cart.items).toHaveLength(1);
expect(cart.total).toBe(100);
});
});
describe('updateQuantity', () => {
it('should update item quantity', () => {
cart.addItem({ id: 'A', price: 100, quantity: 1 });
cart.updateQuantity('A', 3);
expect(cart.items[0].quantity).toBe(3);
expect(cart.total).toBe(300);
});
});
});
class ShoppingCart {
constructor() {
this.items = [];
}
addItem(item) {
this.items.push(item);
}
updateQuantity(itemId, quantity) {
const item = this.items.find(i => i.id === itemId);
if (item) {
item.quantity = quantity;
}
}
get total() {
return this.items.reduce(
(sum, item) => sum + item.price * item.quantity,
0
);
}
}
  • Jest:功能完整的测试框架
  • Vitest:快速的 Vite 原生测试框架
  • Mocha + Chai:灵活的测试组合
  • pytest:强大的测试框架
  • unittest:内置测试库
  • JUnit:标准的单元测试框架
  • Mockito:Mock 对象框架
  • Testing Library:用户视角的 UI 测试
  • Cypress:端到端测试
  • Playwright:跨浏览器自动化测试

问题:测试套件运行时间过长
解决:

  • 使用 Mock 替代真实数据库/API 调用
  • 并行运行测试
  • 只运行变更相关的测试(watch 模式)

问题:代码重构导致大量测试失败
解决:

  • 测试行为而非实现细节
  • 避免过度 Mock
  • 使用 Testing Library 等工具

问题:现有代码难以添加测试
解决:

  • 引入依赖注入
  • 拆分大函数
  • 使用特征开关逐步重构

问题:追求 100% 覆盖率但质量不高
解决:

  • 关注有意义的测试,而非数字
  • 使用变异测试(Mutation Testing)评估测试质量
  • 定期审查测试代码

Spec 和 TDD 是现代软件开发的重要实践:

  • Spec 提供清晰的需求定义,是团队协作的基础
  • TDD 通过测试先行,确保代码质量和可维护性
  • 两者结合 能够显著提高开发效率和产品质量

记住:

  1. Spec 应该是活的文档,随项目演进
  2. TDD 不是银弹,但能帮助你写出更好的代码
  3. 测试也是代码,需要同样重视质量
  4. 从小处开始,逐步建立团队的测试文化