Node.js 提供一组类似 UNIX（POSIX）标准的文件操作API

文件系统的使用

Node 导入文件系统模块(fs)语法如下：

var fs = require("fs")

异步和同步

Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。

异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。

建议使用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞。

input.txt

文件读取实例

示例

main.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 main.js
//输出
// 同步读取: Test for read// 程序执行完毕。
// 异步读取: Test for read

常用方法

打开文件

语法

异步模式下打开文件:

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+’， 但是如果文件路径存在，则文件读取追加失败。

示例

var fs = require("fs");
// 异步打开文件
console.log("准备打开文件！");
fs.open('input.txt', 'r+', function(err, fd) {if (err) {return console.error(err);}console.log("文件打开成功！");     
});
//终端执行 node main.js
//输出
// 准备打开文件！
// 文件打开成功！

获取文件信息

语法

异步模式下获取文件信息:

fs.stat(path, callback)

• path - 文件路径
• callback - 回调函数，带有两个参数如：(err, stats), stats 是 fs.Stats 对象

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

示例

fs.stat(path)执行后，会将stats类的实例返回给其回调函数。可以通过stats类中的提供方法判断文件的相关属性。例如判断是否为文件

var fs = require('fs');
fs.stat('/demo/fs.js', function (err, stats) {console.log(stats.isFile());         //true
})

写入文件

语法

异步模式下写入文件语法格式:

fs.writeFile(file, data[, options], callback)

writeFile 直接打开文件默认是 w 模式，所以如果文件存在，该方法写入的内容会覆盖旧的文件内容。

• file - 文件名或文件描述符
• data - 要写入文件的数据，可以是 String(字符串) 或 Buffer(缓冲) 对象
• options - 该参数是一个对象，包含 {encoding, mode, flag}。默认编码为 utf8, 模式为 0666 ， flag 为 ‘w’,这里flag的取值可以参考打开文件中flag的取值范围
• callback - 回调函数，回调函数只包含错误信息参数(err)，在写入失败时返回

示例

mian.js

var fs = require("fs");
console.log("准备写入文件");
fs.writeFile('input.txt', '通过fs.writeFile 写入文件的内容',  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 main.js
//输出
// 准备写入文件
// 数据写入成功！
// --------分割线-------------
// 读取写入的数据！
// 异步读取文件数据: 通过fs.writeFile 写入文件的内容

读取文件

语法

异步模式下读取文件语法格式:

fs.read(fd, buffer, offset, length, position, callback)

该方法使用了文件描述符来读取文件

• fd - 通过 fs.open() 方法返回的文件描述符
• buffer - 数据写入的缓冲区
• offset - 缓冲区写入的写入偏移量
• length - 要从文件中读取的字节数
• position - 文件读取的起始位置，如果 position 的值为 null，则会从当前文件指针的位置读取
• callback - 回调函数，有三个参数err, bytesRead, buffer，err 为错误信息， bytesRead 表示读取的字节数，buffer 为缓冲区对象

示例

mian.js

var fs = require("fs");
var buf = new Buffer.alloc(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);}console.log(bytes + "  字节被读取");// 仅输出读取的字节if(bytes > 0){console.log(buf.slice(0, bytes).toString());}});
});
//终端执行 node main.js
//txt文件内容是: 文件读取实例
//输出
// 准备打开已存在的文件！
// 文件打开成功！
// 准备读取文件：
// 20  字节被读取
// 文件读取实例

关闭文件

语法

异步模式下关闭文件语法格式:

fs.close(fd, callback)

• fd - 通过 fs.open() 方法返回的文件描述符
• callback - 回调函数，没有参数

示例

mian.js

var fs = require("fs");
var buf = new Buffer.alloc(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 main.js
//输出
// 准备打开文件！
// 文件打开成功！
// 准备读取文件！
// 文件读取实例// 文件关闭成功

截取文件

语法

异步模式下截取文件语法格式:

fs.ftruncate(fd, len, callback)

• fd - 通过 fs.open() 方法返回的文件描述符
• len - 文件内容截取的长度
• callback - 回调函数，没有参数

示例

input.txt

Test for read or write!!!

mian.js

var fs = require("fs");
console.log("准备写入文件");
fs.writeFile('input.txt', '通过fs.writeFile 写入文件的内容',  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 main.js
//输出
// 准备打开文件！
// 文件打开成功！
// 截取10字节内的文件内容，超出部分将被去除。
// 文件截取成功。
// 读取相同的文件
// Test for r
// 文件关闭成功！

删除文件

语法

删除文件语法格式:

fs.unlink(path, callback)

• path - 文件路径
• callback - 回调函数，没有参数

示例

mian.js

var fs = require("fs");
console.log("准备删除文件！");
fs.unlink("input.txt", function (err) {if (err) {return console.error(err);}console.log("文件删除成功！");
});
//终端执行 node main.js
//输出
// 准备删除文件！
// 文件删除成功！

此时 input.txt 文件已经不存在

创建目录

语法

异步模式下创建目录语法格式:

fs.mkdir(path[, options], callback)

• path - 文件路径
• options - 参数可以是：
  • recursive - 是否以递归的方式创建目录，默认 false
  • mode - 设置目录权限，默认为 0777
• callback - 回调函数，没有参数

示例

mian.js

var fs = require("fs");console.log("创建目录 /tmp/");
fs.mkdir("/tmp/", function (err) {if (err) {return console.error(err);}console.log("目录创建成功。");
});
//终端执行 node main.js
//输出
// 创建目录 /tmp/
// 目录创建成功。

若是创建的是嵌套的目录，例如"/temp/test/，必须保证上级目录temp存在，否则会导致报错

若是不存在上级目录而成功创建test,则需添加参数recursive,因为该参数用于控制是否递归创建目录:

fs.mkdir('/temp/test', { recursive: true }, (err) => {if (err) throw err;
});

读取目录

语法

异步模式下读取目录语法格式:

fs.readdir(path, callback)

• path - 文件路径
• callback - 回调函数，回调函数带有两个参数:
  • err 为错误信息
  • files 为 目录下的文件数组列表。

示例

mian.js

var fs = require("fs");
console.log("查看 /bin 目录");
fs.readdir("bin/", function (err, files) {if (err) {return console.error(err);}files.forEach(function (file) {console.log(file);});
});
//终端执行 node main.js
//输出
// 查看 /bin 目录
// index.js
// readme.md

删除目录

语法

删除目录语法格式:

fs.rmdir(path, callback)

• path - 文件路径
• callback - 回调函数，没有参数。

示例

mian.js

var fs = require("fs");
// 执行前创建一个空的 temp/test 目录
console.log("准备删除目录 temp/test");
fs.rmdir("temp/test", function (err) {if (err) {return console.error(err);}console.log("读取 temp 目录");fs.readdir("temp", function (err, files) {if (err) {return console.error(err);}files.forEach(function (file) {console.log(file);});});
});
//终端执行 node main.js
//输出
// 准备删除目录 temp/test
// 读取 temp 目录

文件模块方法

以下为 Node.js 文件模块的方法列表：

方法	描述
fs.rename(oldPath, newPath, callback)	异步 rename().回调函数没有参数，但可能抛出异常
fs.ftruncate(fd, len, callback)	异步 ftruncate().回调函数没有参数，但可能抛出异常
fs.ftruncateSync(fd, len)	同步 ftruncate()
fs.truncate(path, len, callback)	异步 truncate().回调函数没有参数，但可能抛出异常。
fs.truncateSync(path, len)	同步 truncate()
fs.chown(path, uid, gid, callback)	异步 chown().回调函数没有参数，但可能抛出异常。
fs.chownSync(path, uid, gid)	同步 chown()
fs.fchown(fd, uid, gid, callback)	异步 fchown().回调函数没有参数，但可能抛出异常。
fs.fchownSync(fd, uid, gid)	同步 fchown()
fs.lchown(path, uid, gid, callback)	异步 lchown().回调函数没有参数，但可能抛出异常。
fs.lchownSync(path, uid, gid)	同步 lchown()
fs.chmod(path, mode, callback)	异步 chmod().回调函数没有参数，但可能抛出异常。
fs.chmodSync(path, mode)	同步 chmod().
fs.fchmod(fd, mode, callback)	异步 fchmod().回调函数没有参数，但可能抛出异常。
fs.fchmodSync(fd, mode)	同步 fchmod().
fs.lchmod(path, mode, callback)	异步 lchmod().回调函数没有参数，但可能抛出异常。Only available on Mac OS X.
fs.lchmodSync(path, mode)	同步 lchmod().
fs.stat(path, callback)	异步 stat(). 回调函数有两个参数 err, stats，stats 是 fs.Stats 对象。
fs.lstat(path, callback)	异步 lstat(). 回调函数有两个参数 err, stats，stats 是 fs.Stats 对象。
fs.fstat(fd, callback)	异步 fstat(). 回调函数有两个参数 err, stats，stats 是 fs.Stats 对象。
fs.statSync(path)	同步 stat(). 返回 fs.Stats 的实例。
fs.lstatSync(path)	同步 lstat(). 返回 fs.Stats 的实例。
fs.fstatSync(fd)	同步 fstat(). 返回 fs.Stats 的实例。
fs.link(srcpath, dstpath, callback)	异步 link().回调函数没有参数，但可能抛出异常。
fs.linkSync(srcpath, dstpath)	同步 link().
fs.symlink(srcpath, dstpath[, type], callback)	异步 symlink().回调函数没有参数，但可能抛出异常。 type 参数可以设置为 ‘dir’, ‘file’, 或 ‘junction’ (默认为 ‘file’) 。
fs.symlinkSync(srcpath, dstpath[, type])	同步 symlink().
fs.readlink(path, callback)	异步 readlink(). 回调函数有两个参数 err, linkString。
fs.realpath(path[, cache], callback)	异步 realpath(). 回调函数有两个参数 err, resolvedPath。
fs.realpathSync(path[, cache])	同步 realpath()。返回绝对路径。
fs.unlink(path, callback)	异步 unlink().回调函数没有参数，但可能抛出异常。
fs.unlinkSync(path)	同步 unlink().
fs.rmdir(path, callback)	异步 rmdir().回调函数没有参数，但可能抛出异常。
fs.rmdirSync(path)	同步 rmdir().
fs.mkdir(path[, mode], callback)	S异步 mkdir(2).回调函数没有参数，但可能抛出异常。 访问权限默认为 0777。
fs.mkdirSync(path[, mode])	同步 mkdir().
fs.readdir(path, callback)	异步 readdir(3). 读取目录的内容。
fs.readdirSync(path)	同步 readdir().返回文件数组列表。
fs.close(fd, callback)	异步 close().回调函数没有参数，但可能抛出异常。
fs.closeSync(fd)	同步 close().
fs.open(path, flags[, mode], callback)	异步打开文件。
fs.openSync(path, flags[, mode])	同步 version of fs.open().
fs.utimes(path, atime, mtime, callback)	异步修改指定路径path的文件时间戳
fs.utimesSync(path, atime, mtime)	修改指定路径path的文件时间戳
fs.futimes(fd, atime, mtime, callback)	异步修改文件时间戳，通过文件描述符指定
fs.futimesSync(fd, atime, mtime)	修改文件时间戳，通过文件描述符指定。
fs.fsync(fd, callback)	异步 fsync.回调函数没有参数，但可能抛出异常。
fs.fsyncSync(fd)	同步 fsync.
fs.write(fd, buffer, offset, length[, position], callback)	将缓冲区内容写入到通过文件描述符指定的文件。
fs.write(fd, data[, position[, encoding]], callback)	通过文件描述符 fd 写入文件内容。
fs.writeSync(fd, buffer, offset, length[, position])	同步版的 fs.write()。
fs.writeSync(fd, data[, position[, encoding]])	同步版的 fs.write().
fs.read(fd, buffer, offset, length, position, callback)	通过文件描述符 fd 读取文件内容。
fs.readSync(fd, buffer, offset, length, position)	同步版的 fs.read.
fs.readFile(filename[, options], callback)	异步读取文件内容。
fs.readFileSync(filename[, options])	fs.writeFile(filename, data[, options], callback)
fs.writeFileSync(filename, data[, options])	同步版的 fs.writeFile。
fs.appendFile(filename, data[, options], callback)	异步追加文件内容。
fs.appendFileSync(filename, data[, options])	The 同步 version of fs.appendFile.
fs.watchFile(filename[, options], listener)	查看文件的修改。
fs.unwatchFile(filename[, listener])	停止查看 filename 的修改。
fs.watch(filename[, options][, listener])	查看 filename 的修改，filename 可以是文件或目录。返回 fs.FSWatcher 对象。
fs.exists(path, callback)	检测给定的路径是否存在。
fs.existsSync(path)	同步版的 fs.exists.
fs.access(path[, mode], callback)	测试指定路径用户权限
fs.accessSync(path[, mode])	同步版的 fs.access
fs.createReadStream(path[, options])	返回ReadStream 对象
fs.createWriteStream(path[, options])	返回 WriteStream 对象
fs.symlink(srcpath, dstpath[, type], callback)	异步 symlink().回调函数没有参数，但可能抛出异常