Node.js - 文件系统( File System)
Node使用围绕标准POSIX函数的简单包装器实现文件I/O. 可以使用以下语法导入节点文件系统（fs）模块 -
var fs = require("fs")
同步与异步
fs模块中的每个方法都有同步和异步形式。 异步方法将最后一个参数作为完成函数回调，将回调函数的第一个参数作为错误。 最好使用异步方法而不是同步方法，因为前者在执行期间从不阻塞程序，而第二种方法则执行。
例子 (Example)
使用以下内容创建名为input.txt的文本文件 -
IOWIKI is giving self learning content
to teach the world in simple and easy way!!!!!
让我们使用以下代码创建一个名为main.js的js文件 -
var fs = require("fs");
// Asynchronous read
fs.readFile('input.txt', function (err, data) {
if (err) {
return console.error(err);
}
console.log("Asynchronous read: " + data.toString());
});
// Synchronous read
var data = fs.readFileSync('input.txt');
console.log("Synchronous read: " + data.toString());
console.log("Program Ended");
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Synchronous read: IOWIKI is giving self learning content
to teach the world in simple and easy way!!!!!
Program Ended
Asynchronous read: IOWIKI is giving self learning content
to teach the world in simple and easy way!!!!!
本章的以下部分提供了一组关于主要文件I/O方法的优秀示例。
打开文件
语法 (Syntax)
以下是以异步模式打开文件的方法的语法 -
fs.open(path, flags[, mode], callback)
参数 (Parameters)
以下是所用参数的说明 -
path - 这是包含路径的文件名的字符串。
flags - 标志指示要打开的文件的行为。 下面提到了所有可能的值。
mode - 设置文件模式（权限和粘滞位），但仅限于创建文件的情况。 它默认为0666，可读和可写。
callback - 这是回调函数，它获取两个参数（err，fd）。
Flags
读/写操作的标志是 -
| Sr.No. | 标志和描述 |
|---|---|
| 1 | r 打开文件进行阅读。 如果文件不存在，则会发生异常。 |
| 2 | r+ 打开文件进行读写。 如果文件不存在，则会发生异常。 |
| 3 | rs 打开文件以便以同步模式读取。 |
| 4 | rs+ 打开文件进行读写，要求操作系统同步打开它。 请参阅“rs”的注释，谨慎使用。 |
| 5 | w 打开文件进行写作。 创建文件（如果它不存在）或截断（如果存在）。 |
| 6 | wx 像'w'，但如果路径存在则失败。 |
| 7 | w+ 打开文件进行读写。 创建文件（如果它不存在）或截断（如果存在）。 |
| 8 | wx+ 像'w +'但是如果路径存在则失败。 |
| 9 | a 打开文件进行追加。 如果文件不存在，则创建该文件。 |
| 10 | ax 像'a'，但如果路径存在则失败。 |
| 11 | a+ 打开文件进行阅读和追加。 如果文件不存在，则创建该文件。 |
| 12 | ax+ 像'a +'一样，但如果路径存在则失败。 |
例子 (Example)
让我们创建一个名为main.js的js文件，其中包含以下代码，用于打开文件input.txt进行读写。
var fs = require("fs");
// Asynchronous - Opening File
console.log("Going to open file!");
fs.open('input.txt', 'r+', function(err, fd) {
if (err) {
return console.error(err);
}
console.log("File opened successfully!");
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to open file!
File opened successfully!
获取文件信息
语法 (Syntax)
以下是获取文件信息的方法的语法 -
fs.stat(path, callback)
参数 (Parameters)
以下是所用参数的说明 -
path - 这是包含路径的文件名的字符串。
callback - 这是回调函数，它获取两个参数（err，stats），其中stats是fs.Stats类型的对象，在下面的示例中打印。
除了示例中下面打印的重要属性外， fs.Stats类中还有一些有用的方法可用于检查文件类型。 这些方法在下表中给出。
| Sr.No. | 方法和描述 |
|---|---|
| 1 | stats.isFile() 如果是简单文件的文件类型，则返回true。 |
| 2 | stats.isDirectory() 如果目录的文件类型，则返回true。 |
| 3 | stats.isBlockDevice() 如果块设备的文件类型，则返回true。 |
| 4 | stats.isCharacterDevice() 如果字符设备的文件类型，则返回true。 |
| 5 | stats.isSymbolicLink() 如果符号链接的文件类型，则返回true。 |
| 6 | stats.isFIFO() 如果FIFO的文件类型，则返回true。 |
| 7 | stats.isSocket() 如果文件类型为asocket，则返回true。 |
例子 (Example)
让我们使用以下代码创建一个名为main.js的js文件 -
var fs = require("fs");
console.log("Going to get file info!");
fs.stat('input.txt', function (err, stats) {
if (err) {
return console.error(err);
}
console.log(stats);
console.log("Got file info successfully!");
// Check file type
console.log("isFile ? " + stats.isFile());
console.log("isDirectory ? " + stats.isDirectory());
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to get file info!
{
dev: 1792,
mode: 33188,
nlink: 1,
uid: 48,
gid: 48,
rdev: 0,
blksize: 4096,
ino: 4318127,
size: 97,
blocks: 8,
atime: Sun Mar 22 2015 13:40:00 GMT-0500 (CDT),
mtime: Sun Mar 22 2015 13:40:57 GMT-0500 (CDT),
ctime: Sun Mar 22 2015 13:40:57 GMT-0500 (CDT)
}
Got file info successfully!
isFile ? true
isDirectory ? false
写一个文件 (Writing a File)
语法 (Syntax)
以下是写入文件的方法之一的语法 -
fs.writeFile(filename, data[, options], callback)
如果文件已存在，此方法将覆盖该文件。 如果要写入现有文件，则应使用其他可用方法。
参数 (Parameters)
以下是所用参数的说明 -
path - 这是包含路径的文件名的字符串。
data - 这是要写入文件的String或Buffer。
options - 第三个参数是一个保存{encoding，mode，flag}的对象。 默认情况下。 编码是utf8，模式是八进制值0666.而标志是'w'
callback - 这是一个回调函数，它获取一个参数err，在出现任何写入错误时返回错误。
例子 (Example)
让我们创建一个名为main.js的js文件，其中包含以下代码 -
var fs = require("fs");
console.log("Going to write into existing file");
fs.writeFile('input.txt', 'Simply Easy Learning!', function(err) {
if (err) {
return console.error(err);
}
console.log("Data written successfully!");
console.log("Let's read newly written data");
fs.readFile('input.txt', function (err, data) {
if (err) {
return console.error(err);
}
console.log("Asynchronous read: " + data.toString());
});
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to write into existing file
Data written successfully!
Let's read newly written data
Asynchronous read: Simply Easy Learning!
Reading a File
语法 (Syntax)
以下是从文件中读取的方法之一的语法 -
fs.read(fd, buffer, offset, length, position, callback)
此方法将使用文件描述符来读取文件。 如果要使用文件名直接读取文件，则应使用其他可用方法。
参数 (Parameters)
以下是所用参数的说明 -
fd - 这是fs.open（）返回的文件描述符。
buffer - 这是将数据写入的缓冲区。
offset - 这是缓冲区中开始写入的偏移量。
length - 这是一个整数，指定要读取的字节数。
position - 这是一个整数，指定从文件中开始读取的位置。 如果position为null，则将从当前文件位置读取数据。
callback - 这是回调函数，它获取三个参数，（错误，bytesRead，缓冲区）。
例子 (Example)
让我们使用以下代码创建一个名为main.js的js文件 -
var fs = require("fs");
var buf = new Buffer(1024);
console.log("Going to open an existing file");
fs.open('input.txt', 'r+', function(err, fd) {
if (err) {
return console.error(err);
}
console.log("File opened successfully!");
console.log("Going to read the file");
fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
if (err){
console.log(err);
}
console.log(bytes + " bytes read");
// Print only read bytes to avoid junk.
if(bytes > 0){
console.log(buf.slice(0, bytes).toString());
}
});
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to open an existing file
File opened successfully!
Going to read the file
97 bytes read
IOWIKI is giving self learning content
to teach the world in simple and easy way!!!!!
关闭一个文件 (Closing a File)
语法 (Syntax)
以下是关闭打开文件的语法 -
fs.close(fd, callback)
参数 (Parameters)
以下是所用参数的说明 -
fd - 这是文件fs.open（）方法返回的文件描述符。
callback - 这是回调函数除了可能的异常之外，没有给完成回调的参数。
例子 (Example)
让我们创建一个名为main.js的js文件，其中包含以下代码 -
var fs = require("fs");
var buf = new Buffer(1024);
console.log("Going to open an existing file");
fs.open('input.txt', 'r+', function(err, fd) {
if (err) {
return console.error(err);
}
console.log("File opened successfully!");
console.log("Going to read the file");
fs.read(fd, buf, 0, buf.length, 0, function(err, bytes) {
if (err) {
console.log(err);
}
// Print only read bytes to avoid junk.
if(bytes > 0) {
console.log(buf.slice(0, bytes).toString());
}
// Close the opened file.
fs.close(fd, function(err) {
if (err) {
console.log(err);
}
console.log("File closed successfully.");
});
});
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to open an existing file
File opened successfully!
Going to read the file
IOWIKI is giving self learning content
to teach the world in simple and easy way!!!!!
File closed successfully.
截断文件
语法 (Syntax)
以下是截断打开文件的方法的语法 -
fs.ftruncate(fd, len, callback)
参数 (Parameters)
以下是所用参数的说明 -
fd - 这是fs.open（）返回的文件描述符。
len - 这是文件的长度，之后文件将被截断。
callback - 这是回调函数除了可能的异常之外，没有给完成回调的参数。
例子 (Example)
让我们创建一个名为main.js的js文件，其中包含以下代码 -
var fs = require("fs");
var buf = new Buffer(1024);
console.log("Going to open an existing file");
fs.open('input.txt', 'r+', function(err, fd) {
if (err) {
return console.error(err);
}
console.log("File opened successfully!");
console.log("Going to truncate the file after 10 bytes");
// Truncate the opened file.
fs.ftruncate(fd, 10, function(err) {
if (err) {
console.log(err);
}
console.log("File truncated successfully.");
console.log("Going to read the same file");
fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
if (err) {
console.log(err);
}
// Print only read bytes to avoid junk.
if(bytes > 0) {
console.log(buf.slice(0, bytes).toString());
}
// Close the opened file.
fs.close(fd, function(err) {
if (err) {
console.log(err);
}
console.log("File closed successfully.");
});
});
});
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to open an existing file
File opened successfully!
Going to truncate the file after 10 bytes
File truncated successfully.
Going to read the same file
Tutorials
File closed successfully.
删除文件
语法 (Syntax)
以下是删除文件的方法的语法 -
fs.unlink(path, callback)
参数 (Parameters)
以下是所用参数的说明 -
path - 这是包含路径的文件名。
callback - 这是回调函数除了可能的异常之外，没有给完成回调的参数。
例子 (Example)
让我们创建一个名为main.js的js文件，其中包含以下代码 -
var fs = require("fs");
console.log("Going to delete an existing file");
fs.unlink('input.txt', function(err) {
if (err) {
return console.error(err);
}
console.log("File deleted successfully!");
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to delete an existing file
File deleted successfully!
创建目录
语法 (Syntax)
以下是创建目录的方法的语法 -
fs.mkdir(path[, mode], callback)
参数 (Parameters)
以下是所用参数的说明 -
path - 这是包含路径的目录名称。
mode - 这是要设置的目录权限。 默认为0777。
callback - 这是回调函数除了可能的异常之外，没有给完成回调的参数。
例子 (Example)
让我们创建一个名为main.js的js文件，其中包含以下代码 -
var fs = require("fs");
console.log("Going to create directory /tmp/test");
fs.mkdir('/tmp/test',function(err) {
if (err) {
return console.error(err);
}
console.log("Directory created successfully!");
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to create directory /tmp/test
Directory created successfully!
阅读目录
语法 (Syntax)
以下是读取目录的方法的语法 -
fs.readdir(path, callback)
参数 (Parameters)
以下是所用参数的说明 -
path - 这是包含路径的目录名称。
callback - 这是回调函数，它获取两个参数（错误，文件），其中files是目录中文件名的数组，不包括'。' 和'..'。
例子 (Example)
让我们创建一个名为main.js的js文件，其中包含以下代码 -
var fs = require("fs");
console.log("Going to read directory /tmp");
fs.readdir("/tmp/",function(err, files) {
if (err) {
return console.error(err);
}
files.forEach( function (file) {
console.log( file );
});
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to read directory /tmp
ccmzx99o.out
ccyCSbkF.out
employee.ser
hsperfdata_apache
test
test.txt
删除目录
语法 (Syntax)
以下是删除目录的方法的语法 -
fs.rmdir(path, callback)
参数 (Parameters)
以下是所用参数的说明 -
path - 这是包含路径的目录名称。
callback - 这是回调函数除了可能的异常之外，没有给完成回调的参数。
例子 (Example)
让我们创建一个名为main.js的js文件，其中包含以下代码 -
var fs = require("fs");
console.log("Going to delete directory /tmp/test");
fs.rmdir("/tmp/test",function(err) {
if (err) {
return console.error(err);
}
console.log("Going to read directory /tmp");
fs.readdir("/tmp/",function(err, files) {
if (err) {
return console.error(err);
}
files.forEach( function (file) {
console.log( file );
});
});
});
现在运行main.js来查看结果 -
$ node main.js
验证输出。
Going to read directory /tmp
ccmzx99o.out
ccyCSbkF.out
employee.ser
hsperfdata_apache
test.txt
