Node.js 中的文件系统(fs)模块详解与代码示例

Node.js 中的文件系统(fs)模块详解与代码示例

Node.js 的 fs 模块提供了与文件系统交互的能力,包括文件的读写、目录的管理等。以下是 fs 模块中一些常用方法的详细解释和代码示例:

1. 异步读取文件内容

作用:异步读取文件的全部内容,并在回调函数中处理结果。

javascript 复制代码
const fs = require('fs');

// 异步读取文件内容
fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(data); // 输出文件内容
});

2. 同步读取文件内容

作用:同步读取文件的全部内容,阻塞其他操作直到读取完成。

javascript 复制代码
const fs = require('fs');

try {
  // 同步读取文件内容
  const data = fs.readFileSync('example.txt', 'utf8');
  console.log(data); // 输出文件内容
} catch (err) {
  console.error(err);
}

3. 异步写入文件内容

作用:异步写入内容到文件,如果文件不存在则创建。

javascript 复制代码
const fs = require('fs');

// 异步写入文件内容
fs.writeFile('example.txt', 'Hello, World!', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('File written successfully'); // 文件写入成功
});

4. 同步写入文件内容

作用:同步写入内容到文件,如果文件不存在则创建,阻塞其他操作直到写入完成。

javascript 复制代码
const fs = require('fs');

try {
  // 同步写入文件内容
  fs.writeFileSync('example.txt', 'Hello, World!');
  console.log('File written successfully'); // 文件写入成功
} catch (err) {
  console.error(err);
}

5. 创建目录

作用 :异步创建一个目录,recursive 选项允许递归创建多级目录。

javascript 复制代码
const fs = require('fs');

// 异步创建目录
fs.mkdir('exampleDir', { recursive: true }, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('Directory created successfully'); // 目录创建成功
});

6. 删除目录

作用 :异步删除一个目录,recursive 选项允许递归删除目录及其内容。

javascript 复制代码
const fs = require('fs');

// 异步删除目录
fs.rmdir('exampleDir', { recursive: true }, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('Directory deleted successfully'); // 目录删除成功
});

7. 读取目录内容

作用:异步读取目录中的文件和子目录列表。

javascript 复制代码
const fs = require('fs');

// 异步读取目录内容
fs.readdir('exampleDir', (err, files) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(files); // 输出目录内容列表
});

8. 获取文件状态

作用:异步获取文件的状态信息,如大小、创建时间等。

javascript 复制代码
const fs = require('fs');

// 异步获取文件状态
fs.stat('example.txt', (err, stats) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(stats.isDirectory() ? 'Directory' : 'File'); // 判断是文件还是目录
});

9. 创建可读流

作用:创建一个可读流来异步读取文件内容。

javascript 复制代码
const fs = require('fs');
const readable = fs.createReadStream('example.txt');

readable.on('data', (chunk) => {
  console.log(chunk); // 输出读取的数据块
});

readable.on('end', () => {
  console.log('Reached end of file'); // 读取到文件末尾
});

readable.on('error', (err) => {
  console.error(err); // 错误处理
});

10. 创建可写流

作用:创建一个可写流来异步写入文件内容。

javascript 复制代码
const fs = require('fs');
const writable = fs.createWriteStream('example.txt');

writable.write('Hello, World!', (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log('File written successfully'); // 文件写入成功
});

writable.end(); // 标记流结束

这些示例展示了 fs 模块的基本用法,包括异步和同步操作,以及流的使用。在实际应用中,应该根据需要选择合适的方法,并妥善处理错误和异常。

相关推荐
子兮曰13 小时前
jev-ultrafast 深度解析:7 秒订机票的浏览器 Agent 是如何炼成的
前端·后端·agent
子兮曰13 小时前
Jev 爆发一周:7 秒 Agent 背后的 System One 生态与三场争议
前端·后端·ai编程
爱勇宝14 小时前
ZCode 开源 24 小时:一份没有历史的账本,回答不了"有没有偷代码"
前端·后端·chatglm (智谱)
胡写代码14 小时前
别再前后端各写一套表单校验了
java·后端
大勇前进15 小时前
原生 PHP 还是 Laravel?小项目到底要不要上框架
后端
yuzhi_liu15 小时前
我用 LangGraph4j 实现 Multi-Agent Supervisor
后端
alsmile15 小时前
Node-RED 之外,国产规则引擎的新方案:基于标准语法,Go 先行实现
后端·开源·go
大白8015 小时前
PHP 内存溢出排查思路:看懂报错日志,精准定位问题
后端
二月龙15 小时前
PHP 接口返回统一响应封装,让前后端对接更省心
后端
盖伦发发16 小时前
软件工程SOLID 五大设计原则
后端·软件工程