引入:
var fs = require("fs");
Node.js 文件系统(fs 模块)模块中的方法均有异步和同步版本。异步的方法函数最后一个参数为回调函数,回调函数的第一个参数包含了错误信息(error)。建议大家使用异步方法,比起同步,异步方法性能更高,速度更快,而且没有阻塞。
实例:
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("程序执行完毕。");
语法:
fs.open(path, falgs[, mode], callback)
说明:
- path - 文件的路径。
- flags - 文件打开的行为。具体值详见下文。
- mode - 设置文件模式(权限),文件创建默认权限为 0666(可读,可写)。
- callback - 回调函数,带有两个参数如:callback(err, fd)。
falgs参数:
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("文件打开成功!");
});
语法:
fs.stat(path, callback)
说明:
- path - 文件路径。
- callback - 回调函数,带有两个参数如:(err, stats), stats 是 fs.Stats 对象。
stats类中的方法:
方法 | 描述 |
---|---|
stats.isFile() | 如果是文件返回 true,否则返回 false。 |
stats.isDirectory() | 如果是目录返回 true,否则返回 false。 |
语法(异步模式):
fs.writeFile(file, data[, options], callback)
注意: writeFile 直接打开文件默认是 w 模式,所以如果文件存在,该方法写入的内容会覆盖旧的文件内容。
说明:
- file - 文件名或文件描述符。
- data - 要写入文件的数据,可以是 String(字符串) 或 Buffer(缓冲) 对象。
- options - 该参数是一个对象,包含 {encoding, mode, flag}。默认编码为 utf8, 模式为 0666 , flag 为 'w'。
- callback - 回调函数,回调函数只包含错误信息参数(err),在写入失败时返回。
语法(异步模式):
fs.read(fd, buffer, offset, length, position, callback)
说明:
- fd - 通过 fs.open() 方法返回的文件描述符。
- buffer - 数据写入的缓冲区。
- offset - 缓冲区写入的写入偏移量。
- length - 要从文件中读取的字节数。
- position - 文件读取的起始位置,如果 position 的值为 null,则会从当前文件指针的位置读取。
- callback - 回调函数,有三个参数err, bytesRead, buffer,err 为错误信息, bytesRead 表示读取的字节数,- - - buffer 为缓冲区对象。
语法(异步模式):
fs.close(fd, callback)
说明:
- fd - 通过 fs.open() 方法返回的文件描述符。
- callback - 回调函数,没有参数。
语法:
fs.ftruncate(fd, len, callback)
说明:
- fd - 通过 fs.open() 方法返回的文件描述符。
- len - 文件内容截取的长度。
- callback - 回调函数,没有参数。
语法:
fs.unlink(path, callback)
说明:
- path - 文件路径。
- callback - 回调函数,没有参数。
语法:
fs.mkdir(path[, mode], callback)
说明:
- path - 文件路径。
- mode - 设置目录权限,默认为 0777。
- callback - 回调函数,没有参数。
语法:
fs.readdir(path, callback)
说明:
- path - 文件路径。
- callback - 回调函数,回调函数带有两个参数err, files,err 为错误信息,files 为 目录下的文件数组列表。
语法:
fs.rmdir(path, callback)
说明:
- path - 文件路径。
- callback - 回调函数,没有参数。
方法 | 描述 |
---|---|
fs.rename(oldPath, newPath, callback) | 文件重命名 |
fs.existsSync(path) | 判断文件是否存在 |
fs.appendFile(filename, data[, options], callback) | 异步追加文件内容 |
fs.watchFile(filename[, options], listener) | 查看文件的修改 |