谈谈 Node.js 中的文件系统（fs）模块，如何进行文件读写操作？

时间：2025-03-02 07:29:14

Node.js 文件系统（fs）模块深度解析与实践指南

一、模块基础与核心能力

Node.js 的 fs 模块提供了完整的文件系统操作能力，涵盖 50+ 个方法，主要分为以下类型：

  1. 文件读写：基础 CRUD 操作
  2. 目录操作：创建/删除/遍历目录
  3. 文件监控：watch/watchFile 方法
  4. 文件信息：stat/access 等方法
  5. 流式处理：createReadStream/createWriteStream
// 基础引入方式
const fs = require('fs');

// 推荐使用 Promise 版本
const fsp = require('fs').promises;

二、文件读写核心方法对比

方法类型 同步方法 异步回调 Promise 版本
文件读取 readFileSync readFile promises.readFile
文件写入 writeFileSync writeFile promises.writeFile
追加写入 appendFileSync appendFile promises.appendFile
流式读取 无 createReadStream 无
流式写入 无 createWriteStream 无

三、基础文件操作实践

1. 同步方式（慎用）
// 文件读取
try {
    const data = fs.readFileSync('config.json', 'utf8');
    console.log('配置文件内容:', data);
} catch (err) {
    console.error('读取配置文件失败:', err);
}

// 文件写入
try {
    fs.writeFileSync('log.txt', `${new Date()} 系统启动\n`, { flag: 'a' });
} catch (err) {
    console.error('日志写入失败:', err);
}
2. 异步回调方式
// 读取后写入的链式操作
fs.readFile('source.txt', 'utf8', (err, data) => {
    if (err) return console.error('读取失败:', err);
    
    fs.writeFile('dest.txt', data.toUpperCase(), err => {
        err ? console.error('写入失败:', err) 
            : console.log('文件转换完成');
    });
});
3. Promise 方式（推荐）
// 使用 async/await 处理
async function processFile() {
    try {
        const content = await fsp.readFile('template.html', 'utf8');
        const processed = content.replace('{{title}}', '首页');
        await fsp.writeFile('dist/index.html', processed);
        console.log('HTML 生成完成');
    } catch (err) {
        console.error('文件处理失败:', err);
    }
}

// 并行处理多个文件
async function batchProcess() {
    try {
        const [a, b] = await Promise.all([
            fsp.readFile('a.txt'),
            fsp.readFile('b.txt')
        ]);
        await fsp.writeFile('combined.txt', Buffer.concat([a, b]));
    } catch (err) {
        console.error('批量处理失败:', err);
    }
}

四、高级文件操作技巧

1. 流式处理大文件
// 高效的大文件复制
function copyLargeFile(source, target) {
    return new Promise((resolve, reject) => {
        const rs = fs.createReadStream(source);
        const ws = fs.createWriteStream(target);
        
        rs.on('error', reject)
          .pipe(ws)
          .on('finish', resolve)
          .on('error', reject);
    });
}

// 使用示例
copyLargeFile('4k-video.mp4', 'copy.mp4')
    .then(() => console.log('大文件复制完成'))
    .catch(console.error);
2. 文件监控实践
// 监控配置文件变化
const watcher = fs.watch('config.ini', (eventType, filename) => {
    if (eventType === 'change') {
        console.log(`配置文件 ${filename} 被修改`);
        // 重新加载配置
        loadConfig();
    }
});

// 错误处理
watcher.on('error', err => {
    console.error('文件监控异常:', err);
});
3. 精准控制文件操作
// 使用文件描述符
async function writeWithDescriptor() {
    let fd;
    try {
        // 打开文件获取描述符
        fd = await fsp.open('data.log', 'a');
        
        // 精准写入位置
        await fsp.write(fd, Buffer.from('新日志\n'), 0, 'utf8');
        
        // 获取文件状态
        const stats = await fsp.fstat(fd);
        console.log('当前文件大小:', stats.size);
    } finally {
        if (fd) await fd.close();
    }
}

五、实战建议与避坑指南

1. 路径处理规范
// 使用 path 模块处理路径
const path = require('path');

// 正确做法
const fullPath = path.join(__dirname, 'data', 'file.txt');

// 危险做法（路径拼接问题）
const badPath = './data/' + fileName;
2. 错误处理要点
// 典型的错误处理反模式
fs.readFile('data.txt', (err, data) => {
    if (err) throw err; // 错误会直接导致进程崩溃
    // ...处理逻辑
});

// 正确的错误处理方式
fs.readFile('data.txt', (err, data) => {
    if (err) {
        console.error('读取失败:', err);
        // 根据错误类型处理
        if (err.code === 'ENOENT') {
            return createDefaultFile();
        }
        return;
    }
    // ...正常逻辑
});
3. 性能优化建议
// 批量写入优化
async function writeLogs(messages) {
    const fd = await fsp.open('app.log', 'a');
    try {
        // 合并写入减少IO次数
        const buffer = Buffer.from(messages.join('\n') + '\n');
        await fsp.write(fd, buffer);
    } finally {
        await fd.close();
    }
}

六、企业级开发建议

  1. ​环境区分处理 
// 开发环境使用内存文件系统加速测试
if (process.env.NODE_ENV === 'test') {
    const { vol } = require('memfs');
    module.exports = vol;
} else {
    module.exports = require('fs');
}
  1. ​增强模块选择 
// 使用 fs-extra 扩展功能
const fse = require('fs-extra');

// 目录复制示例
fse.copy('/source', '/dest')
    .then(() => console.log('目录复制成功'))
    .catch(err => console.error('复制失败:', err));
  1. ​文件锁机制 
// 使用 proper-lockfile 处理并发
const lockfile = require('proper-lockfile');

async function safeWrite() {
    const release = await lockfile.lock('data.json');
    try {
        await fsp.writeFile('data.json', newData);
    } finally {
        await release();
    }
}

七、典型问题排查指南

  1. ​EMFILE 错误处理 
// 使用 graceful-fs 解决文件描述符耗尽问题
const gracefulFs = require('graceful-fs');
gracefulFs.gracefulify(fs);
  1. ​内存溢出分析 
// 错误的大文件处理方式
app.get('/bigfile', async (req, res) => {
    const data = await fsp.readFile('huge-file.zip'); // 可能造成内存溢出
    res.send(data);
});

// 正确方式使用流处理
app.get('/bigfile', (req, res) => {
    const rs = fs.createReadStream('huge-file.zip');
    rs.pipe(res);
});
  1. ​权限问题处理 
// 检查文件权限
async function checkPermissions() {
    try {
        await fsp.access('config.xml', fs.constants.R_OK | fs.constants.W_OK);
    } catch (err) {
        if (err.code === 'EACCES') {
            console.error('文件权限不足');
            // 尝试修复权限
            await fsp.chmod('config.xml', 0o644);
        }
    }
}

八、总结与最佳实践

  1. ​方法选择策略
  • 常规操作：优先使用 fs.promises 方法
  • 配置加载：可使用同步方法（仅在启动阶段）
  • 大文件处理：必须使用流式操作
  • 批量操作：结合 Promise.all 和适当并发控制
  1. ​性能优化关键点
  • 减少不必要的文件操作
  • 合并小文件写入
  • 使用内存文件系统进行测试
  • 合理设置缓冲区大小（highWaterMark）
  1. ​安全注意事项
  • 验证用户输入的文件路径
  • 防止目录遍历攻击
  • 文件操作后及时关闭描述符
  • 敏感文件设置适当权限

通过合理选择文件操作方法，结合错误处理和性能优化策略，可以有效构建健壮的Node.js文件操作模块。记住：文件操作无小事，特别是在生产环境中，务必做好日志记录、权限控制和异常监控。

相关文章