在开发 Node.js 应用时，操作文件系统是常见且重要的任务之一。Node.js 提供了丰富的 API 来操作文件，包括读取文件内容、获取文件信息、删除文件等。在许多情况下，我们可能需要获取某个文件的统计信息，比如文件的大小、创建时间、最后修改时间等。这些信息对于文件管理、日志分析、文件上传下载等场景都非常有用。
本篇文章将深入探讨如何使用 Node.js 获取文件的统计信息，并介绍 fs 模块中与文件统计相关的 API，帮助你更好地管理和操作文件系统。
1. Node.js 文件系统模块（fs）概述
Node.js 提供了一个非常强大的文件系统模块——fs（文件系统）。通过 fs 模块，我们可以实现文件的读取、写入、修改、删除等操作。对于文件的统计信息获取，fs 模块也提供了相关的 API。
Node.js 中获取文件统计信息主要依赖 fs.stat() 和 fs.promises.stat() 方法。
1.1 fs.stat() 方法
fs.stat() 方法用于获取文件或目录的统计信息，它会返回一个 fs.Stats 对象，其中包含了文件的各种属性（如大小、创建时间、修改时间等）。
const fs = require('fs');// 使用 fs.stat() 获取文件的统计信息
fs.stat('example.txt', (err, stats) => {if (err) {console.error('Error reading file stats:', err);return;}console.log('File Stats:');console.log(`File Size: ${stats.size} bytes`);console.log(`Creation Time: ${stats.birthtime}`);console.log(`Last Modified: ${stats.mtime}`);console.log(`Is Directory: ${stats.isDirectory()}`);
});
1.2 fs.promises.stat() 方法
fs.promises.stat() 是 fs.stat() 方法的 Promise 版本，它使用 async/await 语法，适用于现代的异步编程方式。
const fs = require('fs').promises;// 使用 fs.promises.stat() 获取文件的统计信息
async function getFileStats(filePath) {try {const stats = await fs.stat(filePath);console.log('File Stats:');console.log(`File Size: ${stats.size} bytes`);console.log(`Creation Time: ${stats.birthtime}`);console.log(`Last Modified: ${stats.mtime}`);console.log(`Is Directory: ${stats.isDirectory()}`);} catch (err) {console.error('Error reading file stats:', err);}
}getFileStats('example.txt');
2. fs.Stats 对象解析
无论是使用回调方式的 fs.stat() 还是 Promise 方式的 fs.promises.stat()，返回的统计信息都会是一个 fs.Stats 对象。这个对象包含了文件的多种信息。
2.1 常见属性
- stats.size： 文件的字节大小。
- stats.birthtime： 文件的创建时间。
- stats.mtime： 文件的最后修改时间。
- stats.isFile()： 如果是文件，返回
true，否则返回false。 - stats.isDirectory()： 如果是目录，返回
true，否则返回false。 - stats.isSymbolicLink()： 如果是符号链接，返回
true，否则返回false。
2.2 fs.Stats 方法
- stats.isFile()： 判断文件是否为常规文件。
- stats.isDirectory()： 判断文件是否为目录。
- stats.isSocket()： 判断文件是否为 socket 文件。
- stats.isFIFO()： 判断文件是否为 FIFO（先进先出）文件。
3. 文件统计信息的应用场景
获取文件的统计信息在开发中有许多实际应用，以下是一些常见的应用场景：
3.1 文件大小检测
在上传文件、处理大文件时，获取文件的大小至关重要。通过 stats.size 可以确保上传的文件不会超出服务器规定的大小限制。
const fs = require('fs');fs.stat('example.txt', (err, stats) => {if (err) {console.error('Error reading file stats:', err);return;}const maxSize = 10 * 1024 * 1024; // 最大文件大小 10MBif (stats.size > maxSize) {console.log('File is too large!');} else {console.log('File size is acceptable');}
});
3.2 文件修改时间监控
在某些场景下，我们需要定期检查文件是否被修改。例如，日志文件的监控，或者数据库备份文件的更新检测。
const fs = require('fs');fs.stat('backup.db', (err, stats) => {if (err) {console.error('Error reading file stats:', err);return;}const lastModified = stats.mtime;console.log(`Last modified: ${lastModified}`);// 进一步操作：检查是否需要进行备份
});
3.3 目录操作
在某些情况下，我们不仅仅要获取文件的信息，还需要对目录进行操作，比如遍历目录中的所有文件，并获取每个文件的大小或修改时间。
const fs = require('fs');fs.readdir('folderPath', (err, files) => {if (err) {console.error('Error reading directory:', err);return;}files.forEach(file => {fs.stat(`folderPath/${file}`, (err, stats) => {if (err) {console.error('Error reading file stats:', err);return;}console.log(`${file}: Size = ${stats.size} bytes`);});});
});
4. 总结
在 Node.js 中，fs.stat() 和 fs.promises.stat() 提供了简单而强大的方式来获取文件的统计信息。通过这些信息，我们可以获得文件的大小、创建时间、修改时间等关键信息，并在此基础上进行各种文件管理任务。无论是在文件上传、日志监控，还是在大规模数据处理时，文件的统计信息都是不可或缺的工具。
掌握如何高效地使用 Node.js 文件系统模块，可以帮助你编写更加高效、灵活的应用程序。
5. 常见问题
1: 如何获取文件的创建时间？
答: 可以通过 fs.stat() 或 fs.promises.stat() 返回的 fs.Stats 对象的 birthtime 属性来获取文件的创建时间。
2: 如何判断文件是目录还是文件？
答: 使用 stats.isDirectory() 方法判断文件是否为目录，使用 stats.isFile() 判断是否为常规文件。
3: fs.stat() 和 fs.promises.stat() 有什么区别？
答: fs.stat() 使用回调函数，而 fs.promises.stat() 返回一个 Promise，适合使用 async/await 语法。
相关阅读
- Node.js 官方文档：(https://nodejs.org/en/docs/)
- 深入了解 Node.js 文件操作：(https://nodejs.org/dist/latest-v14.x/docs/api/fs.html)