深入理解JavaScript系列(6):S.O.L.I.D五大原则之单一职责SRP

作者:拾光

时间:2026-10-27

浏览:287

本文深入解析JavaScript中S.O.L.I.D五大原则之一的单一职责原则(SRP)。通过对比未重构的购物车示例与引入事件聚合器、Controller和Repository后的重构代码,展示如何识别并分离多重职责。文章探讨了在小型与大型项目中应用SRP的权衡,旨在帮助开发者提升代码的可维护性与低耦合性。

文章目录

前言

引言


Robert C. Martin 提出并推广了 S.O.L.I.D 五大原则,旨在优化面向对象编程实践,这五大原则包括:



单一职责原则(Single Responsibility Principle, SRP)


开闭原则(Open/Closed Principle, OCP)


里氏替换原则(Liskov Substitution Principle, LSP)


接口隔离原则(Interface Segregation Principle, ISP)


依赖倒置原则(Dependency Inversion Principle, DIP)


关于这五大原则,博客园上已有大量讨论,尤其是针对 C# 语言的实现。然而,对于以原型为基础的动态类型语言 JavaScript 而言,相关讨论仍相对稀缺。本系列文章将分五篇,以 JavaScript 语言为基础,展示这五大原则的具体应用。好了,让我们开始第一篇:单一职责原则。



英文原文地址:http://freshbrewedcode.com/derekgreer/2011/12/08/solid-javascript-single-responsibility-principle/



单一职责原则概述

单一职责原则


单一职责原则的定义如下:



一个类应该只有一个引起它变化的原因


类发生更改的原因应该只有一个


复制代码


一个类(在 JavaScript 中对应为一个对象)拥有一组紧密相关的行为意味着什么?遵循单一职责原则的好处在于,它能让我们更容易地维护该对象。当一个对象封装了过多职责时,修改其中一个职责往往会影响到其他职责相关的代码。通过解耦,可以让每个职责更加灵活地独立变化。



那么,我们如何判断一个对象的多个行为是构成了单一职责还是多个职责?我们可以参考《Object Design: Roles, Responsibilities, and Collaborations》一书中提出的角色原型(Role Stereotypes)概念。该书提出了以下角色原型来区分职责:



信息持有者(Information holder)——该对象设计用于存储数据并向其他对象提供信息。


结构者(Structurer)——该对象设计用于维护对象与信息之间的关系。


服务提供者(Service provider)——该对象设计用于处理工作任务并向其他对象提供服务。


控制器(Controller)——该对象设计用于控制一系列负责任务的决策与处理。


协调者(Coordinator)——该对象不进行任何决策处理,只是将工作委托给其他对象。


接口者(Interfacer)——该对象设计用于在系统的各个部分之间转换信息(或请求)。


一旦了解了这些概念,判断代码是遵循单一职责还是多职责就变得容易多了。



实例代码与问题分析

实例代码


以下实例代码演示了将商品添加到购物车的过程。这段代码非常糟糕,具体如下:


代码如下:

 
function Product(id, description) {
this.getId = function () {
return id;
}; 
this.getDescription = function () {
return description;
}; 
} 
function Cart(eventAggregator) {
var items = [];
this.addItem = function (item) {
items.push(item);
}; 
} 
(function () {
var products = [new Product(1, "Star Wars Lego Ship"),
new Product(2, "Barbie Doll"),
new Product(3, "Remote Control Airplane")],
cart = new Cart();
function addToCart() {
var productId = $(this).attr('id');
var product = $.grep(products, function (x) {
return x.getId() == productId;
})[0];
cart.addItem(product);
var newItem = $('<li></li>').html(product.getDescription()).attr('id-cart', product.getId()).appendTo("#cart");
} 
products.forEach(function (product) {
var newItem = $('<li></li>').html(product.getDescription())
.attr('id', product.getId())
.dblclick(addToCart)
.appendTo("#products");
}); 
})(); 

该代码声明了两个函数分别描述 product 和 cart,而匿名函数的职责是更新屏幕和用户交互。这还不是一个非常复杂的例子,但匿名函数内部却包含了许多不相关的职责。让我们来看看具体有多少种职责:



首先,声明了 product 的集合。


其次,有一段将 product 集合绑定到 #product 元素的代码,并且附加了一个添加到购物车的事件处理程序。


第三,具备 Cart 购物车的展示功能。


第四,具备将 product item 添加到购物车并显示的功能。


基于事件聚合器的重构方案

重构代码


让我们来分解一下,以便代码各自存放到各自的对象中。为此,我们参考了 Martin Fowler 的事件聚合(Event Aggregator)理论来处理代码,以便各对象之间进行通信。



首先,我们先来实现事件聚合的功能。该功能分为两部分:一部分是 Event,用于 Handler 回调的代码;另一部分是 EventAggregator,用来订阅和发布 Event。代码如下:


代码如下:

 
function Event(name) {
var handlers = [];
this.getName = function () {
return name;
}; 
this.addHandler = function (handler) {
handlers.push(handler);
}; 
this.removeHandler = function (handler) {
for (var i = 0; i < handlers.length; i++) {
if (handlers[i] == handler) {
handlers.splice(i, 1);
break;
} 
} 
}; 
this.fire = function (eventArgs) {
handlers.forEach(function (h) {
h(eventArgs);
}); 
}; 
} 
function EventAggregator() {
var events = [];
function getEvent(eventName) {
return $.grep(events, function (event) {
return event.getName() === eventName;
})[0];
} 
this.publish = function (eventName, eventArgs) {
var event = getEvent(eventName);
if (!event) {
event = new Event(eventName);
events.push(event);
} 
event.fire(eventArgs);
}; 
this.subscribe = function (eventName, handler) {
var event = getEvent(eventName);
if (!event) {
event = new Event(eventName);
events.push(event);
} 
event.addHandler(handler);
}; 
} 

接下来,我们声明 Product 对象,代码如下:


代码如下:

 
function Product(id, description) {
this.getId = function () {
return id;
}; 
this.getDescription = function () {
return description;
}; 
} 

接着来声明 Cart 对象。在该对象的 addItem 函数中,我们要触发并发布一个 itemAdded 事件,同时将 item 作为参数传入。


代码如下:

 
function Cart(eventAggregator) {
var items = [];
this.addItem = function (item) {
items.push(item);
eventAggregator.publish("itemAdded", item);
}; 
} 

CartController 主要接受 cart 对象和事件聚合器,通过订阅 itemAdded 来增加一个 li 元素节点,并通过订阅 productSelected 事件来添加 product。


代码如下:

 
function CartController(cart, eventAggregator) {
eventAggregator.subscribe("itemAdded", function (eventArgs) {
var newItem = $('<li></li>').html(eventArgs.getDescription()).attr('id-cart', eventArgs.getId()).appendTo("#cart");
}); 
eventAggregator.subscribe("productSelected", function (eventArgs) {
cart.addItem(eventArgs.product);
}); 
} 

Repository 的目的是为了获取数据(可以从 ajax 里获取),然后暴露 get 数据的方法。


代码如下:

 
function ProductRepository() {
var products = [new Product(1, "Star Wars Lego Ship"),
new Product(2, "Barbie Doll"),
new Product(3, "Remote Control Airplane")];
this.getProducts = function () {
return products;
} 
} 

ProductController 里定义了一个 onProductSelect 方法,主要用于发布触发 productSelected 事件。forEach 主要用于将数据绑定到产品列表上。代码如下:


代码如下:

 
function ProductController(eventAggregator, productRepository) {
var products = productRepository.getProducts();
function onProductSelected() {
var productId = $(this).attr('id');
var product = $.grep(products, function (x) {
return x.getId() == productId;
})[0];
eventAggregator.publish("productSelected", {
product: product
}); 
} 
products.forEach(function (product) {
var newItem = $('<li></li>').html(product.getDescription())
.attr('id', product.getId())
.dblclick(onProductSelected)
.appendTo("#products");
}); 
} 

最后声明匿名函数:


代码如下:

 
(function () {
var eventAggregator = new EventAggregator(),
cart = new Cart(eventAggregator),
cartController = new CartController(cart, eventAggregator),
productRepository = new ProductRepository(),
productController = new ProductController(eventAggregator, productRepository);
})(); 

可以看到匿名函数的代码减少了很多,主要是一些对象的实例化代码。在代码中,我们介绍了 Controller 的概念,它接受信息然后传递到 action;也介绍了 Repository 的概念,主要用于处理 product 的展示。重构的结果就是编写了一大堆对象声明,但好处是每个对象有了自己明确的职责:该展示数据的展示数据,该处理集合的处理集合,这样耦合度就非常低了。



最终代码展示

最终代码


代码如下:

 
function Event(name) {
var handlers = [];
this.getName = function () {
return name;
}; 
this.addHandler = function (handler) {
handlers.push(handler);
}; 
this.removeHandler = function (handler) {
for (var i = 0; i < handlers.length; i++) {
if (handlers[i] == handler) {
handlers.splice(i, 1);
break;
} 
} 
}; 
this.fire = function (eventArgs) {
handlers.forEach(function (h) {
h(eventArgs);
}); 
}; 
} 
function EventAggregator() {
var events = [];
function getEvent(eventName) {
return $.grep(events, function (event) {
return event.getName() === eventName;
})[0];
} 
this.publish = function (eventName, eventArgs) {
var event = getEvent(eventName);
if (!event) {
event = new Event(eventName);
events.push(event);
} 
event.fire(eventArgs);
}; 
this.subscribe = function (eventName, handler) {
var event = getEvent(eventName);
if (!event) {
event = new Event(eventName);
events.push(event);
} 
event.addHandler(handler);
}; 
} 
function Product(id, description) {
this.getId = function () {
return id;
}; 
this.getDescription = function () {
return description;
}; 
} 
function Cart(eventAggregator) {
var items = [];
this.addItem = function (item) {
items.push(item);
eventAggregator.publish("itemAdded", item);
}; 
} 
function CartController(cart, eventAggregator) {
eventAggregator.subscribe("itemAdded", function (eventArgs) {
var newItem = $('<li></li>').html(eventArgs.getDescription()).attr('id-cart', eventArgs.getId()).appendTo("#cart");
}); 
eventAggregator.subscribe("productSelected", function (eventArgs) {
cart.addItem(eventArgs.product);
}); 
} 
function ProductRepository() {
var products = [new Product(1, "Star Wars Lego Ship"),
new Product(2, "Barbie Doll"),
new Product(3, "Remote Control Airplane")];
this.getProducts = function () {
return products;
} 
} 
function ProductController(eventAggregator, productRepository) {
var products = productRepository.getProducts();
function onProductSelected() {
var productId = $(this).attr('id');
var product = $.grep(products, function (x) {
return x.getId() == productId;
})[0];
eventAggregator.publish("productSelected", {
product: product
}); 
} 
products.forEach(function (product) {
var newItem = $('<li></li>').html(product.getDescription())
.attr('id', product.getId())
.dblclick(onProductSelected)
.appendTo("#products");
}); 
} 
(function () {
var eventAggregator = new EventAggregator(),
cart = new Cart(eventAggregator),
cartController = new CartController(cart, eventAggregator),
productRepository = new ProductRepository(),
productController = new ProductController(eventAggregator, productRepository);
})(); 

总结与适用场景

总结


看到这样的重构结果,可能有博友会问:真的有必要做得这么复杂吗?我只能说:是否要这么做取决于你项目的具体情况。



如果你的项目是一个非常小的项目,代码量也不大,那么其实没有必要重构得如此复杂。但如果你的项目是一个复杂的大型项目,或者你的小项目将来可能会迅速增长,那么就在前期考虑 SRP 原则进行职责分离,这样才有利于后续的维护。

实用工具推荐

电子包浆

绿化、压缩、噪点和虚拟水印,自由调节做旧程度。

使用 ›
图片压缩

选择画质和输出格式,预览压缩前后的大小。

使用 ›
相关文章