”工欲善其事,必先利其器。“—孔子《论语.录灵公》
首页 > 编程 > 让 SOLID 变得简单:干净代码原则的 JavaScript 指南

让 SOLID 变得简单:干净代码原则的 JavaScript 指南

发布于2024-08-27
浏览:521

Making SOLID Simple: A JavaScript Guide to Clean Code Principles

当我第一次开始涉足软件开发世界时,我经常发现自己被周围飞来飞去的流行语和概念淹没。似乎特别令人畏惧的概念之一是“坚实的原则”。感觉就像只有“认真的”开发人员才需要担心的事情。但随着我对编码越来越熟悉,我意识到这些原则并不是花哨,而是编写不会让你在几个月后就想抓狂的代码。

所以,这是我对 JavaScript 中 SOLID 原则的看法——一本严肃实用的指南,我希望在开始时就拥有它。

1. 单一职责原则(SRP):一份工作,做好

它是什么?

单一职责原则规定,一个类应该只有一个改变的理由,这意味着它应该只有一项工作或职责。

现实生活中的类比

想想您最喜欢的咖啡店的咖啡师。他们的工作是煮咖啡。如果他们突然必须开始修理浓缩咖啡机、提供糕点、倒垃圾,事情就会变得混乱。就像咖啡师应该专注于煮咖啡一样,你的班级应该专注于做好一件事。

JavaScript 中的示例:

假设您有一个 User 类,用于处理用户身份验证、数据验证和数据库存储。做得太过分了!通过将这些职责拆分为单独的类,可以使代码更易于管理和维护。

class UserAuthenticator {
  login(user) {
    // handle login
  }
}

class UserDataValidator {
  validate(user) {
    // validate user data
  }
}

class UserDatabase {
  save(user) {
    // save user to the database
  }
}

2. 开闭原则(OCP):扩展,不要修改

它是什么?

开放/封闭原则规定软件实体应该对扩展开放,但对修改关闭。换句话说,您应该能够在不更改现有代码的情况下添加新功能。

现实生活中的类比:

想象一下您最喜欢的游戏机。您可以添加新游戏、控制器和配件,但无需打开它并重新接线。同样,您应该能够在不更改其核心结构的情况下向代码添加新功能。

JavaScript 中的示例:

假设您有一个 Shape 类,其中包含计算面积的方法。如果您需要添加新形状(例如三角形),则不必修改现有类。相反,扩展它。

class Shape {
  area() {
    throw "Area method not implemented";
  }
}

class Rectangle extends Shape {
  constructor(width, height) {
    super();
    this.width = width;
    this.height = height;
  }

  area() {
    return this.width * this.height;
  }
}

class Circle extends Shape {
  constructor(radius) {
    super();
    this.radius = radius;
  }

  area() {
    return Math.PI * this.radius * this.radius;
  }
}

3.里氏替换原则(LSP):保持可替换

它是什么?

里氏替换原则规定超类的对象应该可以用子类的对象替换,而不影响程序的正确性。

现实生活中的类比:

想象一下租车。无论您购买的是轿车还是 SUV,您都希望它具有汽车的基本功能:驾驶、转向和停车。如果您的租赁汽车需要一套完全不同的控制装置,那么您就有麻烦了!同样,子类的行为方式不应违反其父类设定的期望。

JavaScript 中的示例:

如果你有一个 Bird 类和一个扩展它的 Penguin 类,那么 Penguin 的行为仍然应该像 Bird,即使它不能飞。它仍然应该走路、吃饭,甚至可能游泳。

class Bird {
  move() {
    console.log("Flies in the sky");
  }
}

class Penguin extends Bird {
  move() {
    console.log("Swims in the water");
  }
}

const myBird = new Bird();
const myPenguin = new Penguin();

myBird.move(); // Flies in the sky
myPenguin.move(); // Swims in the water

4. 接口隔离原则(ISP):定制接口

它是什么?

接口隔离原则建议客户端不应被迫实现他们不使用的接口。您应该创建更小、更具体的界面,而不是拥有一个大的界面。

现实生活中的类比:

想象一家餐厅,厨师还必须兼任服务员、调酒师和洗碗机。这是压倒性的和低效的!相反,每个角色都应该有其特定的任务。同样,您的界面应该专业化和集中化。

JavaScript 中的示例:

如果您有一个包含 buildHouse、paintHouse 和 designHouse 等方法的 Worker 接口,则仅粉刷房屋的 Worker 不必实现所有其他方法。将其分解为更小的接口。

class Builder {
  build() {
    console.log("Building house...");
  }
}

class Painter {
  paint() {
    console.log("Painting house...");
  }
}

class Designer {
  design() {
    console.log("Designing house...");
  }
}

5. 依赖倒置原则(DIP):依赖抽象

它是什么?

依赖倒置原则指出高级模块不应该依赖于低级模块。两者都应该依赖于抽象。

现实生活中的类比:

想想如何将手机充电器插入墙壁插座。您不需要了解墙内电线的详细信息 - 您所需要的只是为设备供电的接口(插座)。同样,您的代码应该依赖于抽象(接口),而不是具体的实现。

JavaScript 中的示例:

如果您有一个直接控制 Switch 类的 LightBulb 类,那么您正在创建紧密耦合。相反,两者都应该依赖于像 PowerSource 这样的接口。

class LightBulb {
  turnOn(powerSource) {
    powerSource.provideElectricity();
    console.log("Light is on");
  }
}

class Switch {
  constructor(powerSource) {
    this.powerSource = powerSource;
  }

  operate() {
    this.powerSource.togglePower();
  }
}

class PowerSource {
  provideElectricity() {
    console.log("Providing electricity");
  }

  togglePower() {
    console.log("Toggling power");
  }
}

结论

掌握 SOLID 原则就像学习使用一套经过验证的食谱烹饪。一旦理解了它们,您就可以编写出不仅实用而且优雅且易于维护的代码。因此,下次当您遇到编码难题时,请记住:这是有原则的!

编码愉快! ?

版本声明 本文转载于:https://dev.to/suryanshsingh2001/making-solid-simple-a-javascript-guide-to-clean-code-principles-1n6j?1如有侵犯,请联系[email protected]删除
最新教程 更多>
  • 网页抓取 - 有趣!
    网页抓取 - 有趣!
    一个很酷的术语: CRON = 按指定时间间隔自动安排任务的编程技术 网络什么? 在研究项目等时,我们通常会从各个网站编写信息 - 无论是日记/Excel/文档等。 我们正在抓取网络并手动提取数据。 网络抓取正在自动化这一过程。 例子 当在网上搜索运动鞋时,它会显示包...
    编程 发布于2024-11-06
  • 感言网格部分
    感言网格部分
    ?在学习 CSS 网格时刚刚完成了这个推荐网格部分的构建! ?网格非常适合创建结构化布局。 ?现场演示:https://courageous-chebakia-b55f43.netlify.app/ ? GitHub:https://github.com/khanimran17/Testimonia...
    编程 发布于2024-11-06
  • 为什么 REGISTER_GLOBALS 被认为是 PHP 中的主要安全风险?
    为什么 REGISTER_GLOBALS 被认为是 PHP 中的主要安全风险?
    REGISTER_GLOBALS 的危险REGISTER_GLOBALS 是一个 PHP 设置,它允许所有 GET 和 POST 变量在 PHP 脚本中用作全局变量。此功能可能看起来很方便,但由于潜在的安全漏洞和编码实践,强烈建议不要使用它。为什么 REGISTER_GLOBALS 不好?REGIS...
    编程 发布于2024-11-06
  • Nodemailer 概述:在 Node.js 中轻松发送电子邮件
    Nodemailer 概述:在 Node.js 中轻松发送电子邮件
    Nodemailer 是一个用于发送电子邮件的 Node.js 模块。以下是快速概述: Transporter:定义电子邮件的发送方式(通过 Gmail、自定义 SMTP 等)。 const transporter = nodemailer.createTransport({ ... }); ...
    编程 发布于2024-11-06
  • JavaScript 中的轻松错误处理:安全赋值运算符如何简化您的代码
    JavaScript 中的轻松错误处理:安全赋值运算符如何简化您的代码
    JavaScript 中的错误处理可能很混乱。将大块代码包装在 try/catch 语句中是可行的,但随着项目的增长,调试就变成了一场噩梦。幸运的是,有更好的方法。输入 安全赋值运算符 (?=) - 一种更干净、更有效的错误处理方法,使代码保持可读性并简化调试。 什么是安全赋值运算符...
    编程 发布于2024-11-06
  • Javascript 很难(有悲伤)
    Javascript 很难(有悲伤)
    这将是一个很长的阅读,但让我再说一遍。 JAVASCRIPT很难。上次我们见面时,我正在踏入 Javascript 的世界,一个眼睛明亮、充满希望的程序员踏入野生丛林,说“这能有多难?”。我错得有多离谱??事情变得更难了,我(勉强)活了下来,这是关于我的旅程的一个小混乱的故事。 变量:疯狂的开始 ...
    编程 发布于2024-11-06
  • ## 您可以在不使用 JavaScript 的情况下使用 CSS 创建饼图分段吗?
    ## 您可以在不使用 JavaScript 的情况下使用 CSS 创建饼图分段吗?
    使用 CSS 在圆中分段使用 border-radius 在 CSS 中创建圆是一种常见的做法。但是,我们可以通过分段(类似于饼图)实现类似的效果吗?本文深入研究了仅通过 HTML 和 CSS 实现此目的的方法,不包括使用 JavaScript。生成相等大小的段相等大小段的一种方法涉及生成以下内容的...
    编程 发布于2024-11-06
  • 从头开始构建一个小型矢量存储
    从头开始构建一个小型矢量存储
    With the evolving landscape of generative AI, vector databases are playing crucial role in powering generative AI applications. There are so many vect...
    编程 发布于2024-11-06
  • 如何在Chrome中使用AI实验API
    如何在Chrome中使用AI实验API
    要在 Chrome 中使用实验性 AI API,请按照以下步骤操作: 硬件要求 4GB 内存 GPU可用 至少 22GB 空间 Windows 10.11 或 macOS Ventura 或更新版本(无 Linux 规范) 尚不支持: Chrome操作系统 Chrome iOS Ch...
    编程 发布于2024-11-06
  • 评论:Adam Johnson 的《Boost Your Django DX》
    评论:Adam Johnson 的《Boost Your Django DX》
    书评很微妙。您不想破坏它,但您也想让潜在读者体验一下所期待的内容。这是提供背景和保持兴趣之间的巧妙平衡。我试图在这篇评论中达到这种平衡,为您提供足够的内容来吸引您,而不透露太多。 一个小背景故事:我第一次从 Djangonaut Space 的好朋友 Tim 那里听说这本书,并将其添加到我的阅读列表...
    编程 发布于2024-11-06
  • 如何对数组元素进行分组并组合多维数组中另一列的值?
    如何对数组元素进行分组并组合多维数组中另一列的值?
    按列对数组元素进行分组并组合另一列中的值给定一个包含两列嵌套数组的数组,任务是将基于特定列的子数组,并将每个组中另一列的值连接起来,生成一个以逗号分隔的列表。考虑以下示例数组:$array = [ ["444", "0081"], ["...
    编程 发布于2024-11-06
  • 三个新添加的例外功能
    三个新添加的例外功能
    从 JDK 7 开始,异常处理已扩展为三个新功能:自动资源管理、多重捕获和更准确的重新抛出。 多重catch允许您使用同一个catch子句捕获多个异常,避免代码重复。 要使用多重捕获,请指定由 | 分隔的异常列表。在 catch 子句中。每个参数都是隐式最终参数。 用法示例:catch(final...
    编程 发布于2024-11-06
  • 如何修复运行 ES6 代码时出现“意外的令牌导出”错误?
    如何修复运行 ES6 代码时出现“意外的令牌导出”错误?
    “排除意外的令牌导出错误”尝试在项目中执行 ES6 代码时,可能会出现“意外的令牌导出”错误。此错误表明所使用的环境不支持 ES6 模块中使用的导出关键字语法。错误详细信息以下代码片段举例说明了错误的来源: export class MyClass { constructor() { c...
    编程 发布于2024-11-06
  • 即使卸载后,VSCode 扩展也不会从文件系统中删除,我创建了一个解决方案!
    即使卸载后,VSCode 扩展也不会从文件系统中删除,我创建了一个解决方案!
    所以这是基于 vscode 的编辑器的问题。即使您卸载了扩展程序,它也会保留在文件系统中,并随着时间的推移堵塞您的系统。我创建了一个简单的解决方案。运行此 python 脚本将删除 vscode 上未安装的扩展。 它适用于 VS Code、VS Code Insiders,也适用于 VSCodiu...
    编程 发布于2024-11-06
  • 通过 GitHub Actions 按计划更新网站内容
    通过 GitHub Actions 按计划更新网站内容
    我想分享我构建一个自我可持续的内容管理系统的旅程,该系统不需要传统意义上的内容数据库。 问题 该网站的内容(博客文章和书签)存储在 Notion 数据库中: 带书签的数据库 –  Notion UI 我试图解决的问题是不必在添加每个书签后手动部署网站。最重要的是 - 保持托管尽可能便...
    编程 发布于2024-11-06

免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。

Copyright© 2022 湘ICP备2022001581号-3