理解 JavaScript 中的单一职责原则
在编写干净、可维护的代码时,要遵循的最重要的原则之一是单一职责原则(srp)。这是软件开发中的五个 solid 原则之一,可确保您的代码更易于阅读、测试和修改。
什么是单一责任原则?
罗伯特·c.马丁 (robert c.martin) 的单一责任原则指出:
一个类或函数应该有且仅有一个改变的理由。
简单来说,代码的每个单元(无论是函数、类还是模块)都应该负责做一件事并做好它。当职责分离时,代码某个区域的更改不会意外影响其他区域,从而降低出现错误的风险并使您的应用程序更易于维护和测试。
为什么建议零售价很重要?
如果没有 srp,您可能会面临以下问题:
立即学习“Java免费学习笔记(深入)”;
- 纠结的依赖关系:当一个函数或类具有多个职责时,对一个函数或类进行更改可能会无意中破坏另一个函数或类。
- 可测试性降低:当代码单元执行过多操作时,测试会变得更加困难,因为您需要模拟不相关的依赖项。 可读性差:大型、多用途的函数或类更难理解,特别是对于加入项目的新开发人员。
- 维护困难:一个单位承担的责任越多,隔离和修复错误或添加新功能所需的努力就越多。
在 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 的提示
- 保持函数简短:目标是 5-20 行长且服务于一个目的的函数。
- 使用描述性名称:一个好的函数或类名称反映了它的责任。
- 经常重构:如果某个函数感觉太大或难以测试,请将其拆分为更小的函数。
- 分组相关逻辑:使用模块或类对相关职责进行分组,但避免混合不相关的职责。
结论
单一职责原则是干净代码的基石。通过确保每个函数、类或模块只有一个需要更改的原因,您可以使 javascript 代码更加模块化、更易于测试且更易于维护。
从小事做起——在当前项目中选择一个混乱的函数或类,然后使用 srp 重构它。随着时间的推移,这些微小的变化将给您的代码库带来显着的改进。