今天总结的是程序员修炼之道第二部分的内容;

Chap2 注重实效的途径

程序需要遵守的实用主义原则。

重复的危害:如果某个事物在代码中重复多次,就可能会在维护过程中带来问题,因为改动了一处而忘记改动另一处造成自相矛盾。这加大了维护难度。要遵守DRY原则,即Don’t repeat yourself。

重复通常由这些东西引起:

强加的重复,由文档或用户需求决定。这通常可以依照情况消除。需要重复表示的信息可以用元数据schema与代码生成器消除重复。注释与代码会重复,但实际上这种重复没有必要:注释不应重复代码中显而易见的东西,而应该表达更高级的东西。文档与代码也会重复,可以利用文档生成工具。有些语言会强加一些重复,这比较难解决,只能依情况而定,一些基本的技术是cpp中不要在其他文件中引用函数,而应该使用头文件。

无意的重复,由设计的疏忽造成,需要积极的检查和重构。如果为了性能需要违反DRY原则,记得将重复本地化,不要泄漏到模块外,并保持模块内行为良好。

无耐性的重复,可能造成远大于一时麻烦的痛苦后果。程序员要学会约束自己。

开发者之间的重复,需要加强开发者之间的沟通。

正交性:指系统各同层次的组件之间没有依赖关系,改变一个不影响另一个。如果系统不符合正交性,测试与维护会非常痛苦。而正交性的系统在出问题时更容易隔离修复,进行拓展时也不必改动已有模块,增加了生产力。

为了达到正交性,需要将团队分为几个清晰的小组分别工作,对系统进行模块化的设计。可以通过询问“讨论某个改动时需要设计多少人”判断小组分工是否正交,通过询问“改动某个模块背后的需求,会有多少模块受到影响?”判断系统设计是否正交。

引入第三方库时可能会破坏正交性,要小心不要使第三方库对整体代码造成改动。如果第三方库的接口存在问题,可以将第三方库用适合自己代码的方式进行封装。

编码也有可能破坏正交性,需要注意:使代码保持解耦,除了需要的功能不要暴露其它细节。避免使用全局数据。避免编写相似的函数。

对项目进行测试与debug也可以检查项目的正交性。如果测试或修正一个小模块会带来许多其它的影响,那么系统不够正交。

正交性同样适用于文档,文档内容与表达形式应该解耦。这让我想到了markdown……

可撤销性:许多需求会改变,许多政策会改变,所以编写项目时任何决策都应该可以撤销。项目结构应该保持灵活,不要依赖某个已有决策。

曳光弹:这个比喻有点晦涩。作者介绍了一种方法,编码之初先搭建一个大致框架,然后慢慢填充编码。这样既可以方便编码,又可以随时与用户沟通项目是否符合他们的需求。假如现有成果不符合需求,可以立马进行修改,而不必等代码基本固定时候再进行重构。

原型与便笺:不同于曳光弹,曳光弹在使用之后继续保留,只是逐渐“生长”成更完整的系统。原型是为了分析某个功能或需求建立的简化模型,将细节遮蔽以方便分析,用来找到最好的实现方式,然后便丢弃不用。如分析UI需求时先用绘图板确定最合适的UI,再用编码实现。

领域语言:任何领域都有自己的语言,如用于配制的语言,用于文档的语言,用于描述需求的语言。可以发展一种小型语言。小型语言分两种,配置语言方便解析但难以阅读,命令语言相当于小型的脚本语言,更近似于自然语言,但解析难度更高。小型语言可以是独立的语言,也可以嵌入高级语言的代码,方便直接执行。

这是一个非常有趣的设想,然而很可惜,在我们的项目中,受限于我们的项目规模,这个设想不太可行。然而这给了我两个启发:

  1. 进行编程时,首先将用户需求抽象化。用户需求常常是用自然语言表达的,通常包含许多复杂的要求,如在某些情况下将某个数据传输到另一个服务器,在某些情况下丢弃数据,在某些情况下反馈警告等。直接试图将自然语言描述的需求转化成代码很可能会非常困难,这时候先将需求抽象成一个无关具体细节实现的逻辑框架会更容易,不管是流程框图、伪代码还是别的什么。这也是自顶而下的思想。
  2. 很多时候编写代码需要满足的需求并不是用户的,而是直接对接的下一层的需求。比如负责数据库层的程序员可能需要满足负责算法层的程序员的需求。在这种情况下,交流时需要尽量良好地描述需求的逻辑。这也需要清晰的层与层之间的接口以及风格良好的文档。
  3. 模块与模块之间的信息交流需要清晰、易于解析并易于扩展。

估算:要学会估算。估算的方法在于限定问题的情景范围,对系统建立模型,对模块进行拆分并分别估算,抹去可忽略不计的量。估算不需要过于精确,但需要细心。