node.js文件操作
一、Node.js 文件系统
Node.js 提供一组类似 UNIX（POSIX）标准的文件操作API。 Node 导入文件系统模块(fs)语法如下所示：
var fs = require("fs")
二、异步和同步
Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。
异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。
建议大家使用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞。
1、实例
let fs = require('fs')
// 异步读取
fs.readFile('d://input.txt',function(err,data){
if(err){
console.error(err)
}
else
{
console.log(data.toString());
}
})
// 同步读取
var data = fs.readFileSync('d://input.txt');
console.log("sync read: " + data.toString());
三、打开文件
1、语法
以下为在异步模式下打开文件的语法格式：
fs.open(path, flags[, mode], callback)
2、参数
参数使用说明如下：
-
path - 文件的路径。
-
flags - 文件打开的行为。具体值详见下文。
-
mode - 设置文件模式(权限)，文件创建默认权限为 0666(可读，可写)。
-
callback - 回调函数，带有两个参数如：callback(err, fd)。
flags 参数可以是以下值：
| Flag | 描述 |
|---|---|
| r | 以读取模式打开文件。如果文件不存在抛出异常。 |
| r+ | 以读写模式打开文件。如果文件不存在抛出异常。 |
| rs | 以同步的方式读取文件。 |
| rs+ | 以同步的方式读取和写入文件。 |
| w | 以写入模式打开文件，如果文件不存在则创建。 |
| wx | 类似 'w'，但是如果文件路径存在，则文件写入失败。 |
| w+ | 以读写模式打开文件，如果文件不存在则创建。 |
| wx+ | 类似 'w+'， 但是如果文件路径存在，则文件读写失败。 |
| a | 以追加模式打开文件，如果文件不存在则创建。 |
| ax | 类似 'a'， 但是如果文件路径存在，则文件追加失败。 |
| a+ | 以读取追加模式打开文件，如果文件不存在则创建。 |
| ax+ | 类似 'a+'， 但是如果文件路径存在，则文件读取追加失败。 |
3、实例
接下来我们创建 file.js 文件，并打开 input.txt 文件进行读写，代码如下所示
// 同步读取 var data = fs.readFileSync('d://input.txt'); console.log("sync read: " + data.toString()); fs.open("d://input.txt",'r+',function(err,fd){ if(err){ console.error(err) } else{ console.log("open sucess") } })
四、获取文件信息
1、语法
以下为通过异步模式获取文件信息的语法格式：
fs.stat(path, callback)
2、参数
参数使用说明如下：
-
path - 文件路径。
-
callback - 回调函数，带有两个参数如：(err, stats), stats 是 fs.Stats 对象。
fs.stat(path)执行后，会将stats类的实例返回给其回调函数。可以通过stats类中的提供方法判断文件的相关属性。例如判断是否为文件：
fs.stat("d://input.txt",function(err,stats){
console.log("isfile:"+stats.isFile());
});
stats类中的方法有：
| 方法 | 描述 |
|---|---|
| stats.isFile() | 如果是文件返回 true，否则返回 false。 |
| stats.isDirectory() | 如果是目录返回 true，否则返回 false。 |
| stats.isBlockDevice() | 如果是块设备返回 true，否则返回 false。 |
| stats.isCharacterDevice() | 如果是字符设备返回 true，否则返回 false。 |
| stats.isSymbolicLink() | 如果是软链接返回 true，否则返回 false。 |
| stats.isFIFO() | 如果是FIFO，返回true，否则返回 false。FIFO是UNIX中的一种特殊类型的命令管道。 |
| stats.isSocket() | 如果是 Socket 返回 true，否则返回 false。 |
3、实例
fs.stat("d://input.txt",function(err,stats){
console.log("isfile:"+stats.isFile());
console.log("isDirectory:"+stats.isDirectory());
console.log("isBlockDevice:"+stats.isBlockDevice());
console.log("isCharacterDevice:"+stats.isCharacterDevice());
console.log("isSymbolicLink:"+stats.isSymbolicLink());
console.log("isFIFO:"+stats.isFIFO());
console.log("isSocket:"+stats.isSocket());
console.log(stats);
});
输出：
isfile:true isDirectory:false isBlockDevice:false isCharacterDevice:false isSymbolicLink:false isFIFO:false isSocket:false Stats { dev: 4203715749, mode: 33206, nlink: 1, uid: 0, gid: 0, rdev: 0, blksize: 4096, ino: 281474979436521, size: 7, blocks: 0, atimeMs: 1691136866741.3293, mtimeMs: 1691132219486.3997, ctimeMs: 1691132219486.3997, birthtimeMs: 1691132210894.916, atime: 2023-08-04T08:14:26.741Z, mtime: 2023-08-04T06:56:59.486Z, ctime: 2023-08-04T06:56:59.486Z, birthtime: 2023-08-04T06:56:50.895Z }
五、写入文件
1、语法
以下为异步模式下写入文件的语法格式：
fs.writeFile(file, data[, options], callback)
writeFile 直接打开文件默认是 w 模式，所以如果文件存在，该方法写入的内容会覆盖旧的文件内容。
2、参数
参数使用说明如下：
-
file - 文件名或文件描述符。
-
data - 要写入文件的数据，可以是 String(字符串) 或 Buffer(缓冲) 对象。
-
options - 该参数是一个对象，包含 {encoding, mode, flag}。默认编码为 utf8, 模式为 0666 ， flag 为 'w'
-
callback - 回调函数，回调函数只包含错误信息参数(err)，在写入失败时返回。
3、实例
接下来我们创建 file.js 文件，代码如下所示：
fs.writeFile("d://1.txt",'我是通 过fs.writeFile 写入文件的内容',function(err){
if (err) {
return console.error(err);
}
console.log("write success");
console.log("read data:");
fs.readFile('input.txt', function (err, data) {
if (err) {
return console.error(err);
}
console.log("file data: " + data.toString());
});
})
六、读取文件
1、语法
以下为异步模式下读取文件的语法格式：
fs.read(fd, buffer, offset, length, position, callback)
该方法使用了文件描述符来读取文件。
2、参数
参数使用说明如下：
-
fd - 通过 fs.open() 方法返回的文件描述符。
-
buffer - 数据写入的缓冲区。
-
offset - 缓冲区写入的写入偏移量。
-
length - 要从文件中读取的字节数。
-
position - 文件读取的起始位置，如果 position 的值为 null，则会从当前文件指针的位置读取。
-
callback - 回调函数，有三个参数err, bytesRead, buffer，err 为错误信息， bytesRead 表示读取的字节数，buffer 为缓冲区对象。
3、实例
let buf = new Buffer.alloc(1024); fs.open('d://1.txt','r+',function(err,fd){ if(err){ console.err(err); } else{ fs.read(fd,buf,0,buf.length,0,function(err,bytes){ if(err){ console.error(err); } else{ console.log(bytes+" bytes read"); } if(bytes>0){ console.log(buf.slice(0,bytes).toString()); } }) } })
七、关闭文件
1、语法
以下为异步模式下关闭文件的语法格式：
fs.close(fd, callback)
该方法使用了文件描述符来读取文件。
2、参数
参数使用说明如下：
-
fd - 通过 fs.open() 方法返回的文件描述符。
-
callback - 回调函数，没有参数。
3、实例
let buf = new Buffer.alloc(1024); fs.open('d://1.txt','r+',function(err,fd){ if(err){ console.err(err); } else{ fs.read(fd,buf,0,buf.length,0,function(err,bytes){ if(err){ console.error(err); } else{ console.log(bytes+" bytes read"); } if(bytes>0){ console.log(buf.slice(0,bytes).toString()); } fs.close(fd,function(err){ if(err){ console.error(err) } else{ console.log("close success") } }) }) } })
八、删除文件
1、语法
以下为删除文件的语法格式：
fs.unlink(path, callback)
2、参数
参数使用说明如下：
-
path - 文件路径。
-
callback - 回调函数，没有参数。
fs.unlink("d://1.txt",function(err){
if(err){
console.error(err);
}
else{
console.log("delete sucess")
}
})
参考：https://m.runoob.com/nodejs/nodejs-fs.html
