本文详细介绍Node.js中fs模块对目录和文件的核心操作方法。涵盖异步与同步的目录创建(mkdir)、目录读取(readdir),以及通过stat、lstat和fstat获取文件详细属性。同时讲解如何修改文件的访问与修改时间(utimes)及读写权限(chmod),并提供相关代码示例与参数说明。
目录操作
- 若目标目录已存在,则创建操作将失败。
- 同步创建目录使用 fs.mkdirSync(path, [mode]) 方法。
const fs = require('fs');
let mkdir = './mkdir';
fs.mkdir(mkdir, (err) => {
if (err) {
console.log(`mkdir ${mkdir} file failed~`);
} else {
console.log(`mkdir ${mkdir} file success~`);
}
});
读取目录内容
- 当读取的目录下包含子目录或文件时,返回的 files 数组将包含这些子目录或文件的名称。
- 同步读取目录使用 fs.readdirSync() 方法。
const fs = require('fs');
let mkdir = './mkdir';
fs.mkdir(mkdir, (err) => {
if (err) {
console.log(`mkdir ${mkdir} file failed~`);
return false;
}
console.log(`mkdir ${mkdir} file success~`);
let fileName = ['ONE', 'TWO', 'THREE'];
fileName.forEach((elem) => {
fs.mkdir(`${mkdir}/${elem}`, (err) => {
if (err) {
console.log(`${mkdir}/${elem} failed~`);
return false;
}
});
fs.readdir(mkdir, (err, files) => {
if (err) {
console.log(`readdir ${mkdir} file failed~`);
return false;
}
console.log(`readdir ${mkdir} file success~`);
console.log(`${files}`);
});
});
});
查看与修改文件或目录信息
- 在 fs 模块中,可通过 stat 或 lstat 方法查看文件或目录信息。两者的主要区别在于处理符号链接时:若需获取符号链接本身的信息,必须使用 lstat 方法。
- 异步查看文件信息:fs.stat(path, callback(err, stats))
- 异步查看符号链接信息:fs.lstat(path, callback(err, stats))
查看文件信息
同步查看文件信息使用 fs.statSync(path) 方法。
const fs = require('fs');
let mkdir = './mkdir';
fs.stat(mkdir, (err, stats) => {
if (err) {
console.log(`fs.stats ${mkdir} file failed~`);
} else {
console.log(`fs.stats ${mkdir} file success~`);
console.log(stats);
}
});
stats 对象详解
Stats {
dev: 2050,文件或目录所在的设备ID,仅在UNIX有效
mode: 16877,使用数值形式代表的文件或目录的权限标志
nlink: 3,文件或目录的硬连接数量
uid: 0,文件或目录的所有者的用户ID,仅在UNIX有效
gid: 0,文件或目录的所有者的用户组ID,仅在UNIX有效
rdev: 0,为字符设备文件或块设备文件所在设备ID,仅在UNIX有效
blksize: 4096,
ino: 4197533,文件或目录的索引编号,仅在UNIX有效
size: 4096,文件尺寸,即文件中的字节数
blocks: 8,
atimeMs: 1511846425357.986,
mtimeMs: 1511846425256.986,
ctimeMs: 1511846425256.986,
birthtimeMs: 1511846425256.986,
atime: 2017-11-28T05:20:25.358Z,文件的访问时间
mtime: 2017-11-28T05:20:25.257Z,文件的修改时间
ctime: 2017-11-28T05:20:25.257Z,文件的创建时间
birthtime: 2017-11-28T05:20:25.257Z
}
fstat 方法用于查询文件信息
当使用 open 或 openSync 方法打开文件并获取文件描述符后,可利用 fs 模块中的 fstat 方法来查询该已打开文件的信息。
const fs = require('fs');
let mkdir = './mkdir';
fs.open(mkdir, 'r', (err, fd) => {
if (err) {
console.log(`open ${mkdir} file failed~`);
return false;
}
fs.fstat(fd, (err, stats) => {
if (err) {
console.log(`fstat ${mkdir} file failed~`);
return false;
}
console.log(JSON.stringify(stats));
})
})
fs.fstat 返回结果示例
{
"dev": 1041887651,
"mode": 16822,
"nlink": 1,
"uid": 0,
"gid": 0,
"rdev": 0,
"ino": 4222124650663107,
"size": 0,
"atimeMs": 1519394418412.3062,
"mtimeMs": 1519394418412.3062,
"ctimeMs": 1519394418412.3062,
"birthtimeMs": 1519394418402.2554,
"atime": "2018-02-23T14:00:18.412Z",
"mtime": "2018-02-23T14:00:18.412Z",
"ctime": "2018-02-23T14:00:18.412Z",
"birthtime": "2018-02-23T14:00:18.402Z"
}
检查文件或目录是否存在
相关参数为布尔类型值。
const fs = require('fs');
let mkdir = './mkdir';
fs.exists(mkdir, (exits) => {
if (exits) {
console.log(`${exits}, ${mkdir} file exists`);
} else {
console.log(`${exits}, ${mkdir} file not exists`)
}
});
修改文件的访问时间及修改时间
- 异步修改时间:fs.utimes(path, atime, mtime, callback(err))
- 同步修改文件访问时间及修改时间使用 fs.utimesSync(path, atime, mtime)。
// 修改文件访问时间及修改时间都为当前时间
const fs = require('fs');
let mkdir = './mkdir';
fs.utimes(mkdir, new Date(), new Date(), (err) => {
if (err) {
console.log(`fs.utimes ${mkdir} file failed~`);
} else {
console.log(`fs.utimes ${mkdir} file success~`);
}
})
修改文件或目录的权限
- 同步修改权限使用 fs.chmodSync(path, mode)。
- 异步修改权限:fs.chmod(path, mode, callback(err))
- mode 参数代表权限的具体数值。
- 执行 fs.chmod 方法前的权限显示为 drwxr-xr-x。
- 执行 fs.chmod 方法后的权限显示为 drw-------。
const fs = require('fs');
let mkdir = './mkdir';
fs.chmod(mkdirOne, '0600', (err) => {
if (err) {
console.log(`fs.chmod ${mkdir} file failed`);
return false;
}
console.log(`fs.chmod ${mkdir} file success~`);
});
在使用 open 或 openSync 方法打开文件并获得文件描述符后,可使用 fs 模块中的 fchmod 方法来修改文件的读写权限。
const fs = require('fs');
let mkdir = './mkdir';
fs.open(mkdir, 'r', (err, fd) => {
if (err) {
console.log(`open file ${mkdir} failed~`);
return false;
}
fs.fchmod(fd, '0600', (err) => {
if (err) {
console.log(`fs.fchmod ${mkdir} file failed~`);
return false;
}
console.log(`fs.fchmod ${mkdir} file success~`);
})
});