0

0

干净代码的黄金法则:函数应该做一件事

花韻仙語

花韻仙語

发布时间:2024-10-08 08:06:55

|

604人浏览过

|

来源于dev.to

转载

干净代码的黄金法则:函数应该做一件事

在软件工程的世界里,有一个原则高于其他原则:函数应该做一件事,并且做好它。这个概念通常称为单一职责原则 (srp),是干净、可维护代码的基石。

为什么这很重要?

当函数具有单一职责时:

  1. 它们更容易理解和推理
  2. 测试变得更简单、更有针对性
  3. 重构风险更小,更直接
  4. 代码可重用性显着提高
  5. 调试不再那么令人头疼

让我们看一个例子来说明这一原理的实际应用。

不良实践:多重职责功能

考虑这个向客户发送电子邮件的功能:


function emailclients(clients) {
  clients.foreach(client => {
    const clientrecord = database.lookup(client);
    if (clientrecord.isactive()) {
      email(client);
    }
  });
}


这个函数正在做几件事:

  1. 迭代客户端
  2. 查询每个客户的记录
  3. 检查客户端是否处于活动状态
  4. 向活跃客户发送电子邮件

虽然将所有这些都放在一个地方似乎很有效,但它使该功能更难以维护和测试。

故事AI绘图神器
故事AI绘图神器

文本生成图文视频的AI工具,无需配音,无需剪辑,快速成片,角色固定。

下载

良好实践:单一职责职能

现在,让我们将其重构为更小、更集中的函数:


function emailActiveClients(clients) {
  clients.filter(isActiveClient).forEach(email);
}

function isActiveClient(client) {
  const clientRecord = database.lookup(client);
  return clientRecord.isActive();
}


在此重构版本中:

  • emailactiveclients 专注于向活跃客户发送电子邮件的高级任务
  • isactiveclient 处理确定客户端是否处于活动状态的细节

这种关注点分离使得每个函数更容易理解、测试,并且可能在代码库的其他部分中重用。

这种方法的好处

  1. 可读性:代码讲述了一个清晰的故事。任何阅读 emailactiveclients 的人都可以快速理解其目的,而无需陷入实现细节的困境。
  2. 可测试性:您现在可以轻松地为电子邮件发送逻辑和客户端活动检查编写单独的测试。
  3. 灵活性:如果需要更改活跃客户端的确定方式,只需修改 isactiveclient 函数即可。
  4. 可重用性:如果需要,isactiveclient 函数现在可以在代码库的其他地方使用。

结论

接受“函数应该做一件事”的原则一开始可能会感觉很冗长,但从长远来看,它对代码库的可维护性和团队的生产力的好处是巨大的。当你编写和重构代码时,总是问自己:“这个函数是否不止做一件事?”如果答案是肯定的,那么是时候分解它了!

请记住,干净的代码不仅仅是让事情正常运转,而是让事情优雅且可持续地运转。快乐编码!

相关专题

更多
云朵浏览器入口合集
云朵浏览器入口合集

本专题整合了云朵浏览器入口合集,阅读专题下面的文章了解更多详细地址。

0

2026.01.20

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

20

2026.01.20

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

62

2026.01.19

java用途介绍
java用途介绍

本专题整合了java用途功能相关介绍,阅读专题下面的文章了解更多详细内容。

87

2026.01.19

java输出数组相关教程
java输出数组相关教程

本专题整合了java输出数组相关教程,阅读专题下面的文章了解更多详细内容。

39

2026.01.19

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

10

2026.01.19

xml格式相关教程
xml格式相关教程

本专题整合了xml格式相关教程汇总,阅读专题下面的文章了解更多详细内容。

13

2026.01.19

PHP WebSocket 实时通信开发
PHP WebSocket 实时通信开发

本专题系统讲解 PHP 在实时通信与长连接场景中的应用实践,涵盖 WebSocket 协议原理、服务端连接管理、消息推送机制、心跳检测、断线重连以及与前端的实时交互实现。通过聊天系统、实时通知等案例,帮助开发者掌握 使用 PHP 构建实时通信与推送服务的完整开发流程,适用于即时消息与高互动性应用场景。

19

2026.01.19

微信聊天记录删除恢复导出教程汇总
微信聊天记录删除恢复导出教程汇总

本专题整合了微信聊天记录相关教程大全,阅读专题下面的文章了解更多详细内容。

160

2026.01.18

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 2.8万人学习

Django 教程
Django 教程

共28课时 | 3.3万人学习

Kotlin 教程
Kotlin 教程

共23课时 | 2.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号