一、简介
本文将介绍node.js文件系统(fs)和流(stream)的一些API已经参数使用情况。
二、目录
1.fs.readFile
2.fs.writeFile
3.fs.open
4.fs.read
5.fs.stat
6.fs.close
7.fs.mkdir
8.fs.rmdir
9.fs.readdir
10.fs.unlink
stream流的四种类型readable,writable,duplex,transform以及stream对象的事件。
三、文件系统fs主要方法介绍
1、fs.readFile
2、fs.writeFile
writeFile以异步的方式写入文件,fs.writeFile(file,data[,options],callback)
3、fs.open()
在异步方式下打开文件,fs.open(path,flags[,mode],callback)
4、fs.read()
此方法为异步方式下读取文件,格式:fs.read(fd,buffer,offset,length,position,callback)
fs.open('at.txt',fd) {
if (err) {
return console.error(err);
}
fs.read(fd,buf,buf.length,bytes){
if (err){
console.log(err);
}
// 仅输出读取的字节
if(bytes > 0){
console.log(buf.slice(0,bytes).toString());
}
});
});
5、fs.stat()
此方法为异步方式获取文件信息,格式:fs.stat(path,callback)
异步返回的stats类的实例有很多方法,比如stats.isFile()判断是否是文件,stats.isDirectory()判断是否是目录,。。。。。。
6、fs.close()
fs.close()是以异步的方式关闭文件,语法格式:fs.close(fd,callback),参数如下:
callback - 回调函数,没有参数。
7、fs.mkdir()
此方法为创建目录,格式:fs.mkdir(path[,callback),参数如下:
path:路径。
mode:目录权限,默认0777.。
callback:回调,没有参数。
8、fs.rmdir()
删除目录,语法格式:fs.rmdir(path,callback)
9、fs.readdir()
此方法为读取目录,语法格式:fs.readdir(path,callback),callback回调函数有两个参数,第一个是err,第二个为目录下的文件数组files。
fs.readdir("/tmp/",files){
if (err) {
return console.error(err);
}
files.forEach( function (file){
console.log( file );
});
});
10、fs.unlink()
此方法作用为删除文件,格式:fs.unlink(path,callback)
fs.unlink('input.txt',function(err) {
if (err) {
return console.error(err);
}
console.log("文件删除成功!");
});
四、stream流类型与事件介绍
1、 stream:流是一个抽象接口,有四种流类型:
- readable :可读;
- writable :可写操作;
- duplex :可读可写操作;
- transform :操作被写入数据,然后读出结果。
所有的stream对象都是EventEmitter 的实例,常用事件有:
- data:当有数据可读触发,
- end:没有数据可读触发,
- error:发生错误时触发,
- finish:完成触发。
2、从流中读数据
var readerStream = fs.createReadStream('input.txt');
// 设置编码为 utf8。
readerStream.setEncoding('UTF8');
// 处理流事件 --> data,end,and error
readerStream.on('data',function(chunk) {
data += chunk;
});
readerStream.on('end',function(){
console.log(data);
});
readerStream.on('error',function(err){
console.log(err.stack);
});
console.log("程序执行完毕");
3、写入流:
var writerStream = fs.createWriteStream('output.txt');
// 使用 utf8 编码写入数据
writerStream.write(data,'UTF8');
// 标记文件末尾
writerStream.end();
// 处理流事件 --> data,and error
writerStream.on('finish',function() {
console.log("写入完成。");
});
writerStream.on('error',function(err){
console.log(err.stack);
});
console.log("程序执行完毕");
4、管道流(pipe)
var readerStream = fs.createReadStream('input.txt');
// 创建一个可写流
var writerStream = fs.createWriteStream('output.txt');
// 管道读写操作
// 读取 input.txt 文件内容,并将内容写入到 output.txt 文件中
readerStream.pipe(writerStream);
console.log("程序执行完毕");
5、链式流
链式是通过连接输出流到另外一个流并创建多个流操作链的机制。链式流一般用于管道操作。
接下来我们就是用管道和链式来压缩和解压文件。
fs.createReadStream('input.txt')
.pipe(zlib.createGzip())
.pipe(fs.createWriteStream('input.txt.gz'));
console.log("文件压缩完成。");
//解压
var fs = require("fs");
var zlib = require('zlib');
// 解压 input.txt.gz 文件为 input.txt
fs.createReadStream('input.txt.gz')
.pipe(zlib.createGunzip())
.pipe(fs.createWriteStream('input.txt'));
console.log("文件解压完成。");