扒开单测陷阱, 做代码质量的掌控者

2023-06-02 11:07:09

单测的局限：高覆盖率并不能保证代码质量

我们常会听到这样的说法：代码的单测覆盖率越高，代码质量就越好。但事实真的是这样吗？

近年来，测试覆盖率成为衡量代码质量的重要指标，在很多公司甚至成为强制要求。然而，我们却经常会遇到这样的情况：虽然代码的单测覆盖率很高，但代码的质量却并不尽如人意，甚至存在着严重的缺陷。

单测的困扰

追求高覆盖率的单测常常会导致代码的过度测试，甚至是过度设计。为了提高覆盖率，测试工程师们不得不编写大量的测试用例，这不仅增加了测试成本，还降低了测试效率。更重要的是，这些测试用例往往难以维护和扩展，一旦代码发生变化，就需要对测试用例进行大量的修改。

当单测与代码耦合严重时，一旦代码发生变化，就需要对测试用例进行相应的修改。这不仅增加了测试成本，还降低了测试效率。更重要的是，这种耦合会导致代码的可维护性降低，使得代码的修改和维护变得更加困难。

测试用例是用来测试代码的，而不是用来实现业务逻辑的。然而，在实际的开发过程中，我们却经常会看到测试用例中混杂着大量的业务逻辑。这不仅降低了测试用例的可读性和可维护性，还使得测试用例难以理解和扩展。

单测是用来测试代码的正确性的，而不是用来测试代码的健壮性的。因此，如果过度依赖单测，就有可能导致代码的健壮性降低，从而导致系统在生产环境中出现问题。

摆脱单测困扰

为了摆脱单测的困扰，我们需要改变对单测的传统思维，重新思考单测的本质和目的。单测不是为了提高覆盖率，也不是为了满足某种形式上的要求，而是为了发现代码中的缺陷，从而提高代码的质量。

因此，我们应该把重点放在编写高质量的单测上，而不是追求高覆盖率。高质量的单测应该是：

易于编写和维护
独立于被测代码
能够有效地发现代码中的缺陷

如何编写高质量的单测

编写高质量的单测是一项技术活，需要一定的技巧和经验。以下是一些编写高质量单测的实用指南：

1. 关注核心逻辑，忽略细节

在编写单测时，不要过于关注被测代码的细节实现，而是应该关注核心逻辑。例如，如果被测代码是一个函数，那么只需要测试该函数的核心逻辑是否正确，而不需要测试该函数内部的细节实现。

// 错误示范：测试函数的细节实现
@Test
public void testAdd() {
  assertEquals(3, add(1, 2));
}

// 正确示范：关注函数的核心逻辑
@Test
public void testAdd() {
  assertEquals(3, add(2, 1));
}

2. 模拟外部依赖

在编写单测时，应该模拟所有外部依赖，如数据库、远程服务等。这可以防止测试用例受到外部依赖的影响，从而提高测试用例的稳定性。

// 错误示范：不模拟外部依赖
@Test
public void testSendMessage() {
  // 直接调用远程服务发送消息
  sendMessage("Hello, world!");
}

// 正确示范：模拟外部依赖
@Test
public void testSendMessage() {
  // 使用 mockito 模拟远程服务
  MessageService mock = mock(MessageService.class);
  when(mock.sendMessage("Hello, world!")).thenReturn(true);

  // 使用 mock 后的远程服务发送消息
  assertTrue(sendMessage(mock, "Hello, world!"));
}

3. 保持测试用例的独立性

测试用例应该是独立的，不应该依赖于其他测试用例。这可以防止测试用例之间产生耦合，从而提高测试用例的可读性和可维护性。

// 错误示范：测试用例之间有耦合
@Test
public void testAdd1() {
  add(1, 2);
}

@Test
public void testAdd2() {
  add(3, 4);
}

// 正确示范：保持测试用例的独立性
@Test
public void testAdd() {
  add(1, 2);
}

@Test
public void testAdd() {
  add(3, 4);
}

4. 编写易于阅读和理解的测试用例

测试用例应该易于阅读和理解，以便于其他工程师理解和维护。这可以防止测试用例成为代码的累赘，从而降低代码的可维护性。

// 错误示范：测试用例难以阅读和理解
@Test
public void testAdd() {
  assertEquals(3, add(1, 2, 3, 4, 5, 6, 7, 8, 9, 10));
}

// 正确示范：测试用例易于阅读和理解
@Test
public void testAdd() {
  // 将参数拆分成多个变量，使测试用例更易于理解
  int a = 1;
  int b = 2;
  int c = 3;
  int d = 4;
  int e = 5;
  int f = 6;
  int g = 7;
  int h = 8;
  int i = 9;
  int j = 10;

  assertEquals(55, add(a, b, c, d, e, f, g, h, i, j));
}