在 Node.js 中使用 Promise 操作基于回调的 fs.lstat() 方法

在 Node.js 中，fs.lstat() 方法用于获取文件或目录的元数据，比如文件大小、修改时间等。默认情况下，fs.lstat() 方法是基于回调的 API，需要在回调函数中获取返回结果。然而，使用 Promise 可以使代码更加简洁易读。

使用 Promise 包装 fs.lstat()

在使用 Promise 包装 fs.lstat() 方法之前，先了解一下 Promise 的基本用法：

/**
 * Promise 的基本用法：
 * - 构造函数接收一个函数作为参数，这个函数接收两个函数作为参数。
 * - 内部函数通过调用 resolve() 或 reject() 函数来决定 Promise 的最终状态。
 * - then() 方法可以接受两个回调函数，分别用于处理 Promise 成功和失败的状态。
 */

const myPromise = new Promise((resolve, reject) => {
  // 异步操作
  setTimeout(() => {
    resolve('Hello world!');
  }, 1000);
});

myPromise.then(
  // 成功回调
  (result) => {
    console.log(result); // 'Hello world!'
  },
  // 失败回调
  (error) => {
    console.error(error);
  }
);

基于上述知识，我们可以将 fs.lstat() 方法包装成一个 Promise 对象：

const fs = require('fs');

/**
 * 使用 Promise 包装 fs.lstat() 方法
 *
 * @param {String} path 文件或目录的路径
 * @returns {Promise} 返回一个 Promise 对象
 */
function lstat(path) {
  return new Promise((resolve, reject) => {
    fs.lstat(path, (error, stats) => {
      if (error) {
        reject(error);
      } else {
        resolve(stats);
      }
    });
  });
}

// 示例：
lstat('./file.txt').then(
  // 成功回调
  (stats) => {
    console.log(stats.size); // 文件大小（字节）
    console.log(stats.mtime); // 修改时间
  },
  // 失败回调
  (error) => {
    console.error(error);
  }
);

使用 async/await 简化代码

如果你使用的是 Node.js 8.0 以上版本，可以使用 async/await 进一步简化 Promise 的使用：

async function myFunc() {
  try {
    const stats = await lstat('./file.txt');
    console.log(stats.size);
    console.log(stats.mtime);
  } catch (error) {
    console.error(error);
  }
}

总结

使用 Promise 可以让代码更简洁易读，避免了多层回调嵌套的问题。使用 async/await 进一步简化了 Promise 的使用，让代码更加易于维护。