代码防御性编程的十条技巧汇总

在软件开发中，编写健壮、稳定且易维护的代码是每个开发者的追求。特别是在C++编程中，由于其复杂性和灵活性，如果没有良好的编程习惯，很容易导致难以调试和维护的代码。因此，防御性编程(Defensive Programming)成为了一个重要的编程原则。

防御性编程是一种编程策略，旨在通过考虑到各种可能的错误和异常情况，确保程序在任何情况下都能正常工作。这种方法强调在编码过程中尽可能早地发现并处理错误，以避免在运行时出现未预见的问题。

一、什么是防御性编程?

顾名思义，防御性编程是一种细致、谨慎的编程方法。为了开发可靠的软件，我们要设计系统中的每个组件，以使其尽可能的”保护”自己。我们通过明确地在代码中对设想进行检查，这是一种努力，防止我们的代码以将会展现错误行为的方式被调用。

防御性编程是指一种预见代码可能出现问题并提前采取措施来防止这些问题发生的编程风格。在前端开发中，这尤其重要，因为你的代码直接与用户交互，任何错误都可能导致糟糕的用户体验，甚至安全漏洞。

以下是如何在前端开发中进行防御性编程的一些关键策略：

1. 输入验证:

永远不要信任用户输入: 始终验证所有来自用户、API 或其他外部来源的数据。这包括检查数据类型、长度、格式和范围。

使用合适的验证库或工具: 利用现有的库或框架提供的验证功能，例如 Joi, Yup, validator.js 等，可以简化验证过程并提高代码的可读性。

对所有输入进行消毒: 防止跨站脚本攻击 (XSS) 等安全漏洞。使用专门的库或函数对输入进行转义或编码。例如，DOMPurify 可以帮助清理 HTML 输入。

2. 处理空值和未定义值:

使用可选链操作符 (?.) 和空值合并运算符 (??) : JavaScript 的这两个运算符可以有效地处理可能为空或未定义的值，避免出现 TypeError。

在访问对象属性之前进行检查: 在访问嵌套对象属性之前，确保父对象存在。

为函数参数设置默认值: 避免函数在缺少参数时产生意外行为。

3. 错误处理:

使用 try...catch 块: 捕获可能抛出的异常，并提供适当的错误处理机制。

记录错误信息: 使用 console.error 或专门的日志记录工具记录错误信息，以便调试和监控。

向用户显示友好的错误信息: 避免将原始错误信息直接展示给用户，而是提供更易理解和有帮助的提示。

处理异步操作中的错误: 使用 .catch() 方法捕获 Promise 或 async/await 函数中的错误。

4. 代码清晰和注释:

编写清晰易懂的代码: 使用有意义的变量名和函数名，并保持代码简洁。

添加必要的注释: 解释代码的逻辑和目的，尤其是在复杂的代码块中。

5. 使用类型检查:

使用 TypeScript 或 Flow: 这些工具可以帮助你在编译时发现类型错误，从而减少运行时错误的可能性。

6. 测试:

编写单元测试和集成测试: 确保代码的各个部分都能正常工作，并能正确地处理各种输入和边缘情况。

下面总结了一些防御性编程的反对和支持者的意见：

反对者：

它降低了代码的效;即使是一个很小的额外代码也需要一些额外的执行时间。它对于一个函数来说也许不要紧，但是对于一个由10万个函数组成的系统，问题就变得严重了。

每种防御性的做法都需要一些额外的工作;

支持者：

防御性编程可以节省大量的调试时间，使你可以去做更有意义的事情。

编写可以正常运行、只是速度有些慢的代码，要远远好过大多数时间都正常运行、但是有时候会崩溃的代码。

防御性编程避免了大量的安全性问题。

二、防御性编程技巧

2.1 使用好的编码风格和合理的设计

采用良好的编码风格，来防范大多数编码错误。如：

const关键字：

关键字const可以给读你代码的人传达非常有用的信息。例如，在函数的形参前添加const关键字意味着这个参数在函数体内不会被修改，属于输入参数。

同时，合理地使用关键字const可以使编译器很自然的保护那些不希望被修改的参数，防止其被无意的代码修改，减少bug的出现。

volatile关键字：

在一些并行设备的硬件寄存器(如状态寄存器)，中断服务子程序中会访问到的全局变量以及多线程应用中被几个任务共享的变量前使用volatile关键字来防止编译优化。

static关键字：

函数体内static变量的作用范围为该函数体，不同于auto变量，该变量的内存只被分配一次，因此其值在下次调用时仍维持上次的值。

在模块内的static全局变量可以被模块内的所有函数访问，但不能被模块外其它函数访问。

在模块内的static函数只可能被这一模块内的其它函数调用，这个函数的使用范围被限制在声明它的模块内。

位操作运算中，尽可能使用<<、 >>、 &、|等运算符，尽可能少使用/、%、*运算符。

变量和函数的命名要有意义，并且尽可能做到一个函数只做一件事情。

多采用面向对象的思想来编写代码。

在投入到编码工作之前，先考虑大体的设计方案，这也非常关键。

2.2 不要仓促的编写代码

欲速则不达，每敲一个字，都要想清楚你要输入的是什么。在写每一行时都三思而后行。可能会出现什么样的错误?你是否已经考虑了所有可能出现的逻辑分支?放慢速度，有条不紊的编程虽然看上去很平凡，但这的确是减少缺陷的好办法。

如C语言编程中，追求速度的程序员经常会出现的一个问题就是将==错误的输入为=，而有些编译器并不会警告，这就会造成问题。

2.3 不要相信任何人

这里是指用怀疑的眼光来审视所有的输入和所有的结果，直到你能证明这段代码是正确的时候为止。

2.4 编码的目标要清晰，而不是简洁

简单是一种美，不要让你的代码过于复杂。即编写的代码一定要逻辑清晰，可读性强。

2.5 编译时打开所有警告开关

在你的代码中产生任何警告信息，都应立即修正代码。要知道警告的出现总是有原因的。即使你认为某个警告无关紧要，也不要置之不理。

2.6 使用安全的数据结构

我们最常见的一些安全隐患大概是由缓冲溢出引起的。缓冲溢出是由于不正确的使用固定大小的数据结构而造成的。例如，如下这个代码：

char *unsafe_copy(const char *source)

{

char *buffer = new char[10];

strcpy(buffer,source);

return buffer;

}

123456

如果source中的数据长度超过10个字符，它就会造成其它问题。我们可以改成如下形式：

char * safe_copy(const char * source)

{

char *buffer = new char[10];

// 用strncpy代替strcpy可以保护这个代码段

strncpy(buffer,source, 10);

return buffer;

}

1234567

2.7 检查所有的返回值

如果一个函数返回一个值，他这样做肯定是有理由的。检查这个返回值，如果返回值是一个错误代码，你就必须辨别这个代码并处理所有的错误。不要让错误悄无声息的侵入你的程序;大多数难以察觉的错误都是因为程序员没有检查返回值而出现的。

2.8 审慎的处理内存

对于在执行期间所获取的任何资源，必须彻底释放。

2.9 在声明位置初始化所有变量

如果你意外的使用了一个没有初始化的变量，那么你的程序在每次运行的时候都将得到不同的结果，这取决于当时内存中的垃圾信息是什么。这样会造成很多随机的行为，给查找带来很多的麻烦。因此，需要在声明每个变量的时候就对它进行初始化。

同时，平时编码时还要注意一些细则

提供默认的行为:Switch语句中将default case的执行明示出来。同样地，如果你- 要编写一些不带else子句的if语句，停下来想一想，你是否该处理这个逻辑上的默认情况

检查数值的上下限：确保每次运算数值变量都不会溢出，即数据类型的使用要谨慎

注意强制转换是否合理

声明变量，可以使变量的声明位置与使用它的位置尽量接近，从而防止它干扰代码的其他部分

加合理的异常处理、日志文件

正确设置常量

2.10 优秀的程序应该做到

关心代码是否健壮

确保每个设想都显示地体现在防御性代码中

希望代码对无用信息的输入有正确的行为

在编程的时候认真思考自己所编写的代码

编写可以保护自己不受其他人的愚蠢伤害的代码。

实践中的防御性编程

在实际开发中，防御性编程不仅仅是一个技术问题，更是一种编码思维和习惯的养成。以下是一些具体的实践建议：

代码审查定期进行代码审查，发现潜在的错误和问题。通过集体智慧，可以提高代码的质量和健壮性。

编写单元测试单元测试可以帮助验证代码的正确性，捕获边界条件和异常情况。编写全面的单元测试是防御性编程的重要组成部分。

持续学习和改进防御性编程是一门需要不断学习和实践的艺术。通过阅读相关书籍、博客和参加技术讨论，可以不断提高自己的防御性编程水平。

结论

防御性编程在C++开发中扮演着重要的角色。通过遵循防御性编程的原则和实践，可以大幅度提高代码的健壮性、可维护性和安全性。