目录
article
Node.js 之文件系统
Node.js 之文件系统
Node.js 提供一组类似 UNIX（POSIX）标准的文件操作 API。Node 导入文件系统模块 (fs) 语法如下所示：
var fs = require("fs")
异步和同步
Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息 (error)。
建议大家是用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞。
实例
创建 input.txt 文件，内容如下：
菜鸟教程官网地址：[www.runoob.com
](http://www.runoob.com)
文件读取实例
创建 file.js 文件, 代码如下：
var fs = require("fs");
// 异步读取
fs.readFile('input.txt', function (err, data) {
if (err) {
return console.error(err);
}
console.log("异步读取: " + data.toString());
});
// 同步读取
var data = fs.readFileSync('input.txt');
console.log("同步读取: " + data.toString());
console.log("程序执行完毕。");
以上代码执行结果如下：
$ node file.js
同步读取: 菜鸟教程官网地址：www.runoob.com
文件读取实例
程序执行完毕。
异步读取: 菜鸟教程官网地址：[www.runoob.com
](http://www.runoob.com)
文件读取实例
接下来，让我们来具体了解下 Node.js 文件系统的方法。
打开文件
语法
以下为在异步模式下打开文件的语法格式：
fs.open(path, flags[, mode], callback)
参数
参数使用说明如下：
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+’，但是如果文件路径不存在，则文件读取追加失败。
实例
接下来我们创建 file.js 文件，并打开 input.txt 文件进行读写，代码如下所示：
var fs = require("fs");
// 异步打开文件
console.log("准备打开文件！");
fs.open('input.txt', 'r+', function(err, fd) {
if (err) {
return console.error(err);
}
console.log("文件打开成功！");
});
以上代码执行结果如下：
$ node file.js
准备打开文件！
文件打开成功！
获取文件信息
语法
以下为通过异步模式获取文件信息的语法格式：
fs.stat(path, callback)
参数
参数使用说明如下：
path- 文件路径。callback- 回调函数，带有两个参数如：(err, stats), stats 是 fs.Stats 对象。
fs.stat(path)执行后，会将stats类的实例返回给其回调函数。可以通过stats类中的提供方法判断文件的相关属性。例如判断是否为文件：
var fs = require('fs');
fs.stat('/Users/liuht/code/itbilu/demo/fs.js', function (err, stats) {
console.log(stats.isFile()); //true
})
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。
实例
接下来我们创建 file.js 文件，代码如下所示：
var fs = require("fs");
console.log("准备打开文件！");
fs.stat('input.txt', function (err, stats) {
if (err) {
return console.error(err);
}
console.log(stats);
console.log("读取文件信息成功！");
// 检测文件类型
console.log("是否为文件 (isFile) ? " + stats.isFile());
console.log("是否为目录 (isDirectory) ? " + stats.isDirectory());
});
以上代码执行结果如下：
$ node file.js
准备打开文件！
{ dev: 16777220,
mode: 33188,
nlink: 1,
uid: 501,
gid: 20,
rdev: 0,
blksize: 4096,
ino: 40333161,
size: 61,
blocks: 8,
atime: Mon Sep 07 2015 17:43:55 GMT+0800 (CST),
mtime: Mon Sep 07 2015 17:22:35 GMT+0800 (CST),
ctime: Mon Sep 07 2015 17:22:35 GMT+0800 (CST) }
读取文件信息成功！
是否为文件(isFile) ? true
是否为目录(isDirectory) ? false
写入文件
语法
以下为异步模式下写入文件的语法格式：
fs.writeFile(filename, data[, options], callback)
如果文件存在，该方法写入的内容会覆盖旧的文件内容。
参数
参数使用说明如下：
path- 文件路径。data- 要写入文件的数据，可以是String(字符串) 或Buffer(流) 对象。options- 该参数是一个对象，包含 {encoding,mode,flag}。默认编码为utf8, 模式为 0666，flag为 ‘w’callback- 回调函数，回调函数只包含错误信息参数 (err)，在写入失败时返回。
实例
接下来我们创建 file.js 文件，代码如下所示：
var fs = require("fs");
console.log("准备写入文件");
fs.writeFile('input.txt', '我是通过写入的文件内容！', function(err) {
if (err) {
return console.error(err);
}
console.log("数据写入成功！");
console.log("--------我是分割线-------------")
console.log("读取写入的数据！");
fs.readFile('input.txt', function (err, data) {
if (err) {
return console.error(err);
}
console.log("异步读取文件数据: " + data.toString());
});
});
以上代码执行结果如下：
$ node file.js
准备写入文件
数据写入成功！
--------我是分割线-------------
读取写入的数据！
异步读取文件数据: 我是通过写入的文件内容
读取文件
语法
以下为异步模式下读取文件的语法格式：
fs.read(fd, buffer, offset, length, position, callback)
该方法使用了文件描述符来读取文件。
参数
参数使用说明如下：
fd- 通过fs.open()方法返回的文件描述符。buffer- 数据写入的缓冲区。offset- 缓冲区写入的写入偏移量。length- 要从文件中读取的字节数。position- 文件读取的起始位置，如果position的值为null，则会从当前文件指针的位置读取。callback- 回调函数，有三个参数err,bytesRead,buffer，err为错误信息，bytesRead表示读取的字节数，buffer为缓冲区对象。
实例
input.txt 文件内容为：
菜鸟教程官网地址：[www.runoob.com](http://www.runoob.com)
接下来我们创建 file.js 文件，代码如下所示：
var fs = require("fs");
var buf = new Buffer(1024);
console.log("准备打开已存在的文件！");
fs.open('input.txt','r+',function(){
if(err){
return console.error(err);
}
console.log("文件打开成功");
console.log("准备读取文件：");
fs.read(fd,buf,0,buf.length,0,function(){
if(err){
console.log(err);
}
console.log(bytes + " 字节被读取");
// 仅输出读取的字节
if(bytes > 0){
console.log(buf.slice(0,bytes).toString());
}
});
});
以上代码执行结果如下：
$ node file.js
准备打开已存在的文件！
文件打开成功！
准备读取文件：
42 字节被读取
菜鸟教程官网地址：[www.runoob.com](http://www.runoob.com)
关闭文件
语法
以下为异步模式下关闭文件的语法格式：
fs.close(fd, callback)
该方法使用了文件描述符来读取文件。
参数
参数使用说明如下：
fd- 通过 fs.open() 方法返回的文件描述符。callback- 回调函数，没有参数。
实例
input.txt 文件内容为：
菜鸟教程官网地址：[www.runoob.com](http://www.runoob.com)
接下来我们创建 file.js 文件，代码如下所示：
var fs = require("fs");
var buf = new Buffer(1024);
console.log("准备打开文件！");
fs.open('input.txt', 'r+', function(err, fd) {
if (err) {
return console.error(err);
}
console.log("文件打开成功！");
console.log("准备读取文件！");
fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
if (err){
console.log(err);
}
// 仅输出读取的字节
if(bytes > 0){
console.log(buf.slice(0, bytes).toString());
}
// 关闭文件
fs.close(fd, function(err){
if (err){
console.log(err);
}
console.log("文件关闭成功");
});
});
});
以上代码执行结果如下：
$ node file.js
准备打开文件！
文件打开成功！
准备读取文件！
菜鸟教程官网地址：[www.runoob.com
](http://www.runoob.com)
文件关闭成功
删除文件
语法
以下为删除文件的语法格式：
fs.unlink(path,callback);
参数
参数使用说明如下：
path- 文件路径。callback- 回调函数，没有参数。
实例
input.txt 文件内容为：
site:www.runoob.com
接下来我们创建 file.js 文件，代码如下所示：
var fs = require("fs");
console.log("准备删除文件！");
fs.unlink('input.txt',function(err){
if(err){
return console.error(err);
}
console.log("文件删除成功！");
});
以上代码执行结果如下：
$ node file.js
准备删除文件！
文件删除成功！
再去查看 input.txt 文件，发现已经不存在了。
创建目录
语法
以下为创建目录的语法格式：
fs.mkdir(path[,mode],callback)
参数
参数使用说明如下：
path- 文件路径。mode- 设置目录权限，默认为 0777。callback- 回调函数，没有参数。
实例
接下来我们创建 file.js 文件，代码如下所示：
var fs = require("fs");
console.log("创建目录 /tmp/test/");
fs.mkdir("/tmp/test/",function(err){
if (err) {
return console.error(err);
}
console.log("目录创建成功。");
});
以上代码执行结果如下：
$ node file.js
创建目录 /tmp/test/
目录创建成功。
读取目录
语法
以下为读取目录的语法格式：
fs.readdir(path,callback)
参数
参数使用说明如下：
path- 文件路径。callback- 回调函数，回调函数带有两个参数 err, files，err 为错误信息，files 为 目录下的文件数组列表。
实例
接下来我们创建 file.js 文件，代码如下所示：
var fs = require("fs");
console.log("查看 /tmp 目录");
fs.readdir("/tmp/",function(err,files){
if(err){
return console.error(err);
}
files.forEach(function(file){
console.log(file);
});
});
以上代码执行结果如下：
$ node file.js
查看 /tmp 目录
input.out
output.out
test
test.txt
删除目录
语法
以下为删除目录的语法格式：
fs.jrmdir(path,callback)
参数
参数使用说明如下：
path- 文件路径。callback- 回调函数，没有参数。
实例
接下来我们创建 file.js 文件，代码如下所示：
var fs = require("fs");
console.log("准备删除目录 /tmp/test");
fs.rmdir("/tmp/test",function(err){
if(err){
return console.error(err);
}
console.log("读取 /tmp 目录");
fs.readdir("/tmp",function(err,files){
if(err){
return console.error(err);
}
files.forEach(function(file){
console.log(file);
});
});
});
以上代码执行结果如下：
$ node file.js
准备删除目录 /tmp/test
input.out
output.out
test
test.txt
读取 /tmp 目录