Node.js 中的 fs 模块如何使用？

fs 模块是 Node.js 的核心模块之一，用于执行文件系统操作。它允许你读取、写入、更新和删除文件，以及执行其他与文件相关的任务。在构建服务器应用、文件处理工具、日志记录、配置文件管理等各种场景中，fs 模块都发挥着重要作用。

用 Apifox，节省研发团队的每一分钟

Node.js 中的 fs 模块如何使用？

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

fs 模块是 Node.js 的核心模块之一，用于执行文件系统操作。它允许你读取、写入、更新和删除文件，以及执行其他与文件相关的任务。在构建服务器应用、文件处理工具、日志记录、配置文件管理等各种场景中，fs 模块都发挥着重要作用。

fs 模块使用场景

在什么情况下使用 fs 模块是有意义的呢？以下是一些常见的使用场景：

  1. 文件读取和写入：你可以使用 fs 模块来读取文件内容，将其写入其他文件，或在文件中追加数据。这对于日志记录、数据导入和导出以及配置文件的读取和更新非常有用。
  2. 目录操作：fs 模块还可以用于创建、删除和遍历目录。这对于文件管理和自动化任务非常重要。
  3. 文件属性和状态：你可以获取文件的属性，如大小、创建日期、修改日期等，以及检查文件是否存在、是否可读或可写。
  4. 流操作：fs 模块允许你创建文件读取和写入流，这在处理大型文件时非常有用，以避免一次性加载整个文件到内存中。

fs 模块基本概念

在使用 fs 模块之前，让我们了解一些基本概念：

  • 同步 vs。 异步：fs 模块提供了同步和异步方法。同步方法会阻塞程序的执行，直到文件操作完成，而异步方法不会。一般来说，推荐使用异步方法以避免阻塞。
  • 文件路径：文件路径可以是绝对路径（从根目录开始的完整路径）或相对路径（相对于当前工作目录的路径）。
  • Buffer 对象：在 fs 模块中，数据通常以 Buffer 对象的形式进行读取和写入。Buffer 是 Node.js 中用于处理二进制数据的数据类型。

fs 模块常用方法

接下来，让我们列出一些常用的 fs 模块方法，并提供示例代码。

1. 读取文件

const fs = require('fs');

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

2. 写入文件

const fs = require('fs');

const content = 'Hello, Node.js!';
fs.writeFile('output.txt', content, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('File written successfully.');
});

3. 创建目录

const fs = require('fs');

fs.mkdir('myfolder', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('Directory created successfully.');
});

4. 读取目录内容

const fs = require('fs');

fs.readdir('myfolder', (err, files) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('Files in the directory:', files);
});

5. 获取文件信息

const fs = require('fs');

fs.stat('example.txt', (err, stats) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('File size:', stats.size, 'bytes');
});

6. 删除文件

const fs = require('fs');

fs.unlink('fileToDelete.txt', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('File deleted successfully.');
});

实践案例

下面是一个详细的案例，展示如何使用 Node.js 的fs模块创建一个简单的文件浏览器应用，可以列出指定目录中的所有文件和子目录。

步骤 1: 初始化项目

首先，创建一个新的文件夹并在其中打开终端，然后执行以下命令来初始化一个新的 Node.js 项目：

mkdir file-browser
cd file-browser
npm init -y

步骤 2: 安装依赖

在项目目录下，使用以下命令安装express和fs模块：

npm install express fs

步骤 3: 创建服务器

创建一个名为server.js的文件，并添加以下代码来创建一个简单的 Node.js 服务器：

const express = require('express');
const fs = require('fs');
const app = express();
const port = 3000;

app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

步骤 4: 创建路由

在server.js中添加以下路由来处理文件浏览请求：

app.get('/browse', (req, res) => {
  const dirPath = __dirname; // 当前文件所在目录
  fs.readdir(dirPath, (err, files) => {
    if (err) {
      return res.status(500).send('Error reading directory.');
    }
    const fileList = files.map((file) => {
      const isDirectory = fs.statSync(file).isDirectory();
      return {
        name: file,
        isDirectory,
      };
    });
    res.json(fileList);
  });
});

这个路由会返回当前目录中的文件和子目录的列表。

步骤 5: 创建前端界面

在项目目录下创建一个名为public的文件夹，然后在其中创建一个 HTML 文件（例如，index.html），并添加以下内容：

<!DOCTYPE html>
<html>
<head>
  <title>File Browser</title>
</head>
<body>
  <h1>File Browser</h1>
  <ul id="file-list"></ul>
  <script>
    fetch('/browse')
      .then(response => response.json())
      .then(data => {
        const fileList = document.getElementById('file-list');
        data.forEach(item => {
          const listItem = document.createElement('li');
          listItem.textContent = item.name + (item.isDirectory ? ' (Directory)' : '');
          fileList.appendChild(listItem);
        });
      })
      .catch(error => {
        console.error('Error fetching data:', error);
      });
  </script>
</body>
</html>

这个 HTML 文件包含一个简单的列表，使用 JavaScript 通过 XHR（或者使用fetch API）来获取服务器返回的文件和目录列表。

步骤 6: 启动服务器

最后，返回到终端，并运行以下命令来启动服务器：

node server.js

打开浏览器，访问http://localhost:3000，你将看到一个文件浏览器应用，列出了当前目录中的文件和子目录，如下图所示：

Node.js 中的 fs 模块读取目录

提示、技巧和注意事项

  • 对于文件操作，始终使用异步方法以避免阻塞应用程序的执行。
  • 谨慎处理文件路径，确保路径的正确性，以避免不必要的错误。
  • 在进行文件写入操作时，要小心不要意外覆盖已有的文件。
  • 使用异常处理来捕获可能的错误，例如文件不存在或无法访问。

通过 Apifox 管理后端接口

如果你是 Node.js 开发者，你经常需要与 API 打交道，确保你的应用程序能够正常工作。这时，一个强大的接口测试工具就会派上用场。


Apifox 是一个比 Postman 更强大的接口测试工具，Apifox = Postman + Swagger + Mock + JMeter。它支持调试 http（s）、WebSocket、Socket、gRPC、Dubbo 等多种协议的接口，这使得它成为了一个非常全面的接口测试工具。此外，Apifox 还集成了 IDEA 插件，使得与 IDE 的协同工作变得更加顺畅。这个图形化界面极大地方便了项目的上线效率，让开发者能够更加轻松地管理、测试接口。强烈推荐去下载体验！

立即体验 Apifox
Apifox


总结

Node.js 中的 fs 模块是执行文件系统操作的关键工具，它允许你处理文件和目录、读取和写入文件内容，以及执行其他与文件相关的任务。通过本文，你学习了基本概念、常见用途、常用方法以及一个实际案例，希望这些信息能帮助你更好地利用 fs 模块来满足你的项目需求。

知识扩展：


参考链接：

  • Node.js fs 模块官方文档：https://nodejs.org/api/fs.html
  • Node.js 文件系统操作指南：https://nodejs.dev/learn/the-nodejs-fs-module
Node.js
相关推荐