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. 向活跃客户发送电子邮件

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

BgSub
BgSub

免费的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 函数现在可以在代码库的其他地方使用。

结论

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

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

相关专题

更多
excel制作动态图表教程
excel制作动态图表教程

本专题整合了excel制作动态图表相关教程,阅读专题下面的文章了解更多详细教程。

20

2025.12.29

freeok看剧入口合集
freeok看剧入口合集

本专题整合了freeok看剧入口网址,阅读下面的文章了解更多网址。

65

2025.12.29

俄罗斯搜索引擎Yandex最新官方入口网址
俄罗斯搜索引擎Yandex最新官方入口网址

Yandex官方入口网址是https://yandex.com;用户可通过网页端直连或移动端浏览器直接访问,无需登录即可使用搜索、图片、新闻、地图等全部基础功能,并支持多语种检索与静态资源精准筛选。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

197

2025.12.29

python中def的用法大全
python中def的用法大全

def关键字用于在Python中定义函数。其基本语法包括函数名、参数列表、文档字符串和返回值。使用def可以定义无参数、单参数、多参数、默认参数和可变参数的函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

16

2025.12.29

python改成中文版教程大全
python改成中文版教程大全

Python界面可通过以下方法改为中文版:修改系统语言环境:更改系统语言为“中文(简体)”。使用 IDE 修改:在 PyCharm 等 IDE 中更改语言设置为“中文”。使用 IDLE 修改:在 IDLE 中修改语言为“Chinese”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

16

2025.12.29

C++的Top K问题怎么解决
C++的Top K问题怎么解决

TopK问题可通过优先队列、partial_sort和nth_element解决:优先队列维护大小为K的堆,适合流式数据;partial_sort对前K个元素排序,适用于需有序结果且K较小的场景;nth_element基于快速选择,平均时间复杂度O(n),效率最高但不保证前K内部有序。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

12

2025.12.29

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

134

2025.12.29

抖音网页版入口在哪(最新版)
抖音网页版入口在哪(最新版)

抖音网页版可通过官网https://www.douyin.com进入,打开浏览器输入网址后,可选择扫码或账号登录,登录后同步移动端数据,未登录仅可浏览部分推荐内容。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

63

2025.12.29

快手直播回放在哪看教程
快手直播回放在哪看教程

快手直播回放需主播开启功能才可观看,主要通过三种路径查看:一是从“我”主页进入“关注”标签再进主播主页的“直播”分类;二是通过“历史记录”中的“直播”标签页找回;三是进入“个人信息查阅与下载”里的“直播回放”选项。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

18

2025.12.29

热门下载

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

精品课程

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

共21课时 | 2.3万人学习

Django 教程
Django 教程

共28课时 | 2.6万人学习

Kotlin 教程
Kotlin 教程

共23课时 | 2.1万人学习

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

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