Node.js获取函数声明文件、判断来源及枚举所有函数方法咨询

1. 如何通过函数本身获取其定义所在的文件路径 #

可以通过Node.js内置的Error栈追踪能力实现，核心逻辑是劫持Error的栈解析逻辑，提取函数对应的栈帧中的文件路径信息，实现代码如下：

function getFile(func) {
  const originalPrepareStackTrace = Error.prepareStackTrace;
  let result = null;
  try {
    // 自定义栈解析规则，直接返回结构化的栈帧数组
    Error.prepareStackTrace = (err, stackFrames) => stackFrames;
    const captureTarget = () => {};
    // 以传入的func作为栈追踪的起始边界，捕获栈帧
    Error.captureStackTrace(captureTarget, func);
    // 第一个栈帧即为func定义所在的文件信息
    const targetFrame = captureTarget.stack[0];
    if (targetFrame) {
      result = targetFrame.getFileName();
    }
  } catch (e) {
    // 异常场景返回空，比如传入的不是函数、箭头函数无栈帧等情况
    result = null;
  } finally {
    // 恢复全局的栈解析逻辑，避免影响其他逻辑
    Error.prepareStackTrace = originalPrepareStackTrace;
  }
  return result;
}

注意：该方案对经过bind生成的绑定函数、打包工具转译后的函数、箭头函数可能无法返回准确路径。

2. 如何确定性判断函数的来源类型 #

可以结合上述getFile返回的路径和函数特征判断，是目前确定性最高的方案：

• 区分内置函数：内置函数调用toString()会返回包含[native code]的字符串，同时getFile返回的路径要么为空，要么以internal/前缀开头（Node.js内部模块路径标识）
• 区分第三方模块函数：如果getFile返回的路径中包含node_modules目录字段，即为外部npm引入的第三方模块函数
• 剩余路径落在你的项目源码目录内的，即为用户自定义函数

3. 是否可以获取当前所有存在的函数 #

没有完美的全量获取方案，原因是函数可以存在于局部作用域、闭包、对象私有属性中，这类函数没有公共的遍历入口。仅能获取到两类可公开访问的函数：

• 全局挂载的函数：遍历globalThis的所有可枚举、不可枚举属性，筛选类型为function的值即可
• 已加载模块的导出函数：遍历require.cache中所有已经加载完成的模块，逐个遍历模块的exports对象，筛选类型为function的值即可
  注意：局部作用域、闭包内部声明的函数无法通过任何公开API获取。

内容的提问来源于stack exchange，提问作者Effie