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

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

来源:dev.to 2024-10-23 17:09:55 0浏览 收藏

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

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

在软件工程的世界里,有一个原则高于其他原则:函数应该做一件事,并且做好它。这个概念通常称为单一职责原则 (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基础的同学学习。
    542次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    508次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    497次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    484次学习
查看更多
AI推荐
  • 毕业宝AIGC检测:AI生成内容检测工具,助力学术诚信
    毕业宝AIGC检测
    毕业宝AIGC检测是“毕业宝”平台的AI生成内容检测工具,专为学术场景设计,帮助用户初步判断文本的原创性和AI参与度。通过与知网、维普数据库联动,提供全面检测结果,适用于学生、研究者、教育工作者及内容创作者。
    18次使用
  • AI Make Song:零门槛AI音乐创作平台,助你轻松制作个性化音乐
    AI Make Song
    AI Make Song是一款革命性的AI音乐生成平台,提供文本和歌词转音乐的双模式输入,支持多语言及商业友好版权体系。无论你是音乐爱好者、内容创作者还是广告从业者,都能在这里实现“用文字创造音乐”的梦想。平台已生成超百万首原创音乐,覆盖全球20个国家,用户满意度高达95%。
    29次使用
  • SongGenerator.io:零门槛AI音乐生成器,快速创作高质量音乐
    SongGenerator
    探索SongGenerator.io,零门槛、全免费的AI音乐生成器。无需注册,通过简单文本输入即可生成多风格音乐,适用于内容创作者、音乐爱好者和教育工作者。日均生成量超10万次,全球50国家用户信赖。
    26次使用
  •  BeArt AI换脸:免费在线工具,轻松实现照片、视频、GIF换脸
    BeArt AI换脸
    探索BeArt AI换脸工具,免费在线使用,无需下载软件,即可对照片、视频和GIF进行高质量换脸。体验快速、流畅、无水印的换脸效果,适用于娱乐创作、影视制作、广告营销等多种场景。
    28次使用
  • SEO标题协启动:AI驱动的智能对话与内容生成平台 - 提升创作效率
    协启动
    SEO摘要协启动(XieQiDong Chatbot)是由深圳协启动传媒有限公司运营的AI智能服务平台,提供多模型支持的对话服务、文档处理和图像生成工具,旨在提升用户内容创作与信息处理效率。平台支持订阅制付费,适合个人及企业用户,满足日常聊天、文案生成、学习辅助等需求。
    30次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码