DEV Community
·
干净代码的黄金法则：函数应专注于一件事
内容提要
单一职责原则强调函数应专注于一件事，以提高代码的可读性、可测试性和可重用性。通过将复杂函数拆分为小型函数，可以简化测试和维护。例如，将发送邮件的功能分为筛选活跃客户和发送邮件两个部分。
关键要点
-
单一职责原则强调函数应专注于一件事，以提高代码的可读性、可测试性和可重用性。
-
当函数只有一个职责时，理解和推理变得更容易，测试也更简单和集中。
-
重构风险降低，代码重用性显著提高，调试变得更轻松。
-
不良实践示例：一个函数同时处理多个职责，导致维护和测试困难。
-
良好实践示例：将复杂函数拆分为小型专注函数，提升可读性和可测试性。
-
拆分后的函数使得每个函数的目的清晰，便于理解和重用。
-
采用单一职责原则虽然初看冗长，但长期来看对代码的可维护性和团队的生产力有巨大好处。
-
在编写和重构代码时，始终问自己：这个函数是否做了多于一件事？
延伸解读
单一职责原则的重要性
单一职责原则（SRP）是编写可维护代码的基石。通过确保每个函数只专注于一项任务，开发者可以显著提高代码的可读性和可测试性。这种做法不仅降低了重构的风险，还提升了代码的重用性，减少了调试的复杂性。
良好与不良实践的对比
在示例中，不良实践的函数同时处理多个职责，导致维护困难。而通过将其重构为多个小型函数，开发者可以清晰地理解每个函数的目的。这种分离关注点的方式使得代码更易于测试和重用，提升了整体开发效率。
长期收益与短期投入
虽然采用单一职责原则在初期可能显得冗长，但从长远来看，它对代码的可维护性和团队的生产力有着巨大的积极影响。开发者在编写和重构代码时，应始终反思函数的职责，确保其专注于单一任务，以便在未来减少维护成本。
延伸问答
什么是单一职责原则？
单一职责原则强调函数应专注于一件事，以提高代码的可读性、可测试性和可重用性。
为什么函数应该只做一件事？
函数只有一个职责时，理解和推理变得更容易，测试也更简单和集中。
如何将复杂函数拆分为小型函数？
可以通过将复杂函数的不同职责分开，例如将发送邮件的功能拆分为筛选活跃客户和发送邮件两个部分。
不良实践的例子是什么？
一个函数同时处理多个职责，例如在一个函数中迭代客户、查找记录、检查活跃状态和发送邮件，导致维护和测试困难。
采用单一职责原则的长期好处是什么？
虽然初看冗长，但长期来看对代码的可维护性和团队的生产力有巨大好处。
在编写代码时应该问自己什么问题？
应该问自己：这个函数是否做了多于一件事？
