Node.js 学习系列（五）—— 文件系统

Node.js 提供一组类似 UNIX（POSIX） 标准的文件操作API。 Node 导入文件系统模块 (fs) 语法如下所示：

var fs = require("fs")

异步和同步

Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本。

• 读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。

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

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

新建文件 text.txt ，内容如下：

https://www.baidu.com/

新建 main.js 文件，代码如下：

var file = require("fs");

file.readFile('text.txt',(err,data)=>{
	if(err) return console.log('file read err')
	console.log('异步读取！')
	console.log('data:',data.toString())
})

var data = file.readFileSync('text.txt');
console.log("同步读取! " );
console.log("data: "+ data.toString() );

console.log("Program End!")

执行代码，结果如下：

文件相关操作

打开文件

语法

异步模式下打开文件的语法格式：

fs.open(path, flags[, mode], callback)

参数

参数使用说明：

参数	描述
path	文件的路径
flags	文件打开的行为
mode	设置文件模式(权限)，文件创建默认权限为 0666(可读，可写)
callback	回调函数，带有两个参数如：callback(err, fd)

修改 main.js 文件，代码如下：

var file = require("fs");

console.log('准备打开文件！')
file.open('text.txt', 'r+', (err, data) => {
	if (err) return console.log('file read err')
	console.log('文件成功打开!')
})

console.log("Program End!")

执行程序，结果如下：

获取文件信息

语法

异步模式获取文件信息的语法格式：

fs.stat(path, callback)

参数

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

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

修改 main.js 文件，代码如下：

var file = require("fs");

console.log('准备获取文件信息！')
file.stat('D:/demo/node/text.txt', 'r+', (err, stats) => {
	if (err) return console.log('err', err)
	console.log('获取文件信息:', stats)
	// 检测文件类型
	console.log("是否为文件(isFile) ? " + stats.isFile());
	console.log("是否为目录(isDirectory) ? " + stats.isDirectory());
})

console.log("Program End!")

执行代码，结果如下：

写入文件

语法

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

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

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

参数

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

修改 main.js 文件，代码如下：

var file = require("fs");

console.log('准备写入文件！')
file.writeFile('D:/demo/node/text.txt', '这是通过file.writeFile写入的文件信息', (err) => {
	if (err) return console.log('err', err)
	console.log('信息写入成功！')

	console.log("准备读取写入的数据！");
	file.readFile('text.txt', (err, data) => {
		if (err) return console.error(err);
		console.log("异步读取文件数据: " + data.toString());
	});
})

console.log("Program End!")

执行代码，结果如下：

读取文件

语法

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

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

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

参数

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

刚才文件 text.txt 被上面的例子写入修改了 ，修改回来：

这是一个txt文件！

修改 main.js 文件，代码如下：

var file = require("fs");
var buf = new Buffer.alloc(1024);
console.log('准备打开文件！')
file.open('D:/demo/node/text.txt', 'r+', (err, fd) => {
	if (err) return console.log('err', err)
	console.log('信息打开成功！')

	console.log("准备读取数据！");
	file.read(fd, buf, 0, buf.length, 0, (err, bytes) => {
		if (err) return console.error(err);
		console.log("异步读取文件数据字节数: " + bytes);

		// 输出读取的字节
		if (bytes > 0) {
			console.log(buf.slice(0, bytes).toString());
		}
	});
})

console.log("Program End!")

执行代码，结果如下：

关闭文件

语法

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

fs.close(fd, callback)

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

参数

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

修改 main.js 文件，代码如下：

var file = require("fs");
var buf = new Buffer.alloc(1024);
console.log('准备打开文件！')
file.open('D:/demo/node/text.txt', 'r+', (err, fd) => {
	if (err) return console.log('err', err)
	console.log('信息打开成功！')

	console.log("准备读取数据！");
	file.read(fd, buf, 0, buf.length, 0, (err, bytes) => {
		if (err) return console.error(err);
		console.log("异步读取文件数据字节数: " + bytes);

		// 输出读取的字节
		if (bytes > 0) {
			console.log(buf.slice(0, bytes).toString());
		}

		// 关闭文件
		file.close(fd, (err) => {
			if (err) {
				console.log(err);
			}
			console.log("文件关闭成功");
		});
	})
})

console.log("Program End!")

执行代码，结果如下：

截取文件

语法

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

fs.ftruncate(fd, len, callback)

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

参数

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

修改 main.js 文件，代码如下：

var file = require("fs");
var buf = new Buffer.alloc(1024);
console.log('准备打开文件！')
file.open('D:/demo/node/text.txt', 'r+', (err, fd) => {
	if (err) return console.log('err', err)
	console.log('信息打开成功！')

	// 截取文件
	console.log("准备截取10字节内的文件内容，超出部分将被去除。")
	file.ftruncate(fd, 15, (err) => {
		if (err) {
			console.log(err);
		}
		console.log("截取文件成功！");
		file.read(fd, buf, 0, buf.length, 0, (err, bytes) => {
			if (err) return console.error(err);
			console.log("异步读取文件数据字节数: " + bytes);

			// 输出读取的字节
			if (bytes > 0) {
				console.log(buf.slice(0, bytes).toString());
			}

			// 关闭文件
			file.close(fd, (err) => {
				if (err) {
					console.log(err);
				}
				console.log("文件关闭成功");
			});
		})
	})

})

console.log("Program End!")

终端进入 D:/demo/node/ 执行代码，结果如下：

删除文件

语法

删除文件的语法格式：

fs.unlink(path, callback)

参数

参数	说明
fd	文件路径
callback	回调函数，没有参数

修改 main.js 文件，代码如下：

var file = require("fs");
console.log('准备删除文件！')
file.unlink('text.txt', (err) => {
	if (err) return console.log('err', err)
	console.log('删除文件成功！')
})

console.log("Program End!")

删除前文件目录：

终端进入 D:/demo/node/ 执行代码，结果如下：

打开目录，可以看到 text.txt 文件不在了，如下：

文件夹相关操作

创建目录

语法

创建目录的语法格式：

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

参数

参数使用说明如下：

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

修改 main.js 文件，代码如下：

var file = require("fs");
console.log('准备创建文件夹！')
// abcd 前面的目录必须存在
file.mkdir('/demo/node/abcd', (err) => {
	if (err) return console.log('err', err)
	console.log('创建文件夹成功！')
})

console.log("Program End!")

创建文件夹前：

终端进入 D:/demo/node/ 执行代码，结果如下：

打开目录，可以看到新创建的文件夹：

可以添加 recursive: true 参数，这时候不用管创建的目录 /test 和 /test/a 是否存在。

修改 main.js 文件，代码如下：

var file = require("fs");
console.log('准备创建文件夹！')

file.mkdir('/demo/node/test/a/b', { recursive: true }, (err) => {
	if (err) return console.log('err', err)
	console.log('创建文件夹成功！')
})

console.log("Program End!")

代码执行完成，打开目录，可以看到已经创建好的目录：

读取目录

语法

读取目录的语法格式：

fs.readdir(path, callback)

参数

参数	说明
fd	文件路径
callback	回调函数，回调函数带有两个参数err, files，err 为错误信息，files 为 目录下的文件数组列表。

修改 main.js 文件，代码如下：

var file = require("fs");
console.log('准备读取目录！')
file.readdir('/demo/node/', (err, files) => {
	if (err) return console.log('err', err)
	console.log('读取目录成功！')
	files.forEach((file) => {
		console.log(file);
	})
})

console.log("Program End!")

终端进入 D:/demo/node/ 执行代码，结果如下：

删除目录

语法

删除目录的语法格式：

fs.rmdir(path, callback)

参数

参数	说明
fd	文件路径
callback	回调函数，没有参数

修改 main.js 文件，代码如下：

var file = require("fs");
console.log('准备删除目录！')
file.rmdir('/demo/node/test/a/b', (err) => {
	if (err) return console.log('err', err)
	console.log('删除目录成功！')
	file.readdir("/demo/node/test/a", (err, files) => {
		if (err) {
			return console.error(err);
		}
		files.forEach((file) => {
			console.log(file);
		});
	})
})

console.log("Program End!")

删除目录前：

终端进入 D:/demo/node/ 执行代码，结果如下：

打开目录，可以看到 D:/demo/node/test/a 下面的 /b 文件夹已经删除成功了：