在nodeJs中,所有的文件操作都是通过fs核心模块来实现的,包括文件目录的创建、删除、查询以及文件的读取和写入,在fs模块中所有的方法都分为同步和异步俩种方法实现。
sync后缀则为同步方法,无后缀则为异步方法。
文件权限
linux && unix中
在系统中文件权限会根据文件所有者(自己)、组(家庭组)、其他用户(陌生人)进行分配,
文件操作权限又分为读写执行 (八进制 )4、2、1、0。0代表不具备权限
nodeJS标识位 flag
r 读取文件,如果文件不存在则抛出异常。
r+ 读取并写入文件,如果文件不存在则抛出异常。
rs 读取并写入文件,指示操作系统绕开本地文件系统缓存。
w 写入文件,文件不存在会被创建,存在则清空后写入。
wx 写入文件,排它方式打开。
w+ 读取并写入文件,文件不存在则创建文件,存在则清空后写入。
wx+ 和 w+ 类似,排他方式打开。
a 追加写入,文件不存在则创建文件。
ax 与 a 类似,排他方式打开。
a+ 读取并追加写入,不存在则创建。
ax+ 与 a+ 类似,排他方式打开
文件描述符 fd
操作系统会为每个打开的文件分配一个名为文件描述符的数值标识,文件操作使用这些文件描述符来识别与追踪每个特定的文件,Window 系统使用了一个不同但概念类似的机制来追踪资源,为方便用户,NodeJS 抽象了不同操作系统间的差异,为所有打开的文件分配了数值的文件描述符。
在 NodeJS 中,每操作一个文件,文件描述符是递增的,文件描述符一般从 3 开始,因为前面有 0 、 1 、 2 三个比较特殊的描述符,分别代表 process.stdin (标准输入)、 process.stdout (标准输出)和 process.stderr (错误输出)。
fs模块
一、同步和异步
使用require('fs')载入fs模块,模块中所有方法都有同步和异步两种形式。
异步方法中回调函数的第一个参数总是留给异常参数(exception),如果方法成功完成,该参数为null或undefined。
同步方法执行完并返回结果后,才能执行后续的代码。而异步方法采用回调函数接收返回结果,可以立即执行后续代码。
异步写法:有一个回调函数。
var fs = require('fs'); // 载入fs模块
fs.unlink('/tmp/shiyanlou', function(err) {
if (err) {
throw err;
}
console.log('成功删除了 /tmp/shiyanlou');
});
同步写法:
var fs = require('fs');
fs.unlinkSync('/tmp/shiyanlou'); // Sync 表示是同步方法
console.log('成功删除了 /tmp/shiyanlou');
二、readFile读取文件
//fs.readFile(filename,[option],callback)
//filename String 文件名
//option Object
//encoding String |null default=null
//flag String default='r'
//callback Function
var fs = require('fs'); // 引入fs模块
fs.readFile('./test.txt', function(err, data) {
// 读取文件失败/错误
if (err) {
throw err;
}
// 读取文件成功
console.log(data);
});
node 读取文件.js 运行程序
可以发现 文件内容为2进制数据
要显示文件内容可以使用toString() 或者设置输出编码。
//toString()写法:
fs.readFile('./test.txt', function(err, data) {
// 读取文件失败/错误
if (err) {
throw err;
}
// 读取文件成功
console.log(data.toString());
});
//设置编码格式
fs.readFile('./test.txt', 'utf-8', function(err, data) {
// 读取文件失败/错误
if (err) {
throw err;
}
// 读取文件成功
console.log('utf-8: ', data.toString());
//直接用console.log(data);也可以
});
同步写法没有回调函数
fs.readFileSync(filename,[options])。
WriteFile写入文件
//使用fs.writeFile(filename,data,[options],callback)写入内容到文件。
//参数说明:
//filename String 文件名
//data String|buffer
//option Object
//encoding String |nulldefault='utf-8'
//mode Number default=438(aka 0666 in Octal)
//flag Stringdefault='w'
//callback Function
//demo
var fs = require('fs'); // 引入fs模块
// 写入文件内容(如果文件不存在会创建一个文件)
// 写入时会先清空文件
fs.writeFile('./test2.txt', 'test test', function(err) {
if (err) {
throw err;
}
console.log('Saved.');
// 写入成功后读取测试
fs.readFile('./test2.txt', 'utf-8', function(err, data) {
if (err) {
throw err;
}
console.log(data);
});
});
参数option{}中 flag 默认值 w,即会清空文件 ,想要追加,可以传递flag 参数,
文件读写操作进阶
fs.read && fs.write 功能类似 fs.readFile && fs.writeFile,但提供更底层的操作;
使用fs.read 和fs.write 前 需要使用 fs.open 打开文件 和 fs.close 关闭文件。
1.fs.open
fs.open(path,flags,[mode],callback)方法用于打开文件,以便fs.read()读取。
参数:
- path 文件路径
- flags打开文件的方式
- [mode] 是文件的权限(可行参数,默认值是0666)
- callback 回调函数
flags以及model(权限) 在上方有介绍;
2.fs.close
fs.close(fd,[callback]) 方法用于关闭文件
参数 :
fd 为文件的描述符,标识,fs.open()方法中的回调函数中返回的第二个参数即为fd;
callback 关闭成功回调函数;
3.fs.read
fs.read(fd,buffer,offset,length,position,callback) 接收6个参数。
- fd 文件描述符,必须接收fs.open()方法中的回调函数返回的第二个参数。
- buffer 是存放读取到的数据的Buffer对象。
- offset 指定 向buffer中存放数据的起始位置。
- length 指定 读取文件中数据的字节数。
- position 指定 在文件中读取文件内容的起始位置。
- callback 回调函数,参数如下
- err 用于抛出异常
- bytesRead 从文件中读取内容的实际字节数。
- buffer 被读取的缓存区对象。
123连起来的demo如下:
var fs = require('fs'); // 引入fs模块
// 打开文件
fs.open('./testread.txt', 'r', function(err, fd) {
if (err) {
throw err;
}
console.log('open file success.');
var buffer = new Buffer(255);
// 读取文件
fs.read(fd, buffer, 0, 10, 0, function(err, bytesRead, buffer) {
if (err) {
throw err;
}
// 打印出buffer中存入的数据
console.log(bytesRead, buffer.slice(0, bytesRead).toString());
// 关闭文件
fs.close(fd);
});
});
fs.write()
fs.write(fd,buffer,offset,length[,position],callback(err,bytesWritten,buffer))接收6个参数。
- fd 文件描述符。
- buffer 缓冲区,数据将被写入。buffer尺寸的大小设置最好是8的倍数,效率较高。
- offset buffer写入的偏移量
- length (integer) 指定文件读取字节数长度
- position (integer) 指定文件读取的起始位置,如果该项为null,将从当前文件指针的位置开始读取数据。
- callback 回调传递了三个参数,err, bytesRead, buffer
- err 异常
- bytesRead:读取的字节数
- buffer:缓冲区对象
var fs = require('fs'); // 引入fs模块
// 打开文件
fs.open('./testwrite.txt', `w`, function(err, fd) {
if (err) {
throw err;
}
console.log('open file success.');
var buffer = new Buffer('shiyanlou');
// 读取文件
fs.write(fd, buffer, 0, 6, 0, function(err, bytesWritten, buffer) {
if (err) {
throw err;
}
console.log('write success.');
// 打印出buffer中存入的数据
console.log(bytesWritten, buffer.slice(0, bytesWritten).toString());
// 关闭文件
fs.close(fd);
});
});
目录操作
1、创建目录
fs.mkdir(path,[mode],callback)创建目录,path是需要创建的目录,[mode]是目录的权限(默认是0777),callback是回调函数
var fs = require('fs'); // 引入fs模块
// 创建 newdir 目录
fs.mkdir('./newdir', function(err) {
if (err) {
throw err;
}
console.log('make dir success.');
});
2、读取目录
使用fs.readdir(path,callback)读取文件目录。
var fs = require('fs'); // 引入fs模块
fs.readdir('./newdir', function(err, files) {
if (err) {
throw err;
}
// files是一个数组
// 每个元素是此目录下的文件或文件夹的名称
console.log(files);
});