当前位置:首页 > 文章列表 > 文章 > 前端 > Javascript 中的单一职责原则

Javascript 中的单一职责原则

来源:dev.to 2024-12-22 15:55:12 0浏览 收藏

本篇文章向大家介绍《Javascript 中的单一职责原则》,主要包括,具有一定的参考价值,需要的朋友可以参考一下。

Javascript 中的单一职责原则

理解 javascript 中的单一职责原则
在编写干净、可维护的代码时,要遵循的最重要的原则之一是单一职责原则(srp)。这是软件开发中的五个 solid 原则之一,可确保您的代码更易于阅读、测试和修改。

什么是单一责任原则?

罗伯特·c.马丁 (robert c.martin) 的单一责任原则指出:

一个类或函数应该有且仅有一个改变的理由。

简单来说,代码的每个单元(无论是函数、类还是模块)都应该负责做一件事并做好它。当职责分离时,代码某个区域的更改不会意外影响其他区域,从而降低出现错误的风险并使您的应用程序更易于维护和测试。

为什么建议零售价很重要?

如果没有 srp,您可能会面临以下问题:

  1. 纠结的依赖关系:当一个函数或类具有多个职责时,对一个函数或类进行更改可能会无意中破坏另一个函数或类。
  2. 可测试性降低:当代码单元执行过多操作时,测试会变得更加困难,因为您需要模拟不相关的依赖项。 可读性差:大型、多用途的函数或类更难理解,特别是对于加入项目的新开发人员。
  3. 维护困难:一个单位承担的责任越多,隔离和修复错误或添加新功能所需的努力就越多。

在 javascript 中应用 srp

让我们看一些在 javascript 中应用 srp 的实际示例。

示例 1:重构函数

没有建议零售价

function handleuserlogin(userdata) {
    // validate user data
    if (!userdata.email || !userdata.password) {
        logger.error("invalid user data");
        return "invalid input";
    }

    // authenticate user
    const user = authenticate(userdata.email, userdata.password);
    if (!user) {
        console.error("authentication failed");
        return "authentication failed";
    }

    // log success
    console.info("user logged in successfully");
    return user;
}

这个函数做了太多的事情:验证、认证和日志记录。每一项都是不同的责任。

含建议零售价

我们可以通过将其分解为更小的、单一用途的函数来重构它:

function validateuserdata(userdata) {
    if (!userdata.email || !userdata.password) {
        throw new error("invalid user data");
    }
}

function authenticateuser(email, password) {
    const user = authenticate(email, password); // assume authenticate is defined elsewhere
    if (!user) {
        throw new error("authentication failed");
    }
    return user;
}

function handleuserlogin(userdata, logger) {
    try {
        validateuserdata(userdata);
        const user = authenticateuser(userdata.email, userdata.password);
        logger.info("user logged in successfully");
        return user;
    } catch (error) {
        logger.error(error.message);
        return error.message;
    }
}

现在,每个函数都有一个职责,使得测试和修改变得更容易。

示例 2:重构类

没有建议零售价

一个管理多个关注点的类:

class usermanager {
    constructor(db, logger) {
        this.db = db;
        this.logger = logger;
    }

    createuser(user) {
        // save user to db
        this.db.save(user);
        this.logger.info("user created");
    }

    sendnotification(user) {
        // send email
        emailservice.send(`welcome, ${user.name}!`);
        this.logger.info("welcome email sent");
    } 
}

这里,usermanager 处理用户创建、日志记录和发送电子邮件——职责太多。

含建议零售价

通过将职责委托给其他类或模块进行重构:

class UserService {
    constructor(db) {
        this.db = db;
    }

    createUser(user) {
        this.db.save(user);
    }
}

class NotificationService {
    sendWelcomeEmail(user) {
        emailService.send(`Welcome, ${user.name}!`);
    }
}

class UserManager {
    constructor(userService, notificationService, logger) {
        this.userService = userService;
        this.notificationService = notificationService;
        this.logger = logger;
    }

    createUser(user) {
        this.userService.createUser(user);
        this.notificationService.sendWelcomeEmail(user);
        this.logger.info("User created and welcome email sent");
    }
}

现在每个类都专注于一个问题:持久性、通知或日志记录。

遵循 srp 的提示

  1. 保持函数简短:目标是 5-20 行长且服务于一个目的的函数。
  2. 使用描述性名称:一个好的函数或类名称反映了它的责任。
  3. 经常重构:如果某个函数感觉太大或难以测试,请将其拆分为更小的函数。
  4. 分组相关逻辑:使用模块或类对相关职责进行分组,但避免混合不相关的职责。

结论

单一职责原则是干净代码的基石。通过确保每个函数、类或模块只有一个需要更改的原因,您可以使 javascript 代码更加模块化、更易于测试且更易于维护。

从小事做起——在当前项目中选择一个混乱的函数或类,然后使用 srp 重构它。随着时间的推移,这些微小的变化将给您的代码库带来显着的改进。

今天关于《Javascript 中的单一职责原则》的内容就介绍到这里了,是不是学起来一目了然!想要了解更多关于的内容请关注golang学习网公众号!

版本声明
本文转载于:dev.to 如有侵犯,请联系study_golang@163.com删除
中山大学刘飞教授、邓少芝教授在基于非对称电极型Au/CsPbBr3/SmB6结构的高品质自驱动可见光探测器研究取得新突破
下一篇
中山大学刘飞教授、邓少芝教授在基于非对称电极型Au/CsPbBr3/SmB6结构的高品质自驱动可见光探测器研究取得新突破
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之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检测,湖南茅茅虫科技有限公司倾力打造,运用NLP技术精准识别AI生成文本,提供论文、专著等学术文本的AIGC检测服务。支持多种格式,生成可视化报告,保障您的学术诚信和内容质量。
    56次使用
  • 赛林匹克平台:科技赛事聚合,赋能AI、算力、量子计算创新
    赛林匹克平台(Challympics)
    探索赛林匹克平台Challympics,一个聚焦人工智能、算力算法、量子计算等前沿技术的赛事聚合平台。连接产学研用,助力科技创新与产业升级。
    73次使用
  • SEO  笔格AIPPT:AI智能PPT制作,免费生成,高效演示
    笔格AIPPT
    SEO 笔格AIPPT是135编辑器推出的AI智能PPT制作平台,依托DeepSeek大模型,实现智能大纲生成、一键PPT生成、AI文字优化、图像生成等功能。免费试用,提升PPT制作效率,适用于商务演示、教育培训等多种场景。
    84次使用
  • 稿定PPT:在线AI演示设计,高效PPT制作工具
    稿定PPT
    告别PPT制作难题!稿定PPT提供海量模板、AI智能生成、在线协作,助您轻松制作专业演示文稿。职场办公、教育学习、企业服务全覆盖,降本增效,释放创意!
    76次使用
  • Suno苏诺中文版:AI音乐创作平台,人人都是音乐家
    Suno苏诺中文版
    探索Suno苏诺中文版,一款颠覆传统音乐创作的AI平台。无需专业技能,轻松创作个性化音乐。智能词曲生成、风格迁移、海量音效,释放您的音乐灵感!
    80次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码