Node【文件篇】

原创已于 2023-11-13 14:46:18 修改 · 1.2k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#javascript #typescript #前端

于 2022-05-04 00:10:20 首次发布

node 专栏收录该内容

7 篇文章

订阅专栏

本文详细介绍了Node.js中的fs模块，包括异步和同步创建文件夹、追加文件、写入文件、删除文件、修改文件权限、读取文件内容、检查文件权限等操作。此外，还提到了高性能的文件写入方法`createWriteStream`，以及通过`FileHandle`类进行文件读写的使用。fs模块提供了丰富的API，涵盖了文件系统的常见操作。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

fs模块为node中的文件模块，所有的文件操作你都可以通过它去实现。并且node模块中绝大部分的api都提供类sync和promise风格。

const fs=require('fs');
const fsPromise=require('fs/promise')
fs.mkdir(path,options?,callbakc(err,newMkdirpath)?)：undefined //异步创建文件夹
fs.mkdirSync(path,options?)：newMkdirpath //同步创建
fsPromise.mkdir(path)：Promise //Promise 风格

node版本号

v14+

一、增

不仅仅是下面的方法，通过flag参数，fs.open fs.appendFile 等很多方法，都可以实现创建文件。本文提取了一些常用的方法，详细情况可以前往官网了解

fs.mkdir(path,options,callback)创建文件夹

const option = {
  recursive: false, // 当 recursive 为 true 时，如果没有成功创建目录，则 path 仍然为 undefined
  mode: 6, //可读 可写
};

//options方式读取
fs.mkdir(dirPath, option, (err) => {
  console.log("err", err);
});

fs.mkdtemp(path,options,callback)创建临时文件夹文件夹

临时目录在重启机器后会被删除

	const option = {
  encoding: "utf8",
};

//options方式读取
fs.mkdtemp(dirPath, option, (err, directory) => {
  console.log("err", err);
  console.log("临时文件夹地址", directory);
});

fs.appendFile(path,data,options,callback)将data:<string>|<buffer>追加到指定文件中，如果文件不存在则创建文件

const pathOrFd = "./src/index.js"; //文件名或文件描述符fd
const data = "-appendxsxsxsxs"; //
const option = {
  encoding: "utf8", //默认utf8
  mode: 777, //默认777
  flag: "a", //默认a：打开文件进行追加。 如果文件不存在，则创建该文件。
};

fs.appendFile(pathOrFd, data, option, callback);

function callback(err) {
  console.log("回调函数", err);
}

fs.writeFile(file,data,option)将数据写入文件

fs.writeFile 是一个便捷的方法，其在内部执行多次 write 调用以写入传给它的缓冲区。对于性能敏感的代码，则考虑使用 fs.createWriteStream()
writeFile根据option中的flag参数来控制数据的写入行为。flag默认为"w"，及写入数据。每次调用时都会将file中已有的数据覆盖

const file:<String>|<Buffer> = './index.js';
const data:<String>|<Buffer> = "-appendxsxsxsxsxxxxx-"; //写入文件的数据,

const option = {
  encoding: "utf8",
  mode: 6,
  flag: "a", //打开文件进行追加，如果文件不存在，则创建文件
};

fs.writeFile(file, data, option, (err) => {
  if (err) {
    return console.log("err", err);
  }
  console.log("写入成功");
});

二、删

fs.rm(path,option,callback):异步删除文件或目录

	const option = {
	  maxRetries: 0, //尝试删除目录发生异常时，最大重试删除操作次数,默认为0
	  recursive: true, //是否为递归删除，如果rm()的对象是目录，必须设置为true。默认为false
	  retryDelay: 100, //重试操作等待时间，单位毫秒
	  force: true, //当为 true 时，如果 path 不存在，则异常将被忽略。 默认值: false
	};
	fs.rm("./src", option, callback);
	
	function callback(err) {
	  console.log("回调函数", err);
	}

三、改

fs.chmod(path,mode,callback):修改文件权限。mode详情

构建 mode 的一种更简单的方法是使用三个八进制数字的序列（例如 765）。最左边的数字（示例中的 7）指定文件所有者的权限。中间的数字（示例中的 6）指定群组的权限。最右边的数字（示例中的 5）指定其他人的权限。
```
	fs.chmod("./src", 765, callback);
	function callback(err) {
	  console.log("回调函数", err);
	}
```

fs.copyFile(src,dest,mode,callback)。mode详情

copyFile只能拷贝文件拷贝目录,拷贝生成的文件权限即mode参数不能超过源文件

	const src = "./src/index.js"; //源文件
	const dest = "./test.txt"; //copy输出文件位置
	const mode = 1; //生成的文件读写、执行权限
	fs.copyFile(src, dest, mode, callback);
	function callback(err) {
	  console.log("回调函数", err);
	}

四、查

fs.access(path,mode.acllback)查询用户对指定的文件是否拥有指定mode的权限.更多mode请查看文件常量

通过它来判断文件或目录是否存在也是一种常见的使用场景

const pathOrFd = "./src/index.js"; //文件名或文件描述符fd

// 检查当前目录中是否存在该文件。
access(pathOrFd, fs.constants.F_OK, (err) => {
  console.log(`${file} ${err ? "does not exist" : "exists"}`);
});

// 检查文件是否可读。
access(pathOrFd, fs.constants.R_OK, (err) => {
  console.log(`${file} ${err ? "is not readable" : "is readable"}`);
});

fs.readFile(path[, options], callback) 使用文件path或文件修饰符读取文件数据
```
//options方式读取
fs.readFile(filePath, option, (err, data) => {});
```
fs.readdir(path,options, callback) 读取文件夹内容,只会返回文件或文件夹名，如果需要读取更多信息，需要手动拼接地址调用相关api
```
fs.readdir(dirPath, option?, (err, files) => {
	// files = ['filename.js','mkdirName'] 
});
```

fs.stat(path[, options], callback)调用此方法可以获取条目(文件或目录)的Stats实例


fs.stat(filePath, option, (err, stats) => {
  if (err) return console.log("err", err);
  console.log("是文件", stats.isFile());
  console.log("是目录", stats.isDirectory());
  console.log("文件大小", stats.size());
  console.log("创建时间戳毫秒", stats.birthtimeMs());
  console.log("最后一次修改时间戳毫秒", stats.mtimeMs());
  console.log("最后一次访问时间戳", stats.atimeMs());
});

五、高性能写文件

当我们大量读取或者写入文件并且对于性能存在要求时，就需要用到createWriteStream。

fs.createWriteStream:创建一个写入流，可以指定位置，高性能的写入文件return:<fs.WriteStream>更多详情

const options = {
  encoding: "utf8",
  mode: 7,
  flags: "r+", //对文件进行修改
  fd: null, //如果指定了 fd，则 <fs.WriteStream> 将忽略 path 参数并使用指定的文件描述符。 这意味着不会触发 'open' 事
  autoClose: true, //如果将 autoClose 设置为 true（默认行为），则在 'error' 或 'finish' 时文件描述符将自动关闭。 如果 autoClose 为 false，则即使出现错误，文件描述符也不会关闭。
  emitClose: true, //默认情况下，流将在销毁后触发 'close' 事件。 将 emitClose 选项设置为 false 以	更改此行为
  start:0, // 从指定位置写入
};

const writeStream = fs.createWriteStream(filePath, options); //return <fs.WriteStream>

//writeStream准备好使用时触发;
writeStream.on("ready", () => {
  //写入数据
  writeStream.write("-write data1-", "utf8", (err) => {});
  //调用 writable.end() 方法表示不再有数据写入 Writable,在调用 stream.end() 之后调用 stream.write()方法将引发错误。
  writeStream.end("data", "utf8", (err) => {
    writeStream.destroy(); // 调用完成之后要对写入流销毁
  });
});

六、常量

对文件系统 flags 的支持

flag 也可以是 open(2) 记录的数字；常用的常量可从 fs.constants 获得

符号	描述
`a:`	打开文件进行追加。如果文件不存在，则创建该文件。
`ax:`	类似于 ‘a’ 但如果路径存在则失败。
`a+:`	打开文件进行读取和追加。如果文件不存在，则创建该文件。
`ax+:`	类似于 ‘a+’ 但如果路径存在则失败
`as:`	以同步模式打开文件进行追加。如果文件不存在，则创建该文件。
`as+:`	以同步模式打开文件进行读取和追加。如果文件不存在，则创建该文件。
`r:`	打开文件进行读取。如果文件不存在，则会发生异常。
`r+:`	打开文件进行读写。如果文件不存在，则会发生异常。
`rs+:`	以同步模式打开文件进行读写。指示操作系统绕过本地文件系统缓存,这主要用于在 NFS 挂载上打开文件，因为它允许跳过可能过时的本地缓存。它对 I/O 性能有非常实际的影响，因此除非需要，否则不建议使用此标志。这不会将 fs.open() 或 fsPromises.open() 变成同步阻塞调用。如果需要同步操作，应该使用类似 fs.openSync() 的东西。
`w:`	打开文件进行写入。创建（如果它不存在）或截断（如果它存在）该文件。
`wx:`	类似于 ‘w’ 但如果路径存在则失败。
`w+:`	打开文件进行读写。创建（如果它不存在）或截断（如果它存在）该文件。
`wx+:`	类似于 ‘w+’ 但如果路径存在则失败。

文件系统mode支持

第一个7:表示当前文件的拥有者的权限
第二个7:表示当前文件的所属组（同组用户）权限
第三个7:表示当前文件的组外权限

mode

代码描述
7 可读、可写和可执行
6 可读和可写
5 可读和可执行
4 只读
3 可写和可执行
2 只写
1 只可执行
0 无权限

代码	描述
7	可读、可写和可执行
6	可读和可写
5	可读和可执行
4	只读
3	可写和可执行
2	只写
1	只可执行
0	无权限

七、通过FileHandle类去读写文件

这也是一种读、写文件的一种方式，如果要对同一个分别执行多个读、写操作的时候，使用这种方式会比较简洁。它们等效于fs提供的api，只不过操作的文件是创建filehandle实列提供的文件标识符对应的文件。下面来试一试

获取filehandle实例

const fsPromise = require("fs/promise");

const path:<string> | <Buffer> | <URL> ='./test.js';
const flags = "r"; // 默认 "r"
const mode=777;

const filehandle = await fsPromise.open(path,flags,mode);

操作filehandle

const data='',
const postion = 1; // 从data的第1个位置开始写入
const encoding = 'utf-8';
await filehandle.write('写入文件',postion,encoding);
await filehandle.read({encoding:'utf-8'}); // 直接调用read，不需要像`fs.read('./test.js')`，再去获取文件
await filehandle.close();// 使用完毕之后需要释放文件