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.write(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 = urlObj.query.url;
if (!urlToProxy) {
res.statusCode = 400;
res.end("URL 是必須的。");
}
else {
console.log("處理代理請求：" + urlToProxy);
var parsedUrl = url.parse(urlToProxy);
var opt = {
host : parsedUrl.hostname,
port : parsedUrl.port || 80,
path : (parsedUrl.pathname || "") + (parsedUrl.search || "")
+ (parsedUrl.hash || "")
};
http.get(opt, function(pres) { // 請求被代理 URL 的內容
res.statusCode = pres.statusCode;
var headers = pres.headers;
for (var key in headers) {
res.setHeader(key, headers[key]);
}
pres.on("data", function(chunk) {
res.write(chunk); // 寫回數據
});
pres.on("end", function() {
res.end();
});
});
}
}).listen(8088, "127.0.0.1");
console.log("代理服務器已經在 8088 端口啓動。");
|
整個代理服務器的實現比較簡單。首先通過 http 模塊中的 createServer() 方法用來創建一個 HTTP 服務器，再通過 listen()方法就可以讓該 HTTP 服務器在特定端口監聽。在 createServer() 方法中傳入的參數是
HTTP 請求的響應方法。實際上，每個 HTTP 請求都是對應於 HTTP 服務器上的一個 request 事件。代碼清單 4 中的 HTTP 服務器創建部分實際上等價於 代碼清單
5 中給出的實現方式。
清單 5. 使用事件機制的 HTTP 服務器創建方式
var server = http.createServer();
server.on("request", function(req, res) {
});
|
在請求的處理方法裏面，通過 http.get() 方法來獲取被代理 URL 的內容。這裏同樣採用了基於事件的處理方式。pres.on("data", function(chunk) {}) 在 pres 的 data 事件上添加了一個處理方法。該方法的作用是當獲取到被代理
URL 的內容的時候，就把獲取到的內容寫回到原始 HTTP 請求的響應中。對於 end 事件的處理也是同樣的。在使用 node.js 進行開發的時候，會經常遇到這種使用事件處理方法和回調方法的場景。
在介紹了 node.js 的事件驅動機制之後，下面介紹一些常用的模塊。
node.js 默認提供了很多與網絡與文件系統操作相關的模塊。這些模塊是構建服務器端應用的基礎。下面對其中一些常見的模塊進行具體說明。
前面提到過，node.js 採用的是事件驅動的架構，其中的很多模塊都會產生各種不同的事件，可以由模塊使用者來添加事件處理方法。所有能夠產生事件的對象都是事件模塊中的 EventEmitter 類的實例。
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.on("myEvent", function(msg) {
console.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) {
socket.setEncoding("utf8");
var buffer = [], len = 0;
socket.on("data", function(data) { // 接收到客戶端數據
if (data.charCodeAt(0) == 13) {
var expr = buffer.join("");
try {
var result = eval(expr); // 進行計算
socket.write(result.toString()); // 寫回結果
} catch (e) {
socket.write("Wrong expression.");
} finally {
socket.write("\r\n");
buffer = [];
}
}
else {
buffer.push(data);
}
});
});
server.listen(8180, "127.0.0.1");
console.log("服務器已經在端口 8180 啓動。");
|
除了 TCP 服務器外，模塊 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"),
url = require("url");
var server = http.createServer(function(req, res) {
var pathname = url.parse(req.url).pathname;
var filepath = path.join("/tmp", "wwwroot", pathname);
var stream = fs.createReadStream(filepath, {flags : "r", encoding : null});
stream.on("error", function() {
res.writeHead(404);
res.end();
});
stream.pipe(res);
});
server.on("error", function(error) {
console.log(error);
});
server.listen(8088, "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());
}, 500);
});
|
在 代碼清單 9 中，server 是 node.js 中的一個 HTTP 服務器對象，用來響應一般的 HTTP 請求。Socket.IO 可以對 node.js 的 HTTP
服務器的請求進行攔截，將部分請求交給 Socket.IO 來處理。這裏的處理邏輯是當有客戶端連接上的時候，就每隔 500 毫秒把服務器的內存佔用率發送給客戶端。代碼清單 10 給出了瀏覽器端的 HTML 和 JavaScript 代碼。
清單 10. 監測內存佔用率的瀏覽器端代碼
<!doctype html>
<html>
<head>
<title> 服務器內存使用情況 </title>
<script src="/socket.io/socket.io.js"></script>
<style>
#usage {border : 1px dashed green;}
</style>
<script>
var canvas, width = 200, height = 200, buffer = [], max = 200;
function updateChart(data) {
if (buffer.length >= max) {
buffer.unshift();
}
buffer.push(data);
var ctx = canvas.getContext("2d");
ctx.clearRect(0, 0, width, height);
for (var i = 1, n = buffer.length; i < n; i++) {
ctx.strokeStyle = "red";
ctx.beginPath();
ctx.moveTo(i - 1 , buffer[i - 1] * height);
ctx.lineTo(i, buffer[i] * height);
ctx.closePath();
ctx.stroke();
}
}
function onLoad() {
canvas = document.getElementById("usage");
var socket = new io.Socket(null, {port: 8088});
socket.connect(); // 連接到服務器
socket.on("message", function(obj){ // 接收到消息時的處理方法
updateChart(obj);
});
}
</script>
</head>
<body οnlοad="onLoad();">
<h1> 內存使用情況 </h1>
<canvas id="usage" width="200" height="200"></canvas>
</body>
</html>
|
如 代碼清單 10 所示，首先建立一個與服務器之間的 WebSocket 連接。通過 message 事件定義了當接收到服務器端的消息時，更新瀏覽器端的顯示。瀏覽器端通過一個
HTML 5 提供的 canvas 來繪製內存佔用率的曲線圖，如 圖 1 所示。
圖 1. 內存佔用率的曲線圖
一提到服務器端開發，開發人員一般想到的就是 Java 和 C/C++ 等語言。但是通過 node.js 提供的強大能力，熟悉 JavaScript 的 Web 開發人員也可以開發出服務器端的應用。本文詳細介紹了 node.js 的事件驅動機制和模塊化結構，並對其中的常用模塊做了詳細說明，最後通過一個完整的實例展示了 node.js 的實用性。