当前位置：首页 > article >正文

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

article 2024/12/4 16:02:49

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

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

1. 异步读取文件内容

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

const fs = require('fs');

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

2. 同步读取文件内容

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

const fs = require('fs');

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

3. 异步写入文件内容

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

const fs = require('fs');

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

4. 同步写入文件内容

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

const fs = require('fs');

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

5. 创建目录

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

const fs = require('fs');

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

6. 删除目录

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

const fs = require('fs');

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

7. 读取目录内容

const fs = require('fs');

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

8. 获取文件状态

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

const fs = require('fs');

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

9. 创建可读流

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

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. 创建可写流

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

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(); // 标记流结束