深入理解JavaScript系列(6)：S.O.L.I.D五大原則之單一職責SRP

前言
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原則進行職責分離了，這樣才有利於以後的維護。