【Node.js】内置模块FileSystem的保姆级入门讲解

news2024/10/4 6:24:21

作者：CSDN-PleaSure乐事

欢迎大家阅读我的博客希望大家喜欢

使用环境：Vscode

本文代码都经由博主PleaSure乐事实操后得出，可以放心使用。

1.FileSystem介绍

Node.js 的 fs（filesystem）模块是一个核心模块，提供了与文件系统进行交互的功能。它允许你读取、写入、删除和管理文件和目录。fs 模块提供了同步和异步两种方式来执行文件操作，使得编写者可以根据具体需求选择合适的方法。

2.FileSystem基本操作介绍

在正式进行FileSystem前，我们需要创建一个js文件，并对fs模块进行导入：

//方法一
import fs from 'fs'
//方法二
const fs = require('fs');

2.1创建目录

如果我们想要创建目录，我们仅需要使用mkdir即可，fs.promises.mkdir会进行目录创建，其中recursive是用来控制是否允许创建多级目录，若设置为true则允许创建多级目录，反之false则不能创建。

const createDir = async (path) => {
    try {
      await fs.promises.mkdir(path, { recursive: true }) // recursive: true 允许递归创建多级目录
      console.log("目录创建成功")
    } catch (err) {
      console.error(`目录创建失败: ${err}`)
    }
  }
let dir = "PleaSure/csdn/"
createDir(dir) //创建多级目录

如下图所示，我们已经成功创建了一个多级目录：

2.2写入文件

如果我们要写入文件，我们需要使用writeFile来处理，fs.promises.writeFile会进行文件写入。但是需要注意，我们最好添加path.join来处理不同电脑间路径不一致的情况，在 Windows 系统中，路径分隔符通常是反斜杠（\），而在 Unix 和类 Unix 系统（如 Linux 和 macOS）中，路径分隔符是正斜杠（/）。

const writeFile = async (filePath, content) => {
  try {
    await fs.promises.writeFile(filePath, content);
    console.log("文件写入成功");
  } catch (err) {
    console.error(`文件写入失败: ${err}`);
  }
};

// 定义目录和文件路径
let dir = "PleaSure/csdn/";
let name = "web.txt";

let filePath = path.join(dir, name); // 使用 path.join 来处理路径

// 创建目录
createDir(dir).then(() => {
  // 写入文件
  writeFile(filePath, content);
});

但是需要注意，这里的写入文件是会覆盖的！

2.3追加文件

追加文件则直接使用appendFile即可，fs.promises.appendFile会进行文件追加，内容将被写在文件最后：

const appendToFile = async (filePath, content) => {
    try {
      await fs.promises.appendFile(filePath, content);
      console.log("内容追加成功");
    } catch (err) {
      console.error(`内容追加失败: ${err}`);
    }
  };
  
  // 定义目录和文件路径
  let dir = "PleaSure/csdn/";
  let name = "web.txt";
  let filePath = path.join(dir, name); // 使用 path.join 来处理路径
  
  // 创建目录
  createDir(dir).then(() => {
    // 追加内容到文件
    appendToFile(filePath, "pleasure\n"); // 追加内容并换行
  });

2.4读取文件

如果想要读取文件，我们增加readFIle即可，fs.promises.readFile会完成文件读取，输出文件内容：

const readFile = async (filePath) => {
    try {
      const data = await fs.promises.readFile(filePath, 'utf8');
      console.log("文件内容:");
      console.log(data);
    } catch (err) {
      console.error(`文件读取失败: ${err}`);
    }
  };

2.5检查文件或目录是否存在

我们可以使用access来判断文件或目录是否存在，fs.promises.access会完成检查，从而判断下一步操作怎么办，例如创建新的目录等等：

const checkDirExists = async (dirPath) => {
  try {
    await fs.promises.access(dirPath, fs.constants.F_OK);
    console.log(`目录 ${dirPath} 存在`);
    return true;
  } catch (err) {
    console.log(`目录 ${dirPath} 不存在`);
    return false;
  }
};

检查目录或文件是否存在可以帮助我们判断是否需要进行新建文件或目录操作，防止有重名等情况的发生：

checkDirExists(dir).then((exists) => {
  if (!exists) {
    // 如果目录不存在，则创建目录
    return createDir(dir);
  }
  return Promise.resolve(); // 目录已存在，直接返回一个 resolved 的 Promise
}).then(() => {
  // 写入文件
  return writeFile(filePath, content);
}).then(() => {
  // 追加内容到文件
  return appendToFile(filePath, "pleasure\n"); // 追加内容并换行
}).then(() => {
  // 读取文件
  return readFile(filePath);
});

2.6获取目录详细信息

使用stat可以来获取目录详细信息，例如创建时间、修改时间、大小等，我们使用birthtime等即可完成相应信息的调取：

const getDirInfo = async (dirPath) => {
  try {
    const stats = await fs.promises.stat(dirPath);
    if (stats.isDirectory()) {
      console.log(`目录 ${dirPath} 的详细信息:`);
      console.log(`- 大小: ${stats.size} 字节`);
      console.log(`- 创建时间: ${stats.birthtime}`);
      console.log(`- 修改时间: ${stats.mtime}`);
      console.log(`- 访问时间: ${stats.atime}`);
      console.log(`- 是否为目录: ${stats.isDirectory()}`);
      console.log(`- 是否为文件: ${stats.isFile()}`);
      console.log(`- 是否为符号链接: ${stats.isSymbolicLink()}`);
    } else {
      console.log(`${dirPath} 不是一个目录`);
    }
  } catch (err) {
    console.error(`无法获取目录 ${dirPath} 的信息: ${err}`);
  }
};

最终可以得到这样的效果：

2.7文件或目录重命名

入伏哦我们想要完成目录或文件重命名，我们可以使用rename就可以达到效果，fs.promises.rename为完整写法：

const renameFileOrDir = async (oldPath, newPath) => {
    try {
      await fs.promises.rename(oldPath, newPath);
      console.log(`重命名成功: ${oldPath} -> ${newPath}`);
    } catch (err) {
      console.error(`重命名失败: ${err}`);
    }
  };

此时我们可以看到文件名已经被修改了：

2.8删除文件

若想要删除文件，我们直接调用unlink即可完成，fs.promises.unlink会帮助进行文件删除：

const deleteFile = async (filePath) => {
  try {
    await fs.promises.unlink(filePath);
    console.log(`文件删除成功: ${filePath}`);
  } catch (err) {
    console.error(`文件删除失败: ${err}`);
  }
};

此时文件也已经被顺利删除了。

2.9删除目录

如果我们想要删除整个目录，可以使用 fs.promises.rmdir 方法来删除空目录，或者使用 fs.promises.rm 方法来删除非空目录。fs.promises.rm 方法提供了更多的选项，比如递归删除目录及其内容。：

const deleteDir = async (dirPath) => {
  try {
    await fs.promises.rm(dirPath, { recursive: true, force: true });
    console.log(`目录删除成功: ${dirPath}`);
  } catch (err) {
    console.error(`目录删除失败: ${err}`);
  }
};

此时想要删除的目录也已经被删掉了。