網上看過一些為 Ajax 的 XMLHttpRequest 設計物件池的討論,也讀了他們給出的實作,感覺不太理想,於是模仿 Apache Commons 的 ObjectPool 思路寫了一個簡單的 JavaScript 版本,貼出來請多指教。
function ObjectPool(poolableObjectFactory) {
this._poolableObjectFactory = poolableObjectFactory;
this._idlePool = [];
this._activePool = [];
}
// 從物件池中租借一個物件;若目前沒有空閒物件,則透過 poolableObjectFactory 建立
// 既然是借的,用完記得一定要還
ObjectPool.prototype.borrowObject = function() {
var object = null;
var idlePool = this._idlePool;
var factory = this._poolableObjectFactory;
if (idlePool.length > 0) {
object = idlePool.pop();
}
else {
object = factory.makeObject();
}
if (object != null) {
this._activePool.push(object);
if (factory.activateObject) {
factory.activateObject(object);
}
}
return object;
}
// 歸還一個物件
ObjectPool.prototype.returnObject = function(object) {
function indexOf(array, object) {
for (var i = 0; i < array.length; i++) {
if (array[i] == object) return i;
}
return -1;
}
if (object != null) {
var activePool = this._activePool;
var factory = this._poolableObjectFactory;
var i = indexOf(activePool, object);
if (i < 0) return;
if (factory.passivateObject) {
factory.passivateObject(object);
}
activePool.splice(i, 1);
this._idlePool.push(object);
}
}
// 目前使用中(激活)的物件數量
ObjectPool.prototype.getNuMactive = function() {
return this._activePool.length;
}
// 目前空閒的物件數量
ObjectPool.prototype.getNumIdle = function() {
return this._idlePool.length;
}
// 銷毀物件池及其中的所有物件
// 若池中的物件需要解構,必須實作 poolableObjectFactory 的 destroyObject 方法,
// 並確保 ObjectPool 的 destroy 會在需要時被呼叫(例如 window 的 unload 事件中)
ObjectPool.prototype.destroy = function() {
var factory = this._poolableObjectFactory;
function returnObject(object) {
if (factory.passivateObject) {
factory.passivateObject(object);
}
}
function destroyObject(object) {
if (factory.destroyObject) {
factory.destroyObject(object);
}
}
var activePool = this._activePool;
for (var i = 0; i < activePool.length; i++) {
var object = activePool[i];
returnObject(object);
destroyObject(object);
}
var idlePool = this._idlePool;
for (var i = 0; i < idlePool.length; i++) {
var object = idlePool[i];
destroyObject(object);
}
this._idlePool = null;
this._activePool = null;
this._poolableObjectFactory = null;
}
// 注意:這只是說明,不是真正的程式碼
var PoolableObjectFactory = {
makeObject: function() {}, // 建立一個新物件(必須實作)
activateObject: function(object) {}, // 物件被激活(借出)時觸發(可選)
passivateObject: function(object) {}, // 物件被鈍化(歸還)時觸發(可選)
destroyObject: function(object) {} // 銷毀一個物件(可選)
};
// 宣告 XMLHttpRequest 的建立工廠
var factory = {
makeObject: function() {
// 建立 XMLHttpRequest 物件
// 註:這裡的建立方式不夠強壯,勿照抄
if (window.ActiveXObject){
return new ActiveXObject("Microsoft.XMLHTTP");
}
else {
return new XMLHttpRequest();
}
},
passivateObject: function(xhr) {
// 重置 XMLHttpRequest 物件
xhr.onreadystatechange = {};
xhr.abort();
}
};
var pool = new ObjectPool(factory); // 建立物件池
// ......
var xhr = pool.borrowObject(); // 取得一個 XMLHttpRequest
xhr.onreadystatechange = function() {
if (xhr.readyState == 4) {
// ......
pool.returnObject(xhr); // 歸還
}
};
xhr.open(method, url, true);
// ......
function test_pool() {
var factory = {
counter: 0,
makeObject: function() {
return {id: ++ this.counter};
},
activateObject: function(object) {
object.activated = true;
},
passivateObject: function(object) {
object.activated = false;
},
destroyObject: function(object) {
object.destroyed = true;
}
};
var pool = new ObjectPool(factory);
var object1 = pool.borrowObject();
assertEquals(object1.id, 1);
assertTrue(object1.activated);
assertEquals(pool.getNuMactive(), 1);
assertEquals(pool.getNumIdle(), 0);
var object2 = pool.borrowObject();
assertEquals(object2.id, 2);
assertEquals(pool.getNuMactive(), 2);
var object3 = pool.borrowObject();
assertEquals(object3.id, 3);
assertEquals(pool.getNuMactive(), 3);
pool.returnObject(object2); // 歸還 object2
assertFalse(object2.activated);
assertEquals(pool.getNuMactive(), 2);
assertEquals(pool.getNumIdle(), 1);
pool.returnObject(object3);
assertEquals(pool.getNumIdle(), 2);
pool.returnObject(object1);
assertEquals(pool.getNuMactive(), 0);
assertEquals(pool.getNumIdle(), 3);
pool.destroy(); // 銷毀整個池
assertTrue(object1.destroyed);
assertTrue(object2.destroyed);
assertTrue(object3.destroyed);
}
這個設計的重點在於「借」與「還」的明確分工:borrowObject 會優先從 idlePool 取件並觸發 activateObject,returnObject 則先 passivateObject 再移回 idlePool,如此就能在同一頁面上安全地併發多個非同步請求,不必反覆建立與銷毀 XMLHttpRequest 物件。