[node] Node.js的文件系统

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标志说明:

示例

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类中的方法有：

示例

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 文件模块的方法列表：