当前位置:首页 > 文章列表 > 文章 > 前端 > 干净代码的黄金法则:函数应该做一件事

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

来源:dev.to 2024-10-23 17:09:55 0浏览 收藏
推广推荐
免费电影APP ➜
支持 PC / 移动端,安全直达

各位小伙伴们,大家好呀!看看今天我又给各位带来了什么文章?本文标题《干净代码的黄金法则:函数应该做一件事》,很明显是关于文章的文章哈哈哈,其中内容主要会涉及到等等,如果能帮到你,觉得很不错的话,欢迎各位多多点评和分享!

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

在软件工程的世界里,有一个原则高于其他原则:函数应该做一件事,并且做好它。这个概念通常称为单一职责原则 (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. 向活跃客户发送电子邮件

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

良好实践:单一职责职能

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


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

结论

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

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

以上就是《干净代码的黄金法则:函数应该做一件事》的详细内容,更多关于的资料请关注golang学习网公众号!

版本声明
本文转载于:dev.to 如有侵犯,请联系study_golang@163.com删除
如何连接平板电脑外接摄像头?如何连接平板电脑外接摄像头?
上一篇
如何连接平板电脑外接摄像头?
乐1pro gpu
下一篇
乐1pro gpu
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    3211次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    3425次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    3454次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    4563次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    3832次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码