node.js怎么使用fs

Node.js 使用 fs 模块进行文件操作的完整指南

使用 Node.js 的 fs 模块进行文件操作非常简单、强大、灵活。 在 Node.js 中，fs 模块提供了与文件系统交互的 API，能够实现文件的读取、写入、删除、重命名等操作。本文将详细介绍如何使用 Node.js 的 fs 模块来进行文件操作，并提供一些实用的示例代码。

一、fs 模块简介

Node.js 的 fs 模块提供了一系列文件系统相关的操作方法。通过它，你可以同步或异步地执行各种文件操作。fs 模块是 Node.js 的核心模块之一，不需要额外安装，直接通过 require('fs') 即可使用。

1、异步和同步方法

fs 模块的大多数方法都有异步和同步两种形式。异步方法通常是 Node.js 的推荐方式，因为它们不会阻塞事件循环，从而提高了应用程序的性能和响应速度。异步方法通常接受一个回调函数作为参数，而同步方法会立即返回结果或者抛出异常。

const fs = require('fs');
// 异步读取文件
fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(data);
});
// 同步读取文件
try {
  const data = fs.readFileSync('example.txt', 'utf8');
  console.log(data);
} catch (err) {
  console.error(err);
}

二、文件读取操作

1、readFile 和 readFileSync

fs.readFile 和 fs.readFileSync 是最常用的文件读取方法。readFile 是异步方法，而 readFileSync 是同步方法。

// 异步读取文件
fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) throw err;
  console.log(data);
});
// 同步读取文件
const data = fs.readFileSync('example.txt', 'utf8');
console.log(data);

2、读取文件的选项

在读取文件时，你可以指定一些选项，例如编码、标志等。最常用的选项是 encoding，它指定了文件内容的字符编码。

fs.readFile('example.txt', { encoding: 'utf8', flag: 'r' }, (err, data) => {
  if (err) throw err;
  console.log(data);
});

三、文件写入操作

1、writeFile 和 writeFileSync

fs.writeFile 和 fs.writeFileSync 用于将数据写入文件。如果文件不存在，它们会创建文件；如果文件已存在，它们会覆盖文件内容。

// 异步写入文件
fs.writeFile('example.txt', 'Hello, Node.js!', (err) => {
  if (err) throw err;
  console.log('The file has been saved!');
});
// 同步写入文件
fs.writeFileSync('example.txt', 'Hello, Node.js!');
console.log('The file has been saved!');

2、追加内容

如果你不想覆盖文件内容，可以使用 fs.appendFile 和 fs.appendFileSync 方法。

// 异步追加内容
fs.appendFile('example.txt', 'nAppended content!', (err) => {
  if (err) throw err;
  console.log('The content has been appended!');
});
// 同步追加内容
fs.appendFileSync('example.txt', 'nAppended content!');
console.log('The content has been appended!');

四、文件删除操作

1、unlink 和 unlinkSync

fs.unlink 和 fs.unlinkSync 用于删除文件。

// 异步删除文件
fs.unlink('example.txt', (err) => {
  if (err) throw err;
  console.log('The file has been deleted!');
});
// 同步删除文件
fs.unlinkSync('example.txt');
console.log('The file has been deleted!');

五、文件重命名操作

1、rename 和 renameSync

fs.rename 和 fs.renameSync 用于重命名文件或移动文件。

// 异步重命名文件
fs.rename('oldName.txt', 'newName.txt', (err) => {
  if (err) throw err;
  console.log('The file has been renamed!');
});
// 同步重命名文件
fs.renameSync('oldName.txt', 'newName.txt');
console.log('The file has been renamed!');

六、文件状态查询

1、stat 和 statSync

fs.stat 和 fs.statSync 用于获取文件的状态信息，例如文件大小、创建时间、修改时间等。

// 异步获取文件状态
fs.stat('example.txt', (err, stats) => {
  if (err) throw err;
  console.log(`File Size: ${stats.size} bytes`);
  console.log(`Created At: ${stats.birthtime}`);
  console.log(`Modified At: ${stats.mtime}`);
});
// 同步获取文件状态
const stats = fs.statSync('example.txt');
console.log(`File Size: ${stats.size} bytes`);
console.log(`Created At: ${stats.birthtime}`);
console.log(`Modified At: ${stats.mtime}`);

七、文件夹操作

1、创建文件夹

fs.mkdir 和 fs.mkdirSync 用于创建新文件夹。

// 异步创建文件夹
fs.mkdir('newFolder', { recursive: true }, (err) => {
  if (err) throw err;
  console.log('The directory has been created!');
});
// 同步创建文件夹
fs.mkdirSync('newFolder', { recursive: true });
console.log('The directory has been created!');

2、读取文件夹内容

fs.readdir 和 fs.readdirSync 用于读取文件夹的内容。

// 异步读取文件夹内容
fs.readdir('someFolder', (err, files) => {
  if (err) throw err;
  console.log(files);
});
// 同步读取文件夹内容
const files = fs.readdirSync('someFolder');
console.log(files);

3、删除文件夹

fs.rmdir 和 fs.rmdirSync 用于删除空文件夹。如果文件夹不为空，可以使用 fs.rm 和 fs.rmSync，并设置 recursive: true 选项。

// 异步删除文件夹
fs.rmdir('someFolder', (err) => {
  if (err) throw err;
  console.log('The directory has been removed!');
});
// 同步删除文件夹
fs.rmdirSync('someFolder');
console.log('The directory has been removed!');
// 异步删除非空文件夹
fs.rm('someFolder', { recursive: true, force: true }, (err) => {
  if (err) throw err;
  console.log('The directory and its contents have been removed!');
});
// 同步删除非空文件夹
fs.rmSync('someFolder', { recursive: true, force: true });
console.log('The directory and its contents have been removed!');

八、文件流操作

Node.js 的 fs 模块还提供了文件流操作的支持，可以更高效地处理大文件。

1、创建读取流

通过 fs.createReadStream 创建读取流，可以逐块读取文件内容。

const readStream = fs.createReadStream('largeFile.txt', 'utf8');
readStream.on('data', (chunk) => {
  console.log('New chunk received:', chunk);
});
readStream.on('end', () => {
  console.log('File reading completed.');
});

2、创建写入流

通过 fs.createWriteStream 创建写入流，可以逐块写入文件内容。

const writeStream = fs.createWriteStream('output.txt');
writeStream.write('Hello, ');
writeStream.write('Node.js!');
writeStream.end();
writeStream.on('finish', () => {
  console.log('File writing completed.');
});

3、管道流操作

可以通过管道流将读取流的内容直接传输到写入流。

const readStream = fs.createReadStream('source.txt');
const writeStream = fs.createWriteStream('destination.txt');
readStream.pipe(writeStream);
readStream.on('end', () => {
  console.log('File copying completed.');
});

九、文件权限操作

1、chmod 和 chmodSync

fs.chmod 和 fs.chmodSync 用于更改文件的权限。

// 异步更改文件权限
fs.chmod('example.txt', 0o775, (err) => {
  if (err) throw err;
  console.log('File permissions changed!');
});
// 同步更改文件权限
fs.chmodSync('example.txt', 0o775);
console.log('File permissions changed!');

2、chown 和 chownSync

fs.chown 和 fs.chownSync 用于更改文件的所有者。

// 异步更改文件所有者
fs.chown('example.txt', 1000, 1000, (err) => {
  if (err) throw err;
  console.log('File owner changed!');
});
// 同步更改文件所有者
fs.chownSync('example.txt', 1000, 1000);
console.log('File owner changed!');

十、文件监视

1、watch 和 watchFile

Node.js 提供了 fs.watch 和 fs.watchFile 两种方式来监视文件或文件夹的变化。

// 监视文件
fs.watch('example.txt', (eventType, filename) => {
  console.log(`File ${filename} changed! Event type: ${eventType}`);
});
// 监视文件并获取详细信息
fs.watchFile('example.txt', (curr, prev) => {
  console.log(`File changed! Current size: ${curr.size}, Previous size: ${prev.size}`);
});

结语

通过本文的详细介绍，你应该已经掌握了如何使用 Node.js 的 fs 模块来进行各种文件操作。无论是文件的读取、写入、删除、重命名，还是文件夹的操作、文件流的使用，fs 模块都提供了简单易用的 API。希望这些知识能帮助你在实际项目中更加高效地处理文件操作。如果你在项目管理过程中需要更加高效的团队协作和项目管理工具，可以考虑使用研发项目管理系统PingCode和通用项目协作软件Worktile。