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


Posted in Javascript onJanuary 15, 2012

前言
Bob大叔提出并发扬了S.O.L.I.D五大原则,用来更好地进行面向对象编程,五大原则分别是:

The Single Responsibility Principle(单一职责SRP)
The Open/Closed Principle(开闭原则OCP)
The Liskov Substitution Principle(里氏替换原则LSP)
The Interface Segregation Principle(接口分离原则ISP)
The Dependency Inversion Principle(依赖反转原则DIP)
五大原则,我相信在博客园已经被讨论烂了,尤其是C#的实现,但是相对于JavaScript这种以原型为base的动态类型语言来说还为数不多,该系列将分5篇文章以JavaScript编程语言为基础来展示五大原则的应用。 OK,开始我们的第一篇:单一职责。

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

单一职责
单一职责的描述如下:

A class should have only one reason to change
类发生更改的原因应该只有一个
复制代码
一个类(JavaScript下应该是一个对象)应该有一组紧密相关的行为的意思是什么?遵守单一职责的好处是可以让我们很容易地来维护这个对象,当一个对象封装了很多职责的话,一旦一个职责需要修改,势必会影响该对象想的其它职责代码。通过解耦可以让每个职责工更加有弹性地变化。

不过,我们如何知道一个对象的多个行为构造多个职责还是单个职责?我们可以通过参考Object Design: Roles, Responsibilies, and Collaborations一书提出的Role Stereotypes概念来决定,该书提出了如下Role Stereotypes来区分职责:

Information holder ? 该对象设计为存储对象并提供对象信息给其它对象。
Structurer ? 该对象设计为维护对象和信息之间的关系
Service provider ? 该对象设计为处理工作并提供服务给其它对象
Controller ? 该对象设计为控制决策一系列负责的任务处理
Coordinator ? 该对象不做任何决策处理工作,只是delegate工作到其它对象上
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"); 
}); 
})();

该代码声明了2个function分别用来描述product和cart,而匿名函数的职责是更新屏幕和用户交互,这还不是一个很复杂的例子,但匿名函数里却包含了很多不相关的职责,让我们来看看到底有多少职责:

首先,有product的集合的声明
其次,有一个将product集合绑定到#product元素的代码,而且还附件了一个添加到购物车的事件处理
第三,有Cart购物车的展示功能
第四,有添加product item到购物车并显示的功能
重构代码
让我们来分解一下,以便代码各自存放到各自的对象里,为此,我们参考了martinfowler的事件聚合(Event Aggregator)理论在处理代码以便各对象之间进行通信。

首先我们先来实现事件聚合的功能,该功能分为2部分,1个是Event,用于Handler回调的代码,1个是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的function里我们要触发发布一个事件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原则进行职责分离了,这样才有利于以后的维护。

Javascript 相关文章推荐
jQuery侧边栏随窗口滚动实现方法
Mar 04 Javascript
深入理解JavaScript系列(35):设计模式之迭代器模式详解
Mar 03 Javascript
浅谈jQuery中的eq()与DOM中element.[]的区别
Oct 28 Javascript
AngularJS+Bootstrap实现多文件上传与管理
Nov 08 Javascript
基于js实现二级下拉联动
Dec 17 Javascript
原生的强大DOM选择器querySelector介绍
Dec 21 Javascript
前端面试知识点锦集(JavaScript篇)
Dec 28 Javascript
微信小程序开发(二)图片上传+服务端接收详解
Jan 11 Javascript
JS给按钮添加跳转功能类似a标签
May 30 Javascript
原生JavaScript来实现对dom元素class的操作方法(推荐)
Aug 16 Javascript
socket io与vue-cli的结合使用的示例代码
Nov 01 Javascript
推荐一个基于Node.js的表单验证库
Feb 15 Javascript
深入理解JavaScript系列(6) 强大的原型和原型链
Jan 15 #Javascript
深入理解JavaScript系列(4) 立即调用的函数表达式
Jan 15 #Javascript
深入理解JavaScript系列(3) 全面解析Module模式
Jan 15 #Javascript
深入理解JavaScript系列(2) 揭秘命名函数表达式
Jan 15 #Javascript
深入理解JavaScript系列(1) 编写高质量JavaScript代码的基本要点
Jan 15 #Javascript
Prototype源码浅析 String部分(三)之HTML字符串处理
Jan 15 #Javascript
Prototype源码浅析 String部分(一)之有关indexOf优化
Jan 15 #Javascript
You might like
通过html表格发电子邮件
2006/10/09 PHP
PHP 和 MySQL 开发的 8 个技巧
2007/01/02 PHP
php setcookie(name, value, expires, path, domain, secure) 参数详解
2013/06/28 PHP
PHP基础知识介绍
2013/09/17 PHP
PHP实现事件机制实例分析
2015/06/26 PHP
php遍历、读取文件夹中图片并分页显示图片的方法
2016/11/15 PHP
yii框架结合charjs统计上一年与当前年数据的方法示例
2020/04/04 PHP
JS 添加网页桌面快捷方式的代码详细整理
2012/12/27 Javascript
Jquery Uploadify多文件上传带进度条且传递自己的参数
2013/08/28 Javascript
jQuery Trim去除字符串首尾空字符的实现方法说明
2014/02/11 Javascript
javascript数组操作总结和属性、方法介绍
2014/04/05 Javascript
javascript中加var和不加var的区别 你真的懂吗
2016/01/06 Javascript
axios post提交formdata的实例
2018/03/16 Javascript
layui实现点击按钮给table添加一行
2018/08/10 Javascript
详解vue-cli3多页应用改造
2019/06/04 Javascript
Vue商品控件与购物车联动效果的实例代码
2019/07/21 Javascript
一篇文章带你浅入webpack的DLL优化打包
2020/02/20 Javascript
JS关闭子窗口并且刷新上一个窗口的实现示例
2020/03/10 Javascript
Python 元组(Tuple)操作详解
2014/03/11 Python
Python数组条件过滤filter函数使用示例
2014/07/22 Python
python函数形参用法实例分析
2015/08/04 Python
python实时分析日志的一个小脚本分享
2017/05/07 Python
解决python线程卡死的问题
2019/02/18 Python
python顺序执行多个py文件的方法
2019/06/29 Python
Python collections中的双向队列deque简单介绍详解
2019/11/04 Python
Django --Xadmin 判断登录者身份实例
2020/07/03 Python
Python代码注释规范代码实例解析
2020/08/14 Python
HTML5 实现一个访问本地文件的实例
2012/12/13 HTML / CSS
详解如何用HTML5 Canvas API控制图片的缩放变换
2016/03/22 HTML / CSS
诗狄娜化妆品官方网站:Stila Cosmetics
2016/12/21 全球购物
娇韵诗Clarins意大利官方网站:法国天然护肤品牌
2020/03/11 全球购物
邮政员工辞职信
2014/01/16 职场文书
行政工作试用期自我评价
2014/09/14 职场文书
2014年单位法制宣传日活动总结
2014/11/01 职场文书
高校自主招生自荐信2015
2015/03/04 职场文书
公积金具结保证书
2015/05/11 职场文书