使用node.js的fs模块管理文件和目录

在Node.js开发中，文件和目录的管理是一项基础且重要的任务。Node.js的fs（File System）模块为我们提供了丰富的API，用于对文件和目录进行创建、读取、更新和删除等操作。本文将详细介绍如何使用Node.js的fs模块来管理文件和目录。

fs模块简介

fs模块是Node.js的核心模块之一，它提供了与文件系统进行交互的能力。该模块有同步和异步两种操作方式。同步操作会阻塞程序的执行，直到操作完成；而异步操作则不会阻塞程序，它会在操作完成后通过回调函数返回结果。在实际开发中，为了避免阻塞事件循环，推荐使用异步操作。

读取文件

使用fs模块读取文件是常见的操作之一。我们可以使用异步的fs.readFile方法来读取文件内容。以下是一个简单的示例：

const fs = require('fs');

fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(data);
});

在上述代码中，fs.readFile方法接受三个参数：文件路径、编码格式（这里使用'utf8'表示以UTF-8编码读取文本文件）和回调函数。回调函数包含两个参数：err和data。如果读取过程中出现错误，err会包含错误信息；如果读取成功，data会包含文件的内容。

如果需要使用同步方式读取文件，可以使用fs.readFileSync方法：

const fs = require('fs');

try {
  const data = fs.readFileSync('example.txt', 'utf8');
  console.log(data);
} catch (err) {
  console.error(err);
}

同步方法会抛出异常，因此需要使用try...catch语句来捕获可能的错误。

写入文件

使用fs模块写入文件也非常简单。可以使用fs.writeFile方法来异步写入文件。以下是一个示例：

const fs = require('fs');

const content = '这是要写入文件的内容。';

fs.writeFile('newFile.txt', content, 'utf8', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('文件写入成功');
});

fs.writeFile方法接受四个参数：文件路径、要写入的内容、编码格式和回调函数。如果文件不存在，该方法会创建一个新文件；如果文件已经存在，会覆盖原文件的内容。

如果需要以追加的方式写入文件，可以使用fs.appendFile方法：

const fs = require('fs');

const newContent = '追加的内容。';

fs.appendFile('newFile.txt', newContent, 'utf8', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('内容追加成功');
});

同步写入文件可以使用fs.writeFileSync和fs.appendFileSync方法，使用方式与异步方法类似，只是不需要回调函数。

创建目录

使用fs模块创建目录可以使用fs.mkdir方法。以下是一个示例：

const fs = require('fs');

fs.mkdir('newDirectory', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('目录创建成功');
});

fs.mkdir方法接受两个参数：目录路径和回调函数。如果目录已经存在，会抛出错误。如果需要递归创建多级目录，可以传递一个选项对象，设置recursive属性为true：

const fs = require('fs');

fs.mkdir('parent/child', { recursive: true }, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('多级目录创建成功');
});

同步创建目录可以使用fs.mkdirSync方法。

读取目录

使用fs模块读取目录可以使用fs.readdir方法。以下是一个示例：

const fs = require('fs');

fs.readdir('newDirectory', (err, files) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('目录中的文件和子目录：', files);
});

fs.readdir方法接受两个参数：目录路径和回调函数。回调函数的第二个参数是一个数组，包含目录中所有文件和子目录的名称。

同步读取目录可以使用fs.readdirSync方法。

删除文件和目录

删除文件可以使用fs.unlink方法。以下是一个示例：

const fs = require('fs');

fs.unlink('newFile.txt', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('文件删除成功');
});

删除目录可以使用fs.rmdir方法。需要注意的是，该方法只能删除空目录。如果要删除非空目录，可以使用第三方模块如rimraf。以下是删除空目录的示例：

const fs = require('fs');

fs.rmdir('newDirectory', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('目录删除成功');
});

同步删除文件和目录可以使用fs.unlinkSync和fs.rmdirSync方法。

文件和目录的元信息

使用fs模块可以获取文件和目录的元信息，如文件大小、创建时间、修改时间等。可以使用fs.stat方法来获取这些信息。以下是一个示例：

const fs = require('fs');

fs.stat('example.txt', (err, stats) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('文件大小：', stats.size);
  console.log('创建时间：', stats.birthtime);
  console.log('修改时间：', stats.mtime);
});

fs.stat方法接受两个参数：文件或目录路径和回调函数。回调函数的第二个参数是一个fs.Stats对象，包含了文件或目录的各种元信息。

同步获取元信息可以使用fs.statSync方法。

文件重命名和移动

使用fs模块可以对文件和目录进行重命名和移动操作。可以使用fs.rename方法来实现。以下是一个示例：

const fs = require('fs');

fs.rename('oldName.txt', 'newName.txt', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('文件重命名成功');
});

如果将文件移动到不同的目录，也可以使用fs.rename方法。例如：

const fs = require('fs');

fs.rename('file.txt', 'newDirectory/file.txt', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('文件移动成功');
});

同步重命名和移动可以使用fs.renameSync方法。

综上所述，Node.js的fs模块提供了丰富的功能来管理文件和目录。在实际开发中，我们可以根据具体需求选择合适的方法来完成文件和目录的操作。同时，要注意异步操作和同步操作的区别，尽量使用异步操作以提高程序的性能和响应能力。

使用node.js的fs模块管理文件和目录

服务指南

帮助中心