Node.js特訓專欄-基礎篇：3. Node.js內置模塊的使用

🔥 歡迎來到 Node.js 實戰專欄！在這里，每一行代碼都是解鎖高性能應用的鑰匙，讓我們一起開啟 Node.js 的奇妙開發之旅！
Node.js 特訓專欄主頁

Node.js內置模塊：強大功能的基石

在Node.js的世界里，內置模塊猶如一座寶藏庫，為開發者提供了豐富且實用的功能。這些模塊隨Node.js一同安裝，無需額外下載，極大地提升了開發效率。接下來，讓我們深入探索一些常用內置模塊的奇妙用法。

一、fs模塊：文件系統的掌控者

fs模塊是Node.js操作文件系統的得力助手，無論是讀取文件、寫入文件，還是創建目錄、刪除文件等操作，它都能輕松勝任。

1. 讀取文件

異步讀取：在處理大文件或對響應速度要求較高的場景中，異步讀取是首選。通過fs.readFile方法，我們可以在不阻塞主線程的情況下讀取文件內容。例如：

const fs = require('fs');
fs.readFile('example.txt', 'utf8', (err, data) => {if (err) {console.error('讀取文件失敗:', err);return;}console.log('文件內容:', data);
});

這里，example.txt是要讀取的文件名，utf8指定了文件的編碼格式。當讀取操作完成后，回調函數會被觸發，err參數表示可能出現的錯誤，data則是讀取到的文件內容。

同步讀取：同步讀取文件相對簡單直接，但會阻塞主線程，可能影響應用的性能。適用于文件較小且對性能影響不大的情況。使用fs.readFileSync方法，示例如下：

const fs = require('fs');
try {const data = fs.readFileSync('smallFile.txt', 'utf8');console.log('文件內容:', data);
} catch (err) {console.error('讀取文件失敗:', err);
}

2. 寫入文件

異步寫入：fs.writeFile用于異步寫入文件。如果文件不存在，會自動創建；如果文件已存在，則會覆蓋原有內容。示例代碼如下：

const fs = require('fs');
const content = '這是要寫入文件的內容';
fs.writeFile('newFile.txt', content, 'utf8', (err) => {if (err) {console.error('寫入文件失敗:', err);return;}console.log('文件寫入成功');
});

同步寫入：同步寫入使用fs.writeFileSync方法，與異步寫入類似，只是操作會阻塞主線程。

const fs = require('fs');
const content = '同步寫入的內容';
try {fs.writeFileSync('syncFile.txt', content, 'utf8');console.log('同步寫入成功');
} catch (err) {console.error('同步寫入失敗:', err);
}

3. 其他文件系統操作

fs模塊還提供了諸如fs.unlink（刪除文件）、fs.mkdir（創建目錄）、fs.rmdir（刪除目錄）等豐富的方法，滿足各種文件系統操作需求。例如，創建一個新目錄：

const fs = require('fs');
fs.mkdir('newDirectory', (err) => {if (err) {console.error('創建目錄失敗:', err);return;}console.log('目錄創建成功');
});

二、path模塊：路徑處理的專家

在不同操作系統中，文件路徑的表示方式存在差異，而path模塊可以幫助我們統一處理路徑問題，避免因路徑格式不一致導致的錯誤。

1. 路徑拼接

path.join方法用于拼接路徑，它會根據當前操作系統的路徑分隔符，將傳入的路徑片段正確連接起來。示例如下：

const path = require('path');
const joinedPath = path.join('parent', 'child', 'file.txt');
console.log(joinedPath);
// 在Windows上可能輸出: parent\child\file.txt
// 在Linux或macOS上可能輸出: parent/child/file.txt

2. 獲取路徑信息

獲取目錄名：使用path.dirname方法可以獲取文件路徑中的目錄部分。例如：

const path = require('path');
const filePath = '/user/home/docs/file.txt';
const dirName = path.dirname(filePath);
console.log(dirName); // 輸出: /user/home/docs

獲取文件名：path.basename方法用于獲取路徑中的文件名。如果只想獲取文件名而不包含擴展名，可以傳入第二個參數true。示例：

const path = require('path');
const filePath = '/user/home/docs/file.txt';
const baseName = path.basename(filePath);
const baseNameWithoutExt = path.basename(filePath, '.txt');
console.log(baseName); // 輸出: file.txt
console.log(baseNameWithoutExt); // 輸出: file

獲取文件擴展名：path.extname方法能夠獲取文件的擴展名。

const path = require('path');
const filePath = '/user/home/docs/file.txt';
const ext = path.extname(filePath);
console.log(ext); // 輸出:.txt

三、http模塊：Web服務的構建者

http模塊使我們能夠輕松創建HTTP服務器和客戶端，是構建Web應用的核心模塊之一。

1. 創建HTTP服務器

下面是一個簡單的HTTP服務器示例，它監聽3000端口，當接收到請求時，返回“Hello, World!”：

const http = require('http');
const server = http.createServer((req, res) => {res.statusCode = 200;res.setHeader('Content-Type', 'text/plain');res.end('Hello, World!');
});
server.listen(3000, () => {console.log('服務器正在監聽3000端口');
});

在這個例子中，http.createServer方法接收一個回調函數，該函數在每次接收到HTTP請求時被調用。req對象包含了請求的信息，res對象用于處理響應。

2. 發起HTTP請求

http模塊也可以用于發起HTTP請求。以下是一個簡單的GET請求示例：

const http = require('http');
const options = {hostname: 'www.example.com',port: 80,path: '/',method: 'GET'
};
const req = http.request(options, (res) => {let data = '';res.on('data', (chunk) => {data += chunk;});res.on('end', () => {console.log('響應內容:', data);});
});
req.end();

這里通過http.request方法創建了一個HTTP請求，設置了請求的目標主機、端口、路徑和方法等選項。通過監聽res對象的data和end事件，可以獲取完整的響應內容。

四、events模塊：事件驅動的核心

events模塊是Node.js事件驅動架構的基礎。在Node.js中，許多對象都是EventEmitter類的實例，它們能夠觸發和監聽事件。例如，http服務器實例就繼承自EventEmitter，可以監聽request事件來處理客戶端請求。

事件監聽與觸發

使用on方法來監聽事件，emit方法來觸發事件。以下是一個簡單示例：

const EventEmitter = require('events');
const emitter = new EventEmitter();
emitter.on('customEvent', (arg1, arg2) => {console.log('自定義事件觸發，參數1:', arg1, '參數2:', arg2);
});
emitter.emit('customEvent', 'value1', 'value2');

在這個例子中，我們創建了一個EventEmitter實例emitter，通過on方法監聽customEvent事件，并在事件觸發時執行回調函數。然后使用emit方法觸發了該事件，并傳遞了兩個參數。這在處理異步操作完成通知、狀態變化通知等場景中非常有用。

五、util模塊：實用工具集

util模塊提供了一系列實用工具函數，幫助開發者簡化常見的編程任務。

promisify函數

util.promisify用于將基于回調函數的API轉換為返回Promise的版本，這在處理異步操作時極大地提高了代碼的可讀性和可維護性。例如，將fs.readFile轉換為Promise風格：

const util = require('util');
const fs = require('fs');
const readFile = util.promisify(fs.readFile);
readFile('example.txt', 'utf8').then(data => {console.log('文件內容:', data);}).catch(err => {console.error('讀取文件失敗:', err);});

inspect函數

util.inspect函數用于生成對象的字符串表示形式，方便調試和查看對象結構。它提供了更多格式化選項，比直接使用console.log打印對象更具可讀性。例如：

const util = require('util');
const complexObj = {a: 1,b: 'string',c: [1, 2, { nested: 'value' }]
};
console.log(util.inspect(complexObj, { depth: null }));

這里depth: null參數表示打印對象的完整深度，不會截斷嵌套對象的顯示。

六、querystring模塊：查詢字符串處理

querystring模塊專門用于處理URL查詢字符串的解析與格式化。在處理HTTP請求中的查詢參數時，這個模塊非常實用。

解析查詢字符串

使用querystring.parse方法將查詢字符串轉換為對象。例如：

const querystring = require('querystring');
const query = 'name=John&age=30&city=New%20York';
const parsedQuery = querystring.parse(query);
console.log(parsedQuery);
// 輸出: { name: 'John', age: '30', city: 'New York' }

構建查詢字符串

使用querystring.stringify方法將對象轉換為查詢字符串。例如：

const querystring = require('querystring');
const user = {name: 'John',age: 30,city: 'New York'
};
const stringifiedQuery = querystring.stringify(user);
console.log(stringifiedQuery);
// 輸出: name=John&age=30&city=New%20York

七、os模塊：操作系統信息獲取

os模塊提供了與操作系統相關的信息和功能。通過它，我們可以輕松獲取系統的各種信息，如CPU核心數、內存使用情況、操作系統類型等。

獲取系統信息示例

const os = require('os');
console.log('操作系統類型:', os.type());
console.log('CPU核心數:', os.cpus().length);
console.log('總內存:', os.totalmem());
console.log('空閑內存:', os.freemem());
console.log('主機名:', os.hostname());

這些信息在進行系統性能監控、資源分配優化等場景中十分關鍵，幫助開發者根據系統實際情況做出更合理的決策。

八、stream模塊：高效數據處理

stream模塊為Node.js的I/O操作提供了流處理能力，使得處理大文件或大量數據時能夠高效地逐塊讀取和寫入，避免一次性將所有數據加載到內存中。

可讀流與可寫流示例

以下是一個簡單的文件復制示例，使用可讀流讀取文件，通過可寫流寫入新文件：

const fs = require('fs');
const readStream = fs.createReadStream('source.txt');
const writeStream = fs.createWriteStream('destination.txt');
readStream.pipe(writeStream);
readStream.on('error', (err) => {console.error('讀取文件錯誤:', err);
});
writeStream.on('error', (err) => {console.error('寫入文件錯誤:', err);
});
writeStream.on('finish', () => {console.log('文件復制完成');
});

pipe方法將可讀流和可寫流連接起來，實現數據的自動流動和處理，大大簡化了流操作的代碼。

九、process模塊：掌控當前進程

process是一個全局對象，代表當前運行的Node.js進程。它提供了關于進程的信息和控制方法，如獲取進程參數、設置退出碼、監聽進程事件等。

進程信息與事件監聽示例

// 獲取命令行參數
console.log('命令行參數:', process.argv);
// 監聽進程退出事件
process.on('exit', (code) => {console.log('進程即將退出，退出碼:', code);
});
// 監聽未捕獲的異常
process.on('uncaughtException', (err) => {console.error('未捕獲的異常:', err.message);console.error(err.stack);
});

通過process模塊，開發者可以更好地管理和監控Node.js進程的運行狀態，處理異常情況，確保應用程序的穩定性。

十、timers模塊：定時器功能

timers模塊封裝了setTimeout、setInterval等定時器功能，用于在指定時間后執行代碼或按固定間隔重復執行代碼。

定時器使用示例

// 使用setTimeout在2秒后執行回調
setTimeout(() => {console.log('2秒已過');
}, 2000);
// 使用setInterval每1秒執行一次回調
const intervalId = setInterval(() => {console.log('1秒過去了');
}, 1000);
// 5秒后清除定時器
setTimeout(() => {clearInterval(intervalId);console.log('定時器已清除');
}, 5000);

在實現輪詢任務、延遲執行操作等場景中，timers模塊的定時器功能發揮著重要作用。

十一、url模塊：URL解析與處理

url模塊用于解析和格式化URL。在處理HTTP請求、構建網絡請求等涉及URL操作的場景中，它是不可或缺的工具。

URL解析示例

const url = require('url');
const myUrl = url.parse('https://user:pass@www.example.com:8080/path/to/myfile.html?query=string#hash');
console.log('協議:', myUrl.protocol);
console.log('用戶名:', myUrl.auth.split(':')[0]);
console.log('密碼:', myUrl.auth.split(':')[1]);
console.log('主機名:', myUrl.hostname);
console.log('端口:', myUrl.port);
console.log('路徑名:', myUrl.pathname);
console.log('查詢字符串:', myUrl.query);
console.log('哈希值:', myUrl.hash);

在Node.js v10及更高版本中，官方還推薦使用全局的URL構造函數來處理和解析URL，它提供了更豐富的功能和更便捷的操作方式。例如：

const { URL } = require('url');
const myUrlString = 'https://user:pass@www.example.com:8080/path/to/myfile.html?query=string#hash';
const myUrl = new URL(myUrlString);
console.log('協議:', myUrl.protocol);
console.log('用戶名:', myUrl.username);
console.log('密碼:', myUrl.password);
console.log('主機名:', myUrl.hostname);
console.log('端口:', myUrl.port);
console.log('路徑名:', myUrl.pathname);
console.log('查詢字符串:', myUrl.search);
console.log('哈希值:', myUrl.hash);
// 獲取查詢參數對象
console.log('解析后的查詢參數:', myUrl.searchParams);
// 也可以直接通過searchParams獲取或設置查詢參數
console.log('查詢參數"query"的值:', myUrl.searchParams.get('query'));
myUrl.searchParams.set('newParam', 'newValue');
console.log('更新后的URL:', myUrl.href);

Node.js的內置模塊遠不止上述這些，若想探索更多內置模塊及其詳細用法，可訪問Node.js官方文檔：Node.js官方文檔 - 內置模塊。熟練掌握這些內置模塊的使用，能夠讓我們在開發過程中事半功倍，打造出更加高效、穩定的應用程序。希望通過本文的介紹，你能對Node.js內置模塊有更深入的了解和應用。