您好,欢迎访问一九零五行业门户网

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

前言
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 = $('').html(product.getdescription()).attr('id-cart', product.getid()).appendto(#cart);
}
products.foreach(function (product) {
var newitem = $('').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 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 = $('').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 = $('').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 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 = $('').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 = $('').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原则进行职责分离了,这样才有利于以后的维护。
其它类似信息

推荐信息