Node.js 文件系统 fs 模块核心 API 详解与路径处理

Node.js 文件系统模块概述

Node.js 提供了丰富的文件系统操作 API，其中 readFile() 是最基础的读取接口。

1. 本文以读取 files 目录下的 1.txt 文件中文本内容为例，演示具体的调用方式。
2. Node.js 的运行环境由 ECMAScript 核心、全局成员以及核心 API 成员三部分组成。
3. 核心 API 成员在安装 Node.js 应用程序时，已默认集成至本地开发环境中。
4. 访问这些核心模块时，只需通过 require("核心成员名称") 即可导入并使用。

const fs = require(“fs”);

文件读取 API：fs.readFile

在 fs 核心模块中，fs.readFile 方法专门用于读取指定目录下的文件内容。

fs.readFile() 函数接收三个参数，分别定义读取行为。

1. 第一个参数指定待读取文件的绝对或相对路径。
2. 第二个参数指定文件编码格式，若未指定，默认值为 null。
3. 第三个参数为回调函数，用于处理文件读取完成后的结果。
4. 在回调函数中，第一个参数 error 为错误对象，若读取成功则为 null；第二个参数 data 为读取到的文件内容。

fs.readFile(“./files/1.txt”,function(err,data){
console.log(err); // null 如果err 为null 就证明读取成功了，没有出错
console.log(data); // <Buffer > 读取的内容数据
})

以下是调用 fs.readFile 读取文件的完整代码示例。

文件写入 API：fs.writeFile

Node.js 文件写入 API 主要使用 writeFile()，需求是向 files 目录写入一个名为 2.txt 的文档。

首先需要通过 require 导入 fs 文件操作模块。

const fs = require(“fs”);

1. 随后调用 fs.writeFile 方法执行写入操作。
2. 第一个参数为路径字符串，指定内容写入的目标文件位置。
3. 第二个参数为待写入的数据，通常指定为一个字符串。
4. 第三个参数为可选的编码格式，默认以 utf-8 写入，一般场景下可不传递此参数。
5. 第四个参数为回调函数，在文件写入完成后执行。

在回调函数中，仅有一个形参 err，用于返回错误对象，若写入成功则 err 为 null。

以下是调用 fs.writeFile 写入文件的完整代码示例。

文件追加 API：fs.appendFile

Node.js 文件追加 API 使用 appendFile()，需先导入 fs 模块。

const fs = require(“fs”);

接着调用 fs.appendFile 方法向现有文件追加内容。

1. 第一个参数指定目标文件路径，即内容将被追加到的文件。
2. 第二个参数指定要追加的具体内容，支持传递字符串。
3. 第三个参数为可选的编码格式，若省略则默认以 utf8 格式追加内容。
4. 第四个参数为回调函数，表示追加操作完成后的处理逻辑。

回调函数包含形参 err，用于返回追加失败时的错误结果。

以下是调用 fs.appendFile 追加文件的完整代码示例。

相对路径问题与解决方案

使用 fs 模块时，相对路径的处理是一个常见陷阱。

若提供相对路径，Node.js 会根据当前执行 node 命令的磁盘目录拼接文件路径，这往往导致路径错误。

例如，在特定目录下执行命令时，相对路径解析可能不符合预期。

这会导致系统抛出文件未找到的错误。

注意：上述图片中代码的路径需根据实际文件目录进行调整。

解决相对路径问题的方案如下。

在 Node.js 中，__dirname 变量表示当前文件所处的磁盘目录。

__filename 变量表示当前文件的完整路径，包含具体文件名。

通过结合 __dirname 可以构建绝对路径，避免相对路径带来的不确定性。

结论：在使用 fs 模块且需提供文件操作路径时，务必使用 __dirname 拼接路径以确保准确性。

获取文件信息与复制文件

Node.js 还提供了 fs.stat() 方法用于读取文件信息。

使用时需先引入 fs 模块。

调用 Fs.stat() 方法可获取文件的详细状态信息。

上述代码在终端执行后会打印出文件的状态日志。

Node.js 文件复制功能通过 fs.copyFile() 实现。

使用时需先引入 fs 模块。

调用 copyFile() 方法即可完成文件复制操作。

本文总结了 Node.js 文件系统操作模块 fs 的核心使用方法。

上述内容为Node.js中文件系统操作模块fs的使用详解，旨在为读者提供实用参考。若阅读过程中存在任何疑问，欢迎留言咨询，小编将尽快予以回复。同时，衷心感谢各位对本站的支持与关注！