fs 文件系统模块:文件与目录的增删改查
🎯 引言
学完这篇文章,你能使用文件 API 创建、读取、修改和删除练习文件,并列出目录内容。
🧱 先在练习目录操作
node:fs 提供本机文件与目录的操作 API。本篇先用同步方法,名称末尾的 Sync 表示操作完成后才继续下一步,适合观察顺序;持续接收请求的程序通常使用下一篇介绍的异步方式。
创建一个空的练习文件夹,将代码保存为 files.mjs。先导入模块:
import fs from 'node:fs'
下面按顺序逐段追加到文件,再运行 node files.mjs。每段只观察一种操作;相对路径都以启动命令的当前目录为起点。
node-fs-demo 目录。📁 创建目录
写文件前,先准备父目录:
fs.mkdirSync('node-fs-demo', { recursive: true })
执行后,当前目录出现 node-fs-demo。recursive: true 允许创建缺少的父级目录,也允许目标目录已经存在,适合重复执行练习。
创建成功不会自动输出日志,可以在文件列表中确认结果;失败时会抛出异常。
📝 写入文件:默认覆盖原内容
fs.writeFileSync('node-fs-demo/note.txt', 'hello', 'utf8')
三个参数分别是目标路径、要保存的内容和编码。编码是文字与字节之间的转换规则,utf8 表示按 UTF-8 保存文字。
执行后,note.txt 内容为 hello;文件不存在就创建,已存在则覆盖。方法成功返回 undefined,不会返回文件内容。它不会替你创建父目录,因此前一步很重要。
📖 读取文件:取得内容字符串
const text = fs.readFileSync('node-fs-demo/note.txt', 'utf8')
console.log(text)
输出 hello,text 是字符串。这里 utf8 表示按什么编码把文件里的字节还原成文字,应与保存时的编码匹配。
不指定编码时,返回的是 Buffer,也就是保存原始字节的对象;文本处理通常明确写出编码,图片等文件则不要随意当作文字读取。
➕ 追加内容:保留已有文字
fs.appendFileSync('node-fs-demo/note.txt', '\nNode.js', 'utf8')
现在文件内容变成两行:hello 和 Node.js。方法成功返回 undefined,执行后可以重新运行读取语句确认内容。
需要整份替换时用 writeFileSync,需要在末尾继续记录时用 appendFileSync。反复单独执行追加语句会反复增加内容。
🔍 查看目录和文件信息
先列出目录中的名称:
console.log(fs.readdirSync('node-fs-demo'))
如果只有练习文件,输出 ['note.txt']。返回的是名称数组,不是各文件内容;目录里有多个项目时,不要依赖某种固定排序。
需要判断路径指向文件还是目录时,再查询文件信息:
const info = fs.statSync('node-fs-demo/note.txt')
console.log(info.isFile())
输出 true。statSync 返回描述文件状态的对象;isFile() 判断是否为普通文件,isDirectory() 判断是否为目录。该对象的 size 是字节数,这个例子写入后的文件为 13 字节。
🏷️ renameSync:改名或移动文件
fs.renameSync('node-fs-demo/note.txt', 'node-fs-demo/message.txt')
两个参数分别是原路径和新路径。成功后内容不变,文件名变成 message.txt,原来的 note.txt 不再存在;方法返回 undefined。
同一文件系统内也可通过不同目录路径移动文件,但目标父目录必须存在。跨文件系统移动可能失败,不能把它当作通用复制工具。
🗑️ 删除文件,再删除空目录
不再需要练习文件时,用 unlinkSync 删除它:
fs.unlinkSync('node-fs-demo/message.txt')
成功后文件消失,返回 undefined。再次删除同一路径会因为文件已不存在而报错。
目录已空时,用 rmdirSync 删除目录:
fs.rmdirSync('node-fs-demo')
成功后整个练习目录消失。如果里面还有文件,这个调用会失败,而不会递归删除所有内容。
🪤 操作失败时看错误码
文件不存在常见错误码为 ENOENT,权限不足常见为 EACCES。同步调用可以在执行位置使用 try/catch:
try {
fs.readFileSync('missing.txt', 'utf8')
} catch (error) {
console.log(error.code)
}
确保没有 missing.txt 时,输出 ENOENT。应根据具体错误决定提示或停止,不要把所有失败都理解为文件不存在。
先检查存在再读取,也无法保证两步之间文件不被其他程序删除,因此仍需处理操作本身的失败。
❓ 知识问答
Q1:写文件会自动创建目录吗?
不会,先创建需要的父目录。
Q2:空字符串代表文件读取失败吗?
不一定,空文件本来就会读出空字符串,失败则通过异常或错误结果报告。
Q3:目录删除失败怎么办?
先确认目录是否为空、路径是否正确,以及当前用户是否有权限。
🧪 小练习
在练习目录创建 hello.txt,读取后改名为 welcome.txt,列出目录确认结果。
// 请在这里编写代码
🎉 现在可以用自己的例子验证这些用法啦!
