【译】PHP中的防御性编程

菲纳格动态逆定律：

会出错的，终将会出错 —- 在最糟糕的时刻。

防御性编程是什么意思

防御性编程,简单的说,就是在编程的时候有目的地预测可能的故障点。目的是在那些可能发生的问题发生前解决它们。你看见了问题，对吧？预测意料之外的事情本来就有内在的难度，当你想要预测意料之外的事情并且解决它就更是难上了好几倍。

下面我们看几个实际的例子。

条件语句

这是最容易进行防御性编程的地方之一，也是最容易满足的地方。在用PHP编程的许多情况下你不会需要“else”。

假设，你在写一个函数并且需要一个条件语句。在这里，你只需要为你特定的变量使用三个条件语句如下：

if($var == a){ }
else if($var == b){ }
else if($var == c){ }

没有其他可能性了，你说，并且继续码代码。但是，让我们在这里停一下。我知道你知道这里没有其他可能性了。并且我相信你。但有时候（不可预测的）情况会发生。我们忘掉了一些情况。我们检查错误。我们最终重用了一些代码，超出了原本的预定范围。突然我们有了泄露错误或者有时候是静默的错误状态，因为我们没有使用catch。使用else代码块。在使用switch时要使用default。用它们来返回或者记录错误，这样你才知道发生了什么（如果发生了的话）。虽然会多用两行代码，但当一些你无法预测的事情发生时，这是值得的。

绝不相信用户输入

你以前有没有听说过这个说法？大多数程序员听过。这有一点含糊，通俗点讲，理所当然。但它是真理。你绝不应该相信用户输入。这不是说你假设所有用户是疯狂的黑客，他们使用一些精心设计的命令来摧毁你的应用。没有必要妄想。但是，你应该假设用户不知道你的代码，他们不知道你需要填写什么参数，或者参数应该多长。他们不知道什么文件类型或者什么大小能上传（即使应用告诉了他们）。偶尔他们会是机器或者黑客并且他们希望在他们的输入中运行脚本，有时候甚至是在登陆后的输入中。你怎么知道你能相信认证或者验证码能在用户输入之前提供一个安全的堡垒？

答案：绝不。

你绝不相信用户输入。如果你信任的用户输入，那么你永远不会有一个突破。明白了吗？所以总是要评估你的输入，一定要保证你在处理数据尤其是要存入数据库或者要把它展示出来时使用了合适的技术。因此 – 绝不相信输入，即使来自不是用户的输入的地方 – 输入验证永远是你的朋友。看看Survive the Deep End: PHP Security 并且使用 validation library.吧。

对你的代码的假设

不要假设任何事情。如果前两个主题教会我们一些事情的话,那就是我们不应该做任何假设。作为程序员，尤其是致力于一个项目太久后，我们开始做很多假设。我们假设用户知道一些我们知道的事情。不一定是技术细节，也可以是程序的功能性细节。我们假设用户知道文件能有多大因为。。。我们已经知道。或者他们知道为了让邮件脚本。。。但事实不是，他们不知道以上任何东西。这好像更多的是前端的工作，但明显的是你在后端仍然要处理用户行为和用户输入，所以值得好好想想。

另一个许多程序员都会做的惊人的假设是我们在任何时候对于我们的函数，类或者其它代码段的明显的功能属性。一个具有防御性的程序员会仔细考虑的不仅仅是用一般的文档来描述函数是干什么的——他们也将写下他们对输入,参数,用例,或任何其他类似的东西做出的任何假设。因为我们都是人，我们过一段时间会忘掉一些事。我们最后也很可能会面临其他人维护，扩展或者替换我们的代码。如果没有别的,回想一下,编程是发生在一个充满技术变革的世界里。如果你的应用仍然能使用几年，可能会升级PHP版本并且失去一些功能，或者一些你自己代码里面具有交互的组件之间需要改变。预测这些是很困难的，所以好的注释和文档是非常重要的。

视野狭窄

另一件可以使我们忘记好的评论实践以及标准的东西是视野狭窄。许多程序员都具有视野狭窄的毛病。你知道这种感觉 - 你解决问题,你处于最佳状态。你觉得与你的音乐(或没有)独立于自己的小世界中，并且你就在编码，突然两小时过了，你意识到你已经写了无数行没有注释的代码。我们所有人偶尔都会遇到这种事情，但重要的是在某处发现这个情况并且补上应有的注释。

语法和命名的一致性

一致性是一个灰色地带 – 它更多的是关于编码标准之类的，但它和防御性编程也有联系。在PHP中，有标准规范你的代码格式以便别人查看，或者你以后使用。但常常没人让你的代码标准化。但是无论你是否按照标准编码，你至少要保持一致性 – 这能让你少犯错误。这对于需要大量时间返回并且修复的小的语法错误尤其适用。如果你总是使用相同的间隔，格式和语法，命名规格等等你就能更好的避免犯错以至于误读你自己的代码。你更可能快速浏览代码并且找到你需要的东西。

总结

总的来说，除去用户行为和动作，不要对你的程序做任何假设。假设是具有防御性编程习惯的程序员最大的敌人。不要假设你不需要 default 语句或者 else 代码块。尽量使用正确的用户错误信息，警告，日志或者任何其它你假设不会用到的代码。你的假设通常是正确的 – 但我们不在乎。我们在乎的是它们出错的时候。一定要计划得好，准备着你可能需要在几小时，几周，几个月甚至几年后回顾你的代码，或者其他人需要 – 相应的就要好好写文档。别假设它永远不需要升级，扩展或者维护。那是无知的，在更多的情况下是疏忽。有时候保持一颗防御性编程的心能帮你更有效更安全地估计，计划和编程。