使用 node.js 進行伺服器端 JavaScript 編程

簡單的來說，node.js 是一個允許開發人員使用 JavaScript 語言編寫伺服器端程式碼的框架。也就是說編寫的 JavaScript 程式碼可以直接運行在本機上，而不僅限於瀏覽器。從實作的角度來說，Jaxer 和 node.js 都使用了現有的 JavaScript 執行引擎。 Jaxer 用的是 Mozilla Firefox 中使用的 JavaScript 引擎，而 node.js 用的則是 Google Chrome 中使用的 V8 引擎。

node.js 入門

node.js 可以運行在 Linux、Windows 和 Macintosh 等主流的作業系統上。在 Windows 平台上執行 node.js 的話，需要 Cygwin 或是 MinGW 的支援。以下以常用的 Windows 平台為例來說明。首先需要安裝 Cygwin。安裝的時候需要選擇 gcc-g++ 、make 、openssl 和 python 等套件。 gcc 的版本必須是最新的。接著從 參考資料 中給的位址下載 node.js 0.4.0 版本的原始碼。下載解壓縮之後，依序在 Cygwin 中執行 ./configure 、make 和 make install 等指令進行編譯和安裝。安裝完成之後，直接執行 node 命令就可以啟動 node.js 提供的命令列。在命令列中可以直接輸入 JavaScript 程式碼並執行。也可以透過 node server.js 的方式來執行一個 JavaScript 檔案 server.js 。

程式碼清單 1 中給出了一個簡單的「Hello World」程式的範例。透過 node helloworld.js 來運行該 JavaScript 檔案之後，會在控制台輸出「Hello World」。

清單1. 使用node.js 的「Hello World」程式
 process.stdout.write("Hello World");

程式碼清單1 中的process 表示的是目前運行的node.js 進程，其屬性stdout 表示的是進程的標準輸出流。透過 write() 方法寫入一個字串到給流中。從 程式碼清單 1 可以看到，使用 JavaScript 就可以存取標準輸出流等本機系統上的資源。這從一個側面反映出來了 node.js 的強大。

在node.js 可以運行的JavaScript 程式碼中，可以使用一些全域的物件：包含程式碼清單1 中使用的process 、下面會介紹的用來載入模組的require() 方法、表示目前正在執行的JavaScript檔案名稱的__filename 、表示目前正在執行的JavaScript 檔案的目錄的__dirname 和與瀏覽器中相似的用來執行定時任務的setTimeout() 和setInterval() 方法等。

在介紹了 node.js 的基本知識之後，以下介紹 node.js 的模組化結構。

回頁首

模組化結構

node.js 使用了 CommonJS 定義的模組系統。不同的功能組件被劃分成不同的模組。應用可以根據自己的需求來選擇使用合適的模組。每個模組都會暴露一些公共的方法或屬性。模組使用者直接使用這些方法或屬性即可，不需要關係模組內部的實作細節。除了系統預置的多個模組之外，應用程式開發團隊也可以利用這個機制將應用程式拆分成多個模組，以提高程式碼的可重複使用性。

使用模組

在 node.js 中使用一個模組的方式是非常簡單的。使用某個模組之前需要先聲明對它的依賴。在 JavaScript 程式碼中可以直接使用全域函數 require() 來載入一個模組。如 require("http") 可以載入系統預設的 http 模組。而 require("./myModule.js") 則是用來載入與目前 JavaScript 檔案相同目錄下的 myModule.js 模組。如果使用 require() 的路徑以「/」開頭的話，則認為是模組 JavaScript 檔案在作業系統上的絕對路徑。如果不是這兩種情況的話，node.js 就會嘗試在目前 JavaScript 檔案的父目錄及其祖先目錄下的 node_modules 目錄下尋找。例如目錄/usr/home/my.js 中呼叫了require("other.js") 的話，node.js 會依序嘗試找出下列檔案：/usr/home/node_modules/other.js 、/usr/node_modules/other .js 和/node_modules/other.js 。

require() 方法的傳回值是該模組所揭露的公開 JavaScript 對象，包含了可供使用的方法和屬性。程式碼清單 2 給出了模組的基本使用方式。

清單2. 模組的基本使用方式
 var greetings = require("./greetings.js");
 var msg = greetings.sayHello("Alex", "zh_CN");
 process.stdout.w msg);

如程式碼清單2 所示，一般是直接把require() 方法的回傳值賦值給一個變量，在JavaScript 程式碼中直接使用此變數即可。 greetings.js 模組揭露了一個 sayHello() 方法，目前 JavaScript 程式碼直接使用了該方法。

開發自己的模組

開發自己的模組的基本工作是在模組對應的 JavaScript 檔案中編寫模組相關的程式碼。這其中封裝了模組的內部處理邏輯。一般來說，一個模組通常會暴露一些公開的方法或屬性給其使用者。模組的內部程式碼需要把這些方法或屬性給暴露出來。程式碼清單 3 給出了 程式碼清單 2 中所使用的 greetings.js 檔案的內容。

清單3. greetings.js 模塊的內容
 var languages = {
    "zh_CN" : "你好，",
    "en" : "Hello, "
 };     
 exports.sayHello = function(name, language ) {
    return languages[language] || languages["en"] + name;
 };

如程式碼清單3 所示，exports 物件的內容就是模組的使用者呼叫require() 方法的回傳值中所稱包含的內容。模組透過這種方式來聲明其所暴露出來的公開方法和屬性。在模組中定義的變量，如 languages ，是只對模組內部的程式碼可見的。

如果一個模組所包含的內容比較多，也可以用資料夾的方式來組織。可以在資料夾的根目錄下方建立一個 package.json 文件，其內容中包含了模組的名稱和入口 JavaScript 文件的路徑。如果沒有提供這個 package.json 檔案的話，node.js 會預設在資料夾中尋找 index.js 檔案作為模組的啟動 JavaScript 檔案。

在介紹完 node.js 的模組化結構之後，以下介紹其事件驅動機制。

回頁首

事件驅動

開發過 Web 應用的人都熟悉瀏覽器中的事件處理機制。當對某個 DOM 元素上的某一類事件感興趣的時候，只需要在該 DOM 元素上面註冊一個事件監聽器。如 ele.addEventListener("click", function() {}) 就加入了一個對 click 事件的監聽器。當事件發生的時候，事件監聽器的 JavaScript 方法就會被呼叫。事件的處理方法是異步執行的。這種非同步執行的方式非常適合於開發高效能並發網路應用。實際上，目前的高效能並發應用開發一般有兩種做法：第一種是使用多執行緒的機制，另一種就是採用基於事件驅動的方式。多執行緒的問題在於應用程式開發起來難度較高，很容易出現執行緒飢餓或是死鎖等問題，對開發人員提出了更高的要求。而事件驅動的方式則更加靈活，很容易為 Web 開發人員所理解和使用，也不存在線程死鎖等問題。依賴於效能強大的 Google V8 引擎和先進的事件 I/O 架構，node.js 可以成為創建高效能伺服器端應用的良好基礎。

基於 node.js 開發應用程式與開發 Web 應用有相似的程式設計模型。許多模組都會暴露出一些事件，使用這些模組的程式碼透過註冊事件監聽器的方式來添加對應的處理邏輯。程式碼清單 4 中給出了一個簡單的 HTTP 代理伺服器的實作程式碼。

清單 4. HTTP 代理伺服器
 var http = require("http");
 var url = require("url");

 http.createServer(function (req, res) {
    var urlObj = url.parse(req.url, true); // 取得被代理的URL
    var urlToProxy =urlOb. {
        res.statusCode = 400;
        res.end("URL 是必須的。");
   ToProxy);
        var parsedUrl = url.parse( urlToProxy);
        var opt = {
            host : parsedUrl.hostname,           path : (parsedUrl.pathname || "") + (parsedUrl.search || "")
            parsedUrl.hash || "")
        };
        http.get(opt, function(pres) { //              var headers = pres.headers;
            for (var key in headers) {
                res.setHeader(key, headers[key]);
    function(chunk) {
                res.write(chunk); // 寫回資料
});
            pres.on("end", function() {
                    });
    }
 }).listen(8088, "127.0.0.1");

console.log("代理伺服器已經在8088 連接埠啟動。 ");

整個代理伺服器的實作比較簡單。首先透過http 模組中的createServer() 方法用來建立一個HTTP 伺服器，再透過listen() 方法就可以讓該HTTP 伺服器在特定連接埠監聽。在createServer( ) 方法中傳入的參數是HTTP 請求的回應方法。中所給的實作方式。 ;

在請求的處理方法裡面，透過http.get() 方法來取得被代理URL 的內容。在pres 的data 事件上加入了一個處理方法。同樣的。

回頁首

常用模組

node.js 預設提供了許多與網路與檔案系統操作相關的模組。

事件模組

前面提到過，node.js 採用的是事件驅動的架構，其中的許多模組都會產生各種不同的事件，可以由模組使用者來新增事件處理方法。物件都是事件模組中的EventEmitter 類別的實例。

addListener(event, listener) 和 on(event, listener) ：這兩個方法的作用都是用來為某個事件 event 新增事件處理方法 listener 。
once(event, listener) ：這個方法為某個事件 event 新增一個只執行一次的處理方法 listener 。處理方法在執行一次之後就會被刪除。
removeListener(event, listener) ：此方法用來刪除某個事件 event 上的處理方法 listener 。
emit(event, [arg1], [arg2], [...]) ：此方法用來產生某個事件 event 。事件名稱 event 之後的參數傳遞給對應的事件處理方法。
程式碼清單 6 給出了事件模組的使用範例。

清單6. 事件模組的使用範例
 var events = require("events");
 var emitter = new events.EventEmitter();
 emitter log(msg);
 });
 emitter.emit("myEvent", "Hello World.");

在事件模組中有一個特殊的事件error 。當出現錯誤的時候，EventEmitter 會產生此事件。如果此事件沒有對應的處理方法的話，預設的行為是輸出錯誤訊息後，程式自動終止。因此，需要注意總是添加一個對 error 事件的處理方法。

流

node.js 中存在各式各樣不同的資料流，包括檔案系統、HTTP 請求和回應、以及 TCP/UDP 連線等。這些流都是 EventEmitter 的實例，因此可以產生各種不同的事件。流可以分成唯讀、只寫和讀寫流三種。

可讀流主要會產生 4 個事件：

data ：當讀取到流中的資料時，產生此事件。

end ：當流中沒有資料可讀時，產生此事件。
error ：當讀取資料出現錯誤時，產生此事件。
close ：當流被關閉時，產生此事件。
除了上面的事件之外，還有一個 pipe() 方法可以用來把目前的可讀流和另一個可寫流連接起來。可讀流中的資料會自動寫入可寫入流中。

可寫流中最常用的是 write() 和 end() 兩個方法。 write() 方法用來在流中寫入數據，而 end() 則用來結束寫入操作。

為了表示二進位數據，node.js 使用了類別 Buffer 來表示資料緩衝區，以對二進位資料進行操作。 Buffer 類別內部是以陣列的方式來儲存資料的。一旦創建出來之後，Buffer 的大小是不能被修改的。 Buffer 類別的實例是可以與 JavaScript 中的字串類型互相轉換的。在轉換的時候需要指定編碼格式。透過 Buffer 類別的 toString(encoding, start, end) 方法可以把 Buffer 中的從 start 到 end 的內容轉換成以 encoding 編碼的字串。可以支援的編碼格式有：ascii 、utf8 和 base64 。透過 new Buffer(str, encoding) 可以用一個字串 str 來初始化一個緩衝區。 write(string, offset, encoding) 用來把一個字串 string 以編碼格式 encoding 寫入到緩衝區中以 offset 開始的位置上。

網路操作

node.js 提供了一些與網路操作相關的模組，包括 TCP、UDP 和 HTTP 等，可實現網頁伺服器和用戶端。

與 TCP 協定相關的實作在 net 模組中。透過該模組的 createServer(connectionListener) 方法可以建立一個 TCP 伺服器。參數 connectionListener 是當有客戶端連接到該伺服器上時的處理方法，等價於對 connect 事件的處理。一個 TCP 伺服器是類別 Server 的實例。透過 listen 方法可以讓伺服器在指定連接埠監聽。

如果想連接到一個已有的 TCP 伺服器的話，可以使用 createConnection(port, host) 方法來連接到指定主機 host 的連接埠 port 上。此方法的傳回值是 Socket 類別的實例，表示一個套接字連線。得到一個 Socket 類別的實例之後，就可以透過 write() 方法來寫入資料到該連線中。如果想從該連線上取得資料的話，可以加入 data 事件的處理方法。

程式碼清單 7 中給出了一個簡單的用來進行表達式計算的 TCP 伺服器，可以透過 telnet 指令連接到此伺服器來進行測試。

清單7.簡單的表達式計算伺服器
 var net = require("net");
 var server = net.createServer(function(socket) {
   ], len = 0;
    socket.on("data", function(data) { // 接收到客戶端資料
        if (data.charCodeAt(0) == 13) { ");
            try {
                rite(result.toString()); // 寫回結果
            } catch (e) {
                    expression.");
            } finally {
               [];
            }
        }
          }
    });
 });
 server.listen(8180, "127.0.0.1");
 console.log("伺服器已經在連接埠8180 啟動。");

除了TCP 伺服器外，模組http 和https 可以分別實作HTTP 和HTTPS 伺服器，HTTP 和HTTPS 伺服器，HTTP 和HTTPS 模組，HTTP 和HTTPS 模組， dgram 可以實現UDP/Datagram 套接字連接，模組tls 可以實現安全的套接字連接（SSL）。這些模組的使用方式都類似於模組 tcp 。

檔案系統

node.js 中的 fs 模組用來對本機檔案系統進行操作。 fs 模組中提供的方法可以用來執行基本的檔案操作，包括讀取、寫入、重新命名、建立和刪除目錄以及取得檔案元資料等。每個操作文件的方法都有同步和非同步兩個版本。非同步操作的版本都會使用一個回呼方法作為最後一個參數。當操作完成的時候，該回呼方法會被呼叫。而回呼方法的第一個參數總是保留為操作時可能出現的異常。如果操作正確成功，則第一個參數的值是 null 或 undefined 。而同步操作的版本的方法名稱則是在對應的非同步方法之後加上一個 Sync 作為後綴。例如非同步的 rename() 方法的同步版本是 renameSync() 。以下列出來了 fs 模組中的一些常用方法，都只介紹非同步操作的版本。

rename(path1, path2) ：將路徑 path1 表示的目錄或檔案重新命名成路徑 path2 。

truncate(fd, len) ：將檔案描述子 fd 對應的檔案的長度截斷為 len 。

chmod(path, mode) ：將路徑 path 表示的目錄或檔案的權限修改為 mode 。

stat(path) ：取得路徑 path 表示的目錄或檔案的元資料。元資料用 Stats 類別來表示。

open(path, flags, mode) ：開啟一個路徑 path 表示的檔案。回調方法中可以得到該檔案的描述符。

read(fd, buffer, offset, length, position) ：讀取給定檔案描述子fd 所表示的檔案中從position 位置開始的長度為length 位元組的數據，並存放到緩衝區buffer 中從offset 起始的位置上。回呼方法中可以得到實際讀取的位元組數。

write(fd, buffer, offset, length, position) ：將緩衝區 buffer 中的資料寫入到檔案描述符 fd 所表示的檔案中。參數的意義與 read() 方法相同。回呼方法中可以得到實際寫入的位元組數。
readFile(filename, encoding) ：以編碼格式 encoding 讀取一個檔案 filename 中的內容。回調方法中可以得到文件的內容。
writeFile(filename, data, encoding) ：將資料 data 以編碼格式 encoding 寫入到檔案 filename 中。
除了上面列出來的直接操作文件本身的方法外，還可以把文件轉換成流。 createReadStream(path, options) 和 createWriteStream(path, options) 分別用來從檔案中建立可讀和可寫流。參數 path 表示的是檔案的路徑，options 是一個表示讀取或寫入檔案時的選項的 JavaScript 物件。

程式碼清單 8 中給出了一個簡單的 HTTP 靜態檔案伺服器的實作。

清單8. HTTP 靜態檔案伺服器
 var http = require("http"),
    fs = require("fs"),
    path = require("path

 var server = http.createServer(function(req, res) {

    var pathname = url.parse(req.url).pathname;
    var filepath = .join(root"/mp.join( ;
    var stream = fs.createReadStream(filepath, {flags : "r", encoding : null});
    stream.on("error", function(   res.end( );
    });
    stream.pipe(res);
 });
 server.on("error", function(error) {
    console.log(error); , "127.0.0.1");

如程式碼清單8 所示，首先把HTTP 請求的路徑轉換成伺服器上檔案路徑，再從檔案中建立可讀流，最後透過pipe() 方法把檔案的資料流傳遞到HTTP 請求的回應。

輔助模組

除了上面介紹的這些常見模組之外，node.js 還提供了一些輔助的模組。

模組 path 用來處理檔案系統上的路徑。這個模組中的 join() 用來把多個路徑連接起來，形成一個完整的路徑。如 join("/usr", "home", "test/index.html") 的結果是路徑 /usr/home/test/index.html 。 normalize() 用來對路徑進行歸一化操作，去掉其中多餘的「/」以及處理「..」和「.」。 resolve([from ...], to) 方法用來取得給定路徑 to 的絕對路徑。如果 to 不是絕對路徑，就把它之前的參數按從右到左的順序添加上去，直到得到了一個絕對路徑。如果到最後還是無法得到絕對路徑，就把目前的工作目錄加上。假設目前的工作目錄是 /usr/home ，那麼 resolve("test", "index.html") 的回傳結果是 /usr/home/test/index.html 。 dirname() 方法用來取得路徑的目錄部分。如 dirname("/usr/home/index.html") 的回傳結果是 /usr/home 。 basename() 用來取得路徑的最後一個部分。如 basename("/usr/home/index.html") 的回傳結果是 index.html 。 extname() 用來取得一個路徑的檔案副檔名部分。如 extname("/usr/home/index.html") 的回傳結果是 .html 。

模組 url 用來對 URL 進行解析。 parse(urlStr, parseQueryString) 方法用來把一個 URL 字串 urlStr 解析成主機名稱、連接埠和路徑等幾個部分。此方法的傳回值是一個包含了 protocol 、hostname 、port 、pathname 和 query 等屬性的 JavaScript 物件。如果參數 parseQueryString 的值為 true 的話，URL 中包含的查詢字串部分也會被解析。 format(urlObj) 方法的作用與 parse() 方法正好相反，用來從一個 JavaScript 物件建構出 URL 字串。

模組 querystring 用來處理 URL 中的查詢字串。 stringify(obj) 方法用來把一個 JavaScript 物件 obj 轉換成查詢字串的格式。如 stringify({a : 1, b : "good"}) 的回傳結果是 a=1&b=good 。 parse(str) 用來把一個查詢字串解析成 JavaScript 物件。

模組 vm 可以用來執行 JavaScript 程式碼。方法 runInThisContext(code) 用來執行一段 JavaScript 程式碼 code 並傳回其結果。透過該方法運行的 JavaScript 程式碼不能存取目前程式碼的作用域。 runInNewContext(code, [sandbox]) 方法也是用來執行 JavaScript 程式碼的，與 runInThisContext() 不同的是透過此方法運行的 JavaScript 程式碼使用 sandbox 物件作為全域物件。如 runInNewContext("a + 3", {a : 4}) 的回傳結果是 7。 createScript(code) 方法用來預先編譯一段 JavaScript 程式碼，但是並不立即執行。此方法的傳回值是一個 Script 物件。這個物件同樣有 runInThisContext() 和 runInNewContext([sandbox]) 兩個方法，意義與上述的兩個方法類似。

模組 os 提供了與底層作業系統相關的一些資訊。包括hostname() 用來取得作業系統的主機名稱；type() 用來取得作業系統的類型；release() 用來取得作業系統的發行版本號；uptime() 用來取得以秒計算的系統運行時間；cpus() 用來取得CPU 的相關資訊。 freemem() 和 totalmem() 分別用來取得系統的記憶體總數和可用記憶體數。

模組 util 提供了一些常用的輔助方法。 debug(string) 方法用來輸出訊息到標準錯誤流。 log(string) 方法用來輸出附帶時間戳記的資訊到標準輸出流。 inspect(object, showHidden, depth) 方法用來輸出一個物件的內部結構，參數 object 是要查看的對象，showHidden 表示是否查看對象的隱藏屬性，depth 表示查看的對象層次結構的深度，預設值是 2。 inherits(constructor, superConstructor) 方法用來實作 JavaScript 中基於原型的繼承機制。

在介紹完 node.js 提供的常用模組之後，下面透過完整的範例來說明 node.js 的用法。

回頁首

實例分析

這個實例實現的功能是動態監測伺服器的記憶體使用狀態，也就是記憶體的佔用率。取得伺服器上的記憶體佔用率比較簡單，只需要使用 os 模組提供的方法即可，即 freemem()/totalmem() 。為了能夠即時的監控記憶體佔有率，伺服器需要即時的把資料傳輸給瀏覽器端。這裡最好的實作方式是 HTML 5 中引入的 WebSocket 規範。該規範在 Firefox 4 和 Google Chrome 等新瀏覽器上得到了支援。同時伺服器端也需要支援此規範。 Socket.IO 在 node.js 上提供了對 WebSocket 規範的支持，包括伺服器端和瀏覽器端程式碼。程式碼清單 9 給出了使用 Socket.IO 的伺服器端程式碼。

清單9.監控記憶體佔用率的伺服器端程式碼
 var io = require('./socket.io');
 var io = io.listen(server);
 io.on("connection", function (client){
    setInterval(function() {
        client.send(os.freemem() / os.totalmem()); client.send(os.freemem() / os.totalmem());. .js 中的一個HTTP 伺服器對象，用來回應一般的HTTP 請求。 Socket.IO 可以對 node.js 的 HTTP 伺服器的請求進行攔截，將部分請求交給 Socket.IO 來處理。這裡的處理邏輯是當有客戶端連線上的時候，就每隔 500 毫秒把伺服器的記憶體佔用率傳送給客戶端。程式碼清單 10 給出了瀏覽器端的 HTML 和 JavaScript 程式碼。

清單10. 監控記憶體佔用率的瀏覽器端程式碼
 html>
 
 

   
 /socket.io.js">