维护代码库的五个精华实践

摘要：代码库就像是一个盆景，如果平时没有照顾好这个盆景，那里面的植物无非是错综复杂，或者是干枯凋落。代码库亦然，如果不定期清理无用代码、组件，出现的情况也无非就是软件项目无法正常运行。故，代码库维护不可缺。

本文作者John Croisant是Atomic Object网站的董事长兼联合创始人，在这篇文章里主要讲述维护代码库的重要性，拿修剪盆栽植物来比喻清理代码库的必要性。为了保证代码库的实用寿命和流畅的使用效果，定期进行代码库整理是必不可少的过程。（以下编译内容）

乍一看，盆栽植物和大型软件代码库没什么共同点，但事实上它们有很多相似之处。因为这两者都需要定期维护、清理以保持健康和持续增长。一旦它们被忽视，那也就是腐烂开始的时候了。

大多数植物是很容易照顾的。但有一种蕨类植物是很难伺候的，如果水分不够，或者是阳光不充足，郁郁葱葱的美貌也会变成干瘪的黄草。

万物有那么多的相似之处，软件项目同样需要不断地维护才能保持正常、良好的运行状态。如果你花足够的时间和充裕的精力去管理你的软件项目，那么它一定会更加成熟，并能在很长一段时间里保持健康。那么怎样维护代码库才能让软件项目正常工作呢？

1. 关照整个代码库环境。照顾植物的时候，首先要确保整个植物能够得到足够的水份和阳光，而不是给一部分枝叶晒到阳光就可以了。同样，你需要不时的关注整个代码库环境，而不是你现在所关注的、正在使用的那一小范围的代码库。因为代码库会对存储器里的工作方式进行刷新，所以开发者要关注数据冗长、代码不一致、无用代码等之前从不会注意到的东西。

2. 将功能蔓延扼杀在萌芽状态。盲目地将新功能添加到代码库无异于将代码库扼杀在一片混沌之中。在添加一个选项、功能、类或特性之前，要问问自己或者是开发团队：真的有必要添加这些东西吗？这是最合适的地方吗？它所提供的重要的功能在其他地方有用吗？在添加代码之前慎重的检查一下代码库，这能够节省下很多时间。与其用那么多时间去写那些无用代码，还不如花点时间全面的检查一下整个运行环境的一致性。这么做的另一个目的就是为将来的代码库维护做好充分准备。

3. 清理混乱代码。如果在平时的开发工作中对代码漠不关心的话，相关代码之间可能会出现紊乱倾向，就像两个藤蔓在生长过程中缠绕着对方一样。所以，开发者需要花点时间重构代码，使用抽象和封装技术，并在组件之间创建新的、明确的接口。这样做有利于保持代码库的整洁、工作上会更便利。

4. 删除无用代码。无用代码，说白了就是不再继续使用的代码、没用的代码、或者是被注释掉的代码，可以说无用代码是一种比较常见的麻烦代码，尤其是在大型代码库里。这种代码就像植物的枯枝烂叶，积累在代码库会对代码的理解和维护造成一定的阻碍。如果发现无用代码一直徘徊在代码库里，必须毫不犹豫的删除它。当然了，最重要的是在平时的开发、维护中保持警惕！

5. 移除冗余的组件。当植物的枝叶过于茂盛的话，可以将它们修剪一下，或者是分成大大小小的枝杈。如果代码库太大，这样的方法也可以用在代码库的清理上：首先要识别跟组织相关的组件，并将它们分成多个独立的伴随着目的明确的API类库。同样的方法也适用于规模较小代码库：将冗余的类库分解为多个小类库，或者是重构过多的功能，将它们分成无数个较小的功能。

如果你只是想让你的代码库和简简单单的成长发展，在没有将代码库作为一个整体去维护的前提下添加更多的代码和新功能的话，代码库迟早会停滞不前，甚至是崩溃。如果真到了那个时候，你会发现后悔已经晚了，只能删掉无用代码，来适应新的项目要求。防患于未然，只能是从源头开始对代码库进行整理、清洁。                                                                                                       （编译/薛梁）

原文：Atomic Object