学习 C++ / 第 3.10 课

在问题变成故障前发现问题

7 分钟阅读

发生语义错误时,运行程序不一定能立即发现。问题可能在代码中隐藏很久,直到新增代码或环境变化使它表现为程序故障。错误在代码库中存在得越久,越难被发现;原本容易修复的问题,最终可能变成一场耗时耗力的调试冒险。

那么我们能做些什么呢?

避免制造错误

最好的办法当然是一开始就避免错误。下面这些做法有助于减少错误:

  • 遵循最佳实践。
  • 疲惫或沮丧时不要编程,休息一下,之后再回来。
  • 了解语言中常见的陷阱,也就是我们提醒你不要做的那些事情。
  • 不要让函数变得过长。
  • 在可能的情况下,优先使用标准库,而不是自己编写代码。
  • 充分为代码添加注释。
  • 从简单方案开始,再逐步增加复杂度。
  • 避免聪明但晦涩的方案。
  • 优先考虑可读性和可维护性,而不是性能。

众所周知,调试程序的难度是最初编写程序的两倍。因此,如果编写时把代码写得尽可能“聪明”,以后又如何调试呢?

—Brian Kernighan, “The Elements of Programming Style”, 2nd edition

重构代码

随着程序不断增加新功能(“行为变化”),一些函数会越来越长。函数越长,就越复杂,也越难理解。

一种解决办法是把一个长函数拆成多个较短的函数。在不改变代码行为的前提下修改代码结构,这个过程称为 重构. 重构的目标是通过提高程序的组织性和模块化程度来降低复杂性。

那么函数多长才算过长?通常认为,占满一屏高度的函数就太长了——如果必须滚动才能读完,函数的可理解性会明显下降。理想情况下,函数应少于十行,少于五行则更好。

记住,这里的目标是最大化可理解性和可维护性,而不是最小化函数长度。为了省下一两行代码而放弃最佳实践或使用晦涩技巧,并不会让代码变得更好。

关键要点

修改代码时,应先进行行为变化或结构变化,然后重新测试正确性。同时进行两种变化往往会引入更多错误,也会让错误更难发现。

防御式编程简介

错误不仅可能由你自己造成(例如逻辑错误),也可能在用户以未预料的方式使用应用程序时发生。例如,要求用户输入整数,但用户输入了字母,程序会如何表现?如果没有预见这种情况并添加错误处理,结果可能不会很好。

防御式编程 是一种编程实践:程序员尝试预见软件可能被误用的所有方式,无论误用者是最终用户还是使用代码的其他开发者(包括程序员自己)。这些误用通常可以被检测并缓解(例如要求输入错误的用户重试)。

我们将在后续课程中继续探讨错误处理。

快速发现错误

在大型程序中完全不犯错很难,因此退而求其次,就是尽快发现已经犯下的错误。

最好的方法是一次编写少量代码,然后测试代码并确认它能正常工作。

此外,还可以使用一些其他技术。

测试函数简介

帮助发现程序问题的一种常见方法,是编写测试函数来“锻炼”所写的代码。下面是一个简单示例,主要用于说明:

C++
#include <iostream>

int add(int x, int y)
{
	return x + y;
}

void testadd()
{
	std::cout << "This function should print: 2 0 0 -2\n";
	std::cout << add(1, 1) << ' ';
	std::cout << add(-1, 1) << ' ';
	std::cout << add(1, -1) << ' ';
	std::cout << add(-1, -1) << ' ';
}

int main()
{
	testadd();

	return 0;
}

testadd() 函数通过使用不同值调用 add() 函数来测试它。 如果所有值都符合预期,就可以较有把握地认为函数能够正常工作。 更好的是,我们可以保留这个函数,每次修改 add 函数时运行它,确保没有意外破坏功能。

这是一种简单形式的 单元测试,即通过测试源代码中的小单元来判断其是否正确的软件测试方法。

与日志框架一样,也有许多可用的第三方单元测试框架。 你也可以编写自己的工具,不过要充分讨论这个主题,还需要掌握更多语言特性。 后续课程会再讨论其中一部分内容。

约束简介

基于约束的技术会增加一些额外代码(如有需要,可在非调试构建中编译掉),用于检查某些假设或预期是否被违反。

例如,编写计算阶乘的函数时,如果要求实参非负,函数可以在继续执行前检查调用者是否传入非负数。如果传入负数,函数可以立即报错,而不是产生不确定结果,从而确保问题被及时发现。

一种常见方法是使用 assert 和 静态_assert,本教程将在课程 9.6 -- assert 与 静态_assert。

用“散弹枪”处理一般问题

程序员容易犯某些常见错误,而专门用于查找这些错误的程序可以发现其中一部分。这些程序通常称为 静态分析工具 (有时也非正式地称为 代码检查器),它们分析源代码以识别特定的语义问题(这里的 静态 的意思是这些工具会在不执行程序的情况下分析源代码). 静态分析工具发现的问题不一定是当前具体故障的原因,但可以帮助指出脆弱的代码区域,或在特定情况下可能出问题的地方。

你手头已经有一个静态分析工具了——编译器! 除了确保程序语法正确,大多数现代 C++ 编译器还会执行一些轻量级静态分析,以识别常见问题。 例如, 如果尝试使用未初始化的变量,许多编译器都会发出警告。如果还没有这样做,请提高编译器的警告和错误级别 (详见课程 0.11 -- 配置编译器:警告与错误级别)来发现这些问题。

有许多静态分析工具, 其中一些工具可以识别 300 多种编程错误。在小型学习项目中,静态分析工具不是必需的,但使用它可以帮助你找出不符合最佳实践的代码区域。 对于大型程序,强烈建议使用静态分析工具,因为它可以发现几十甚至数百个潜在问题。

最佳实践

对程序使用静态分析工具,帮助找出不符合最佳实践的代码区域。

Visual Studio 用户

Visual Studio 2019 及更高版本自带静态分析工具。 可以通过 Build > Run Code Analysis on Solution (Alt+F11) 访问该功能.

提示

常见的静态分析工具包括:

免费工具:

其中大多数都有可集成到 IDE 中的扩展。例如, Clang Power 工具扩展。

付费工具(开源项目可能免费):

最后更新