Node.js 文件统计信息

¥Node.js file stats

每个文件都带有一组详细信息，我们可以使用 Node.js 检查这些详细信息。特别是，使用 fs 模块 提供的 stat() 方法。

¥Every file comes with a set of details that we can inspect using Node.js. In particular, using the stat() method provided by the fs module.

你通过传递文件路径来调用它，一旦 Node.js 获取文件详细信息，它就会调用你传递的回调函数，带有 2 个参数：错误消息和文件统计信息：

¥You call it passing a file path, and once Node.js gets the file details it will call the callback function you pass, with 2 parameters: an error message, and the file stats:

const fs = require('node:fs');

fs.stat('/Users/joe/test.txt', (err, stats) => {
  if (err) {
    console.error(err);
  }
  // we have access to the file stats in `stats`
});

Node.js 还提供了一种同步方法，它会阻止线程，直到文件统计信息准备就绪：

¥Node.js also provides a sync method, which blocks the thread until the file stats are ready:

const fs = require('node:fs');

try {
  const stats = fs.statSync('/Users/joe/test.txt');
} catch (err) {
  console.error(err);
}

文件信息包含在 stats 变量中。我们可以使用统计数据提取什么样的信息？

¥The file information is included in the stats variable. What kind of information can we extract using the stats?

很多，包括：

¥A lot, including:

• 如果文件是目录或文件，则使用 stats.isFile() 和 stats.isDirectory()

  ¥if the file is a directory or a file, using stats.isFile() and stats.isDirectory()

• 如果文件是使用 stats.isSymbolicLink() 的符号链接

  ¥if the file is a symbolic link using stats.isSymbolicLink()

• 使用 stats.size 的文件大小（以字节为单位）。

  ¥the file size in bytes using stats.size.

还有其他高级方法，但你在日常编程中将使用的大部分方法都是这种方法。

¥There are other advanced methods, but the bulk of what you'll use in your day-to-day programming is this.

const fs = require('node:fs');

fs.stat('/Users/joe/test.txt', (err, stats) => {
  if (err) {
    console.error(err);
    return;
  }

  stats.isFile(); // true
  stats.isDirectory(); // false
  stats.isSymbolicLink(); // false
  stats.size; // 1024000 //= 1MB
});

如果你愿意，你还可以使用 fs/promises 模块提供的基于 promise 的 fsPromises.stat() 方法：

¥You can also use promise-based fsPromises.stat() method offered by the fs/promises module if you like:

const fs = require('node:fs/promises');

async function example() {
  try {
    const stats = await fs.stat('/Users/joe/test.txt');
    stats.isFile(); // true
    stats.isDirectory(); // false
    stats.isSymbolicLink(); // false
    stats.size; // 1024000 //= 1MB
  } catch (err) {
    console.log(err);
  }
}
example();

你可以在 官方文档 中阅读有关 fs 模块的更多信息。

¥You can read more about the fs module in the official documentation.