极狐 GitLab

功能重命名

有时业务方要求更改某个功能的名称。总的来说,有 2 种方法来处理这项任务。它们基本上是在即时工作量与未来复杂性和故障风险之间进行权衡:

  • 完全重命名,重命名代码库中的所有相关内容。
    • 优点:不会增加代码复杂性。
    • 缺点:执行工作量更大,即时出现故障的风险更高。
  • 外观方法,尽可能少重命名;只重命名面向用户的内容,如界面、文档、错误消息等。
    • 优点:执行工作量更少。
    • 缺点:会增加代码复杂性,未来出现故障的风险更高。

何时选择外观方法#

以下情况越多符合,就越应该选择外观方法:

  • 你不确定新名称是永久性的。
  • 该功能容易出错(规模大、复杂、需要重构等)。
  • 重命名难以审查(该功能涉及许多行、文件或代码库)。
  • 重命名在某些方面会带来破坏性(如数据库表重命名)。

考虑外观优先方法#

外观方法不一定是最终步骤。它可以(可能也应该)被视为第一步,后续迭代再完成完全重命名。