有选择的保留遗留“惯例”

十一月 15, 2010

在工作中，我们常常会听到这样的声音：“原来的系统就是这么做的！”。

没错儿，在工作中我们潜移默化地受到了遗留系统的一些设计和实现的“惯例”的影响，另外天生携带的懒惰基因使我们很少去思考和判断这些惯例的正确性和保留的必要性。但事实上，我们确应该经常重新审视这些遗留的“惯例”，有选择的保留，并敢于放弃。

每种“惯例”的引入和使用都是有其特定原因的：或是可以简化代码编写，或是便于代码跟踪，或是利于代码调试，或是迫于对外部工具的妥协，也有的是为了偷懒儿^_^，甚至有些惯例的引入本身就是不妥当的甚至是错误的，只是当时无人喊出反对的声音，也就被保留了下来。

新项目启动已两月有余，除了前期参与一些编码外，现在的我更多是代码检查和评审者的角色。在这个角色上，我看到了一些本不该保留下来的遗留“惯例”，这里挑了几个拿出来说说。

#1 – 在源代码文件中记录代码变更信息
在遗留系统的一个典型的“惯例”就是在源文件中（包括.h和.c文件）记录代码变更信息，比如下面的例子：

/*
* foo_test.c
*
* NUM | description    | by     | date      |
* 001 | 添加XX业务逻辑 | xx     | 20100805 |
* 002 | 修改YY业务逻辑 | yy     | 20100809 |
* 003 | 删除ZZ业务逻辑 | zz     | 20100809 |
* … …
*/

在foo_test.c的开始处，开发人员记录了所有关于这个文件的所有变更信息索引，此外在该源文件中充斥着诸如：001+、002*和003-这样的注释信息，以跟踪源码的变动。

这个遗留“惯例”的出处已无法追溯了，也许是当初没有对版本控制工具的功能特性有着很充分的认识，也许还可能是当初干脆就没有引入版本控制工具，不过无论如何，在subversion、git等版本控制工具大行其道的今天，这样的“惯例”已不再合适，它会使我们的代码不再clean。

现在我们一般推荐采用版本控制工具的commit log与ChangeLog相结合的方式来管理和跟踪代码变更，更精确的说是使用commit log详细跟踪代码变更，而使用ChangeLog来跟踪功能变更和某些重要的bugfix。在提倡频繁提交与集成的今天，ChangeLog会显得尤为重要，它与commit log相辅相成。如果没有ChangeLog粗线条地记录项目功能变更，指望大家从数量繁多的commit log中提炼出功能变更是不现实的、不具备可操作性的、也是不可接受的。

#2 – 过度使用续行符
在新项目代码里，我发现了一些使用续行符的代码，诸如：
void foo(int a, int b, \
char *p, \
struct foo_t *f);

printf("%s\n", "Foo Test, \
,Test Foo");

printf("%d, %s, %d\n", \
        a,\
        "Foo Test",\
        b);

我之前只是在遗留系统中见识过类似的代码，显然这是受到了遗留代码“惯例”的影响了。

续行符，顾名思义，当一行代码过长，影响代码整体美观或超出编译器每行最大字符数限制时采用的方法，用于指示编译器续行符前后的两行实际上应作为一行处理。以前的编译器不足够智能，甚至每行支持的最大字符数也很少，有些时候确要使用续行符来辅助编码。但是如今编译器愈来愈强大，续行符的使用场合已经不多了。将上面代码改造为如下代码编译器也完成可以处理：
void foo(int a, int b,
char *p,
struct foo_t *f);

printf("%s\n", "Foo Test,"
",Test Foo");

printf("%d, %s, %d\n",
        a,
        "Foo Test",
        b);

其中第一个printf中分属两行的字符串会被编译器自动连接成一行字符串对待，这还可以解决使用续行符导致的"Foo Test"和",Test Foo"之间出现多余空格的情况。续行符可以用到的场合似乎只剩下多行宏定义中了。

#3 subversion源码库中保存二进制文件
我们的产品一直运行在Sun小型机上，CPU是Ultra Sparc，OS为Solaris，长期如此也导致了我们很少考虑可移植性问题，甚至在遗留系统中，我们直接将第三方库的sparc solaris版本的.a文件放入了Subversion的源码库中管理，这样我们Checkout出来后便可以直接链接生成可执行文件。

这样的“惯例”延续到了新项目中，不过我们的新项目近期修改了目标，可移植性列上了日程，目标平台不再只是单一的Sparc Solaris了。如果我们继续坚守这个“惯例”，那么将会给我们带来不小的第三方库版本管理上的麻烦，甚至连Makefile都要跟随着不断做调整。所以是时候将特定目标平台的二进制.a文件从源码库中移除了，具体方法这里不赘述了。

变化是永恒的，经常反思一下你日常工作中那些所谓的“惯例”，它们真的值得继续保留下去吗？