不良系统设计上的代码重构

Question

我是一名初级软件工程师，曾负责接管旧系统。根据我的初步评估，该系统存在几个问题。

1. 意大利面代码
2. 重复码
3. 10k行及以上的课程
4. 使用log4j滥用和过度记录
5. 错误的数据库表设计
6. 缺少源代码管理->我为此设置了Subversion
7. 缺少文档->除了阅读代码外，我对业务规则一无所知

我应该如何处理才能提高系统质量并解决此类问题？我可以考虑使用静态代码分析软件来解决任何不良的编码做法。

但是，它无法检测到任何不良的设计问题。我应该如何逐步解决这些问题？

Answer 1

首先关注稳定性。您必须在应用程序周围建立某种稳定的环境，然后才能增强或重构。

一些想法：

1. 修订控制 。您已经通过设置Subversion开始。现在，确保您的数据库架构，存储过程，脚本，第三方组件等也都处于修订控制之下。有一个版本标记系统，请确保您标记版本，并且将来可以准确访问旧版本。
2. 构建并发布 。有一种方法来建立一个机器上的稳定版本 的其他 比你的dev的机器。您可能要使用ant / nant，make，msbuild甚至批处理文件或shell脚本。如果部署脚本/安装程序不存在，则可能也需要它们。
3. 对其进行测试 。在您有办法知道您的更改是否破坏了它之前，请不要更改该应用程序。为此，您需要测试。希望您应该能够为一些更简单的独立类编写xunit单元测试，但是尝试构建一些可对整个应用程序进行练习的系统/集成测试。如果没有较高的代码覆盖率（您不必首先开始），那么集成测试是您的最佳选择。养成尽可能经常运行测试的习惯。抓住一切机会扩展它们。
4. 进行小而集中的更改 。尝试识别应用程序中的系统/子系统，并改善它们之间的界限。这样可以减少您所做更改的连锁影响。注意通过重新格式化或采用最新的流行设计模式来“美化”代码的诱惑。扭转这样的系统需要 时间 。
5. 文件资料 。它是必需的，但不必太担心。根据我的经验，很少使用系统文档。好的测试通常比好的文档更好。专注于记录应用程序与运行它的系统上下文之间的接口（输入，输出，文件结构，数据库模式等）。
6. 管理期望 。如果它的状态不好，那么它可能会阻止您进行更改，并且时间表可能比平时更难估计。确保管理层和利益相关者理解这一点。

不惜一切代价，要提防只重写整个内容的诱惑。在这种情况下，这几乎永远都不是正确的事情。如果可行，请集中精力使其正常运行。

作为初级开发人员，不要害怕寻求帮助。正如其他人所说， 《有效使用旧版代码》 是一本好书，Martin Fowler的《 Refactoring
》 也是一本好书。

祝好运！