Node.js fs.writeFileSync 同步写入文件详解

结果与准备

writeFileSync 是 fs.writeFile 的同步版本。其核心结果是：指定内容被写入目标文件，若无权限或路径无效则抛出异常。在使用前必须通过 require('fs') 引入模块。

具体操作方法

第1步：调用语法

进入 Node.js REPL 或脚本环境，调用该方法的完整签名如下：

fs.writeFileSync(filename, data, [options])

其中 filename 为文件路径（String），data 为写入内容（String 或 Buffer），options 为可选配置对象。

第2步：设置编码与权限参数

通过 options 对象可以精细控制写入行为，主要包含以下关键参数：

• encoding: 默认 'utf8'。当 data 为 Buffer 时，此参数通常忽略。建议明确指定以避免乱码。
• mode: 文件读写权限，默认值为 438（即八进制的 0666），仅在文件创建时使用。
• flag: 打开文件的模式，默认值 'w'，表示以写入模式打开文件。若文件存在且未指定 'a' (append)，则会覆盖原内容。

注意：旧版源码逻辑中可能涉及 util.isString 等内部判断，现代 Node.js 开发中直接传递标准 Object 即可。

第3步：执行写入操作

以下是两种常见的使用场景示例，分别对应纯文本写入和无需显式定义复杂选项的简单场景：

示例1：基础字符串写入

const fs = require('fs');
// 将 'Hello Node' 写入 message.txt，若文件不存在则创建，存在则覆盖
fs.writeFileSync('message.txt', 'Hello Node');

示例2：指定编码的写入（推荐实践）

const fs = require('fs');
const content = '中文内容测试';
try {
    // 显式声明 utf8 编码以确保兼容性
    fs.writeFileSync('output.txt', content, { encoding: 'utf8', flag: 'w' });
    console.log('文件写入成功');
} catch (err) {
    console.error('写入失败:', err.message);
}

风险提示与排错

由于采用同步模式，该方法会在 IO 操作期间阻塞主线程。如果在高并发服务器应用中频繁调用，会导致请求响应延迟增加，建议对性能敏感的场景改用异步的 fs.writeFile 或 fs.promises.writeFile。

常见错误包括：
- 传入非法 flag 导致 EISDIR 错误（试图向目录写入）；
- 权限不足导致 EACCES 异常；
- 路径中包含不存在的中间目录时需先创建父目录。

以上就是 Node.js 中 fs.writeFileSync 同步写入文件方法的详细内容，更多关于 Node.js 文件系统操作的资料请关注本站其它相关文章！