文章目录
前言
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
将文件异步写入指定位置，可用来创建文件
fs.writeFile
是一个便捷的方法，其在内部执行多次 write 调用以写入传给它的缓冲区。 对于性能敏感的代码，则考虑使用
fs.createWriteStream()
const data = "-appendxsxsxsxsxxxxx-"; //写入文件的数据,可以是<String>|<Buffer> const option = { encoding: "utf8", mode: 6, flag: "a", //打开文件进行追加，如果文件不存在，则创建文件 }; fs.writeFile(filePath, data, option, (err) => { if (err) { return console.log("err", err); } console.log("写入成功"); });
-
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 以 更改此行为 }; 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(); //调用完成之后销毁 }); });
-
fs.write
：通过文件标识写入文件
值得一提的是，数据插入位置flag优先级较高，如果flag为'a'即在文件中追加数据，那么即便设置了position，数据也将在文件的末尾插入
fs.write()
与
fs.writeFile
的不同是-
fs.write()
第一个参数只接受fd -
fs.write()
可以通过position指定插入位置
const data = "-data-"; //写入文件的数据,可以是<String>，或者拥有toString方法的<Objet> const position = 10; //指从文件开头数据应被写入的偏移量。 如果 typeof position !== 'number'，则数 据将写入当前位置 const encoding = "utf8"; //是预期的字符串编码。 const fd = fs.openSync(filePath, "a", 7); //文件修饰符 fs.write(fd, data, position, encoding, (err, bytesWritten, buffer) => { if (err) { return console.log("err", err); } console.log( "write success", "写入文件的size byte单位", bytesWritten, "注入的数据", buffer ); //使用文件修饰符操作的api不会自动关闭，必须手动关闭文件修饰符 fs.close(fd); }); -
二、删
-
fs.rm(path,option,callback)
:异步删除文件或目录const option = { maxRetries: 0, //尝试删除目录发生异常时，最大重试删除操作次数,默认为0 recursive: 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.open(path[, flags, mode, callback)
打开一个文件通过此方法拿到文件修饰符
fd
,可以为一些需要文件修饰符的方法提供参数,比如
fs.write
fs.read
。const filePath = "./src/index.js"; //文件名或文件描述符fd const mode = 7; //mode const flag = "r"; fs.open(filePath, flag, mode, (err, fd) => { if (err) { return console.log("查询失败", err); } console.log("文件修饰符", fd); });
-
fs.opendir(path, options, callback)
打开一个文件夹，返回:<
fs.Dir>
const dirPath = "./src"; //文件名或文件描述符fd const option = { encoding: "utf8", //默认utf8 bufferSize: 32, //当从目录读取时，在内部缓冲的目录条目数。 值越大，性能越好，但内存使用率越高。 默认32 }; fs.opendir(dirPath, option, (err, dir) => { if (err) { return console.log("查询失败", err); } console.log("文件夹句柄", dir); //<fs.Dir> dir.close(); //操作完成之后关闭目录的底层资源句柄。 后续读取将导致错误 });
-
fs.read(fd, options,callback)
使用
fd
文件修饰符读取文件数据options参数可以省略
fs.read(fd,callback)
const filePath = "./src/index.js"; //文件名或文件描述符fd const mode = 7; //mode const flag = "r"; const option = { buffer: Buffer.alloc(16384), //数据将写入的缓冲区<Buffer> | <TypedArray> | <DataView> offset: 100, //要写入数据的 buffer 中的位置。 length: 100, // 读取的字节数。 position: null, //指定从文件中开始读取的位置。 如果 position 为 null 或 -1 ，则将从当前文件位置读取数据，并更新文件位 置。 如果 position 是整数，则文件位置将保持不变。 }; fs.open(filePath, flag, mode, (err, fd) => { if (err) return; fs.read(fd, option, (err2, bytesRead, buffer) => { console.log("read", err2, "字节数", bytesRead, "二进制数据", buffer); }); });
-
fs.readFile(path[, options], callback)
使用
文件path
或
文件修饰符
读取文件数据- 读数将从当前位置开始。 例如，如果文件已经具有 ‘Hello World’ 并且使用文件描述符读取了六个字节，则使用相同文件描述符对 fs.readFile() 的调用将得到 ‘World’，而不是 ‘Hello World’
- 如果将文件描述符指定为 path，则它将不会自动关闭。
-
指定编码方式
fs.readFile(filePath, "utf8", callback)
const option = { encoding: "utf8", flag: "r", //请参阅对文件系统 flags 的支持。 默认值: 'r' }; //options方式读取 fs.readFile(filePath, option, (err, data) => { console.log("错误信息", err, "data", data); });
-
fs.readdir(path,options, callback)
读取文件夹信息options参数可以省略
const option = { encoding: "utf8", withFileTypes: true, //是否在files中返回文件类型1为文件 2为目录，即便返回也不可读取,默认为false }; fs.readdir(dirPath, option, (err, files) => { console.log("错误信息", err, "files", files); });
-
fs.stat(path[, options], callback)
调用此方法可以获取条目(文件或目录)的
Stats实例
-
<fs.Stats>
包含了文件基本信息如
是否是文件、size大小、创建时间、mode等等
更多stats属性
-
fs.fstat(fd[, options], callback)
和此方法相识，只不过fstat第一个参数是
文件修饰符:fd
const option = { bigint: true, //返回的 <fs.Stats> 对象中的数值是否应为 bigint。 默认值: false。 }; //options方式读取 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()); });
bigint:false
stats
{
dev: 2114,
ino: 48064969,
mode: 33188,
nlink: 1,
uid: 85,
gid: 100,
rdev: 0,
size: 527,
blksize: 4096,
blocks: 8,
atimeMs: 1318289051000.1,
mtimeMs: 1318289051000.1,
ctimeMs: 1318289051000.1,
birthtimeMs: 1318289051000.1,
atime: Mon, 10 Oct 2011 23:24:11 GMT,
mtime: Mon, 10 Oct 2011 23:24:11 GMT,
ctime: Mon, 10 Oct 2011 23:24:11 GMT,
birthtime: Mon, 10 Oct 2011 23:24:11 GMT }
bigint:true
stats
{
dev: 2114n,
ino: 48064969n,
mode: 33188n,
nlink: 1n,
uid: 85n,
gid: 100n,
rdev: 0n,
size: 527n,
blksize: 4096n,
blocks: 8n,
atimeMs: 1318289051000.1n,
mtimeMs: 1318289051000.1n,
ctimeMs: 1318289051000.1n,
birthtimeMs: 1318289051000.1n,
atime: Mon, 10 Oct 2011 23:24:11 GMT,
mtime: Mon, 10 Oct 2011 23:24:11 GMT,
ctime: Mon, 10 Oct 2011 23:24:11 GMT,
birthtime: Mon, 10 Oct 2011 23:24:11 GMT }
-
常量
-
对文件系统 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 无权限