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内置模块有更深入的了解和应用。