Node.js 中包含一个文件系统模块,给我们提供了许多非常便利的对文件的一些操作方法。
使用的时候首先需要我们导入这个模块
var fs = require(''fs)
以下的每段代码都基于两个文件,一个是a.txt,内容:hello world
,另一个是main.js,也就是我以下代码的地方。
-
open a file
fs.open(path, flags[, mode], callback)
-
path
:打开文件的路径以及文件名 -
flags
:打开方式,r,r+,w
等 -
callback
:回调函数,接收两个参数,第一个err
错误信息,第二个fd
,文件描述符,integer
类型
for example:
var fs = require("fs");
console.log("begin");
fs.open("a.txt",'r',function (err,fd) {
if(err){
return console.log(err);
}
console.log(fd);
})
the result:
-
Get File Information
fs.stat(path,callback)
-
path
:文件路径及文件名 -
callback
:回调函数,接收两个参数,err
错误信息,stats
是一个fs.Stats
类型的对象,fs.Stats
类中有以下方法可以让我们很简单地获取到一些信息
for example:
var fs = require("fs");
fs.stat("a.txt",function (err,stats) {
if(err){
return console.log(err);
}
console.log(stats.isFile());
console.log(stats.isDirectory());
console.log(stats);
})
-
Writing a File
fs.writeFile(path, data[, options], callback)
-
path
:文件名,包含路径 -
data
:要写进文件的数据 -
options
:一个对象,{encoding, mode, flag}
,默认:{encoding:utf8, mode:0666, flag:w}
-
callback
:回调函数,接收一个错误信息参数err
for example:
var fs = require("fs");
fs.writeFile("a.txt",'hi Node.js',function (err) {
if(err){
return console.log(err);
}
console.log("write successfully")
})
去看看a.txt中发生了什么:
指定的字符串被写入了a.txt,并且默认options的方式下是直接覆盖掉了原来的内容,当我将a.txt改成不存在的b.txt,发现它新创建了一个b.txt,并且将指定字符串写入。
-
Reading a File
fs.read(fd, buffer, offset, length, position, callback)
-
fd
:文件描述符,是fs.open()
中获取到的值 -
buffer
:读出的数据要写入数据的缓冲区 -
offset
:缓冲区开始写入的偏移量 -
length
:指定要读取的字节数 -
position
: 文件开始读取的位置,如果是null,则从当前位置开始 -
callback
:回调函数,接收三个参数,err
:错误信息,bytesRead
:读出的数据的字节数,buffer:读取出的缓冲数据
var buffer = new Buffer(1024);
fs.open("a.txt", 'r', function (err, fd) {
if (err) {
console.log(err);
}
fs.read(fd, buffer, 0, buffer.length, 0, function (err, bytes) {
if (err) {
console.log(err);
}
console.log("bytes:" + bytes);
if (bytes > 0) {
console.log(buffer.slice(0, bytes).toString());//截取所读出的数据的大小,并且转换为字符串形式,会输出a.txt中的内容:hi Node.js
}
})
})
- Closing a File
fs.close(fd, callback)
-
fd
:文件描述符,从fs.open()中得到 -
callback
:回调函数,接收一个错误参数err
for example:
-
var fs = require("fs");
fs.open("a.txt", 'r', function (err, fd) {
if (err) {
console.log(err);
}
fs.close(fd,function (err) {
if(err){
console.log(err);
}
console.log("close successfully");
})
})
- Truncate a File(截断文件)
`fs.ftruncate(fd, len, callback)`
- `fd`:文件描述符,从`fs.open()`中获得
- `len`:截断后的文件长度
- `callback`:回调函数,只接收一个发生错误时的参数`err`
var fs = require("fs");
var buffer = new Buffer(1024);
fs.open("a.txt", 'r+', function (err, fd) {
if (err) {
console.log(err);
}
fs.read(fd, buffer, 0, buffer.length, 0, function (err, bytes) {
if (err) {
console.log(err);
}
console.log("bytes:" + bytes);
if (bytes > 0) {
console.log("the first time to read:" + buffer.slice(0, bytes).toString());
}
})
fs.ftruncate(fd, 5, function (err) {
if (err) {
console.log(err)
}
fs.read(fd, buffer, 0, buffer.length, 0, function (err, bytes) {
if (err) {
console.log(err);
}
console.log("bytes:" + bytes);
if (bytes > 0) {
console.log("reading after truncating :" + buffer.slice(0, bytes).toString());
}
})
})
})
![运行结果](http://upload-images.jianshu.io/upload_images/3114127-e80f3c500324fd6c.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
- Delete a File
`fs.unlink(path, callback)`
- `path`:文件名及路径
- `callback`:回调函数,接收一个发生异常时的参数`err`
var fs = require('fs');
fs.unlink('a.txt',function(err){
if(err){
console.log(err);
}
console.log("delete successfully");
}
)
原来存在的a.txt被删除,若删除一个不存在的文件,则会抛出错误信息
- Create a Directory
`fs.mkdir(path[, mode], callback)`
- `path`:目录名以及路径
- `mode`:要设置的目录权限,默认`0777`
- `callback`:回调函数,只接收一个异常参数`err`
fs.mkdir('A','0777',function (err) {
if(err){
return console.log(err)
}
console.log("create successgully");
})
上边的代码会在当前目录下创建一个名为A的目录
- Read a Directory
`fs.readdir(path, callback)`
- `path`:目录名以及路径
- `callback`:回调函数,接收两个参数,`err`和`files`,`files`是以一个数组的形式返回该目录下所有的文件
fs.readdir('./A/',function (err,files) {
if(err){
return console.log(err)
}
console.log("files:"+files);
})
在我的A目录下有两个文件:A1.txt,A2.txt,运行结果如下
![result](http://upload-images.jianshu.io/upload_images/3114127-9de20f584629fd0f.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
- Remove a Directory
`fs.rmdir(path, callback)`
- `path`:目录名及路径
- `callback`:回调函数,接收一个异常参数`err`
fs.rmdir('A',function (err) {
if(err){
return console.log(err)
}
console.log("remove successfully");
})
第一次的时候并没有删除成功,而是报了一个异常
![err](http://upload-images.jianshu.io/upload_images/3114127-1b133a0a2772b13b.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
我删除了A目录下的所有文件,再去执行上边的代码,就成功地将目录A删除了。