DIV CSS 佈局教程網

Node.js Connect 中間件筆記(二):原始碼解析
編輯:關於JavaScript     

上一篇談了 Connect 的用法與用途,這篇想再往下一層,直接讀原始碼看它是怎麼把「一堆中間件」變成一個可用的 HTTP 伺服器。理解設計意圖之後,自己動手寫類似機制時會更有底氣。若分析中有不正確之處,也歡迎指正。

一、先看一個最小例子

var connect = require("./lib/connect");
var app = connect.createServer();

app.use(connect.static(__dirname + "/public", {
    maxAge: 0
}));

app.use(function(req, res, next){
    res.end("Hello World !");
}).listen(8888);

接下來逐行拆它背後發生的事。

二、逐行分析

(1)require("connect")

引入模組後,Connect 提供建立 http/https server 的能力。它允許你用多種方式建立 server:

var server = connect.createServer(
    connect.logger()
  , connect.static(__dirname + '/public')
); // 寫法 1

var app = connect();
app.use(function (req, res) {
    res.end("Hello,大雄君 !\n");
}).listen(8888);   // 寫法 2

看原始碼就明白了:

exports = module.exports = createServer;
exports.createServer = createServer;

先把 createServer 掛到 exports 上,再額外擴充一個同名的 createServer 屬性掛回去。這樣做的目的是同時兼容兩種書寫形式(connect(...) 與 connect.createServer(...))——一個很值得借鏡的小技巧。

(2)connect.createServer()

var HTTPServer  = require('./http').Server ,
    HTTPSServer = require('./https').Server ;

function createServer() {
  if ('object' == typeof arguments[0]) {
      return new HTTPSServer(arguments[0], Array.prototype.slice.call(arguments, 1));
  } else {
      return new HTTPServer(Array.prototype.slice.call(arguments));
  }
};

HTTPSServer 與 HTTPServer 結構基本一致,前者只是把 https 的方法封裝進來。呼叫 createServer 時可以直接把一系列中間件傳進去,效果與事後 use 相同,差別是這種寫法只能綁定在根路徑上。

(3)app.use()

var Server = exports.Server = function HTTPServer(middleware) {
  this.stack = [];
  middleware.forEach(function(fn){
    this.use(fn);
  }, this);
  http.Server.call(this, this.handle);
};

/**
 * Inherit from `http.Server.prototype`.
 */
Server.prototype.__proto__ = http.Server.prototype;

重點有兩個:

  • Connect 的 Server 原型繼承自 http.Server,並用註冊好的中間件替換掉 server 原本的 requestListener。
  • connect.use(route, handle) 會把每個 handle 與它的 route 綁定後放進 stack 陣列。每次有請求進來,就遍歷這個堆疊,找到符合 route 的 handle 並執行;若 handle 最後呼叫了 next(),就繼續往下找下一個符合的 handle。

正因為 handle 被這樣封裝,才能在 Connect 之上輕鬆疊加更多 middleware。

(4)listen(8888)

這一層就單純了:透過繼承底層的 Server 物件,Connect 直接獲得了 listen 能力來監聽指定埠號。

Server.prototype.__proto__ = http.Server.prototype;

三、connect.js 全貌

以下是 connect.js 的完整原始碼(為節省篇幅已刪去註解):

補充:中間件是如何被掛上去的

fs.readdirSync(__dirname + '/middleware').forEach(function(filename){
  if (/\.js$/.test(filename)) {
    var name = filename.substr(0, filename.lastIndexOf('.'));
    exports.middleware.__defineGetter__(name, function(){
      return require('./middleware/' + name);
    });
  }
});

這段做的事是:把 middleware 物件掛到 exports 上,然後迴圈為它定義 getter,讓存取 connect.xxx 時才真正去載入 middleware 資料夾底下對應的 .js 模組。這是典型的懶人載入(lazy loading):沒用到的中間件不會被 require,啟動速度因此更快。

最後再透過 exports.utils.merge(exports, exports.middleware),把 middleware 中的方法直接平攤到 exports 上,於是就能寫成 connect.static()、connect.session() 這種簡潔形式。

四、讀原始碼的心得

  1. 先理解源碼的設計意圖,在實際應用時收穫才最大。
  2. 讀的時候先掌握整體流程,再去扣語法細節,否則很容易卡在某一行裡出不來。
  3. 可以借鏡源碼中巧妙的實作思路(例如 getter 懶人載入、exports 雙掛載),但不要過度設計——為了設計而設計反而增加維護成本。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved