如何在 node.js 中获取调用函数的文件路径?

IT技术 javascript node.js
2021-02-16 08:38:16

以下是来自三个文件的一些示例代码:

// foo.js
var myFunc = require("./myFunc");
function foo(){
   myFunc("message");
}

// bar.js
var myFunc = require("./myFunc");
function bar(){
   myFunc("message");
}

// myFunc.js
module.exports = myFunc;
function myFunc(arg1){
   console.log(arg1);
   // Here I need the file path of the caller function
   // For example, "/path/to/foo.js" and "/path/to/bar.js"
}

我需要动态获取调用者函数的文件路径,无需任何额外的参数传递,对于myFunc.

6个回答

你需要摆弄v8. 请参阅:有关 JavaScript Stack Trace API 的 wiki 条目

我已经对提议的提交中的一些代码进行一些测试,它似乎有效。你最终得到一个绝对路径。

// omfg.js

module.exports = omfg

function omfg() {
  var caller = getCaller()
  console.log(caller.filename)
}

// private

function getCaller() {
  var stack = getStack()

  // Remove superfluous function calls on stack
  stack.shift() // getCaller --> getStack
  stack.shift() // omfg --> getCaller

  // Return caller's caller
  return stack[1].receiver
}

function getStack() {
  // Save original Error.prepareStackTrace
  var origPrepareStackTrace = Error.prepareStackTrace

  // Override with function that just returns `stack`
  Error.prepareStackTrace = function (_, stack) {
    return stack
  }

  // Create a new `Error`, which automatically gets `stack`
  var err = new Error()

  // Evaluate `err.stack`, which calls our new `Error.prepareStackTrace`
  var stack = err.stack

  // Restore original `Error.prepareStackTrace`
  Error.prepareStackTrace = origPrepareStackTrace

  // Remove superfluous function call on stack
  stack.shift() // getStack --> Error

  return stack
}

以及包含omfgmodule的测试

#!/usr/bin/env node
// test.js

var omfg = require("./omfg")

omfg()

您将在控制台上获得test.js.


解释

这与其说是“node.js”问题,不如说是“v8”问题。

请参阅:自定义异常的堆栈跟踪集合

Error.captureStackTrace(error, constructorOpt)error参数添加一个stack属性,该属性默认计算为 a String(通过FormatStackTrace)。如果Error.prepareStackTrace(error, structuredStackTrace)是 a Function,则调用它而不是FormatStackTrace

所以,我们可以Error.prepareStackTrace用我们自己的函数覆盖,它会返回我们想要的任何东西——在这种情况下,只是structuredStackTrace参数。

然后,structuredStackTrace[1].receiver是一个代表调用者的对象。

这帮助我找出内存泄漏发生的位置!!!非常感谢这个!!!
2021-04-28 08:38:16
嗨,我是 nodejs 的新手,你能告诉我 getStack() 中实际发生了什么吗?
2021-05-03 08:38:16
谢谢你的解释,现在我可以得到调用函数的文件名了。
2021-05-13 08:38:16

或者不是摆弄 V8 引擎的内部工作原理,而是使用module.parent.filename获取需要module的module的绝对路径。如此处所示:https : //gist.github.com/capaj/a9ba9d313b79f1dcd9a2

请记住,module被缓存,因此如果任何其他文件需要它并调用它,它将始终是第一个导入器的路径。

最终使用github.com/sindresorhus/callsites,它至少在 Node 中有效,这正是我所需要的。
2021-04-17 08:38:16
@Sylvain 在这种情况下,您应该能够一直遍历父母。如果您正在动态加载module,那可能会有问题,但在大多数情况下,您不会这样做。
2021-04-19 08:38:16
@Capaj 我只是想为同样的事情打电话给 Sylvain,但那是因为正在寻找解决方案,而不是 OP。OP 要求提供调用的文件名function,而不是调用的文件名module您的回答完全符合我的问题,但与 OP 的问题不完全匹配,所以我不得不同意他的看法。但是,您为我节省了很多继续搜索的时间:D
2021-04-19 08:38:16
有没有办法在每次需要您的module时获取调用者的姓名,而不仅仅是第一个调用者(通过parent)?
2021-05-05 08:38:16
是的,但是如果您module.exports在函数和调用者之间有多个,则它不起作用。
2021-05-12 08:38:16

您可以使用caller-callsite包:

console.log(callerCallsite().getFileName());

替代方案是callsitesstackman包。callsites为您提供所有调用站点(v8术语中的“堆栈帧” )。stackman赋予调用站点装饰自定义功能和行为。源上下文等。这是围绕呼叫站点行的代码行。如果可用,它还使用源映射。

问题stackman在于它异步返回调用站点。从调试器运行时,这不是特别有用。

这是我使用的一些代码,您可能会发现它们很有用:

var callsites = require('callsites');
var util = require('util');
var path = require('path');
function printStackTrace() {
    callsites().slice(1).forEach(function(cs) {
        printCallSite(cs);
    });
}
function printCallSite(cs) {
    console.log(util.format('%s:%i',
        path.relative(process.cwd(), cs.getFileName()),
        cs.getLineNumber()));
    console.log('  getTypeName(): ' + cs.getTypeName());
    console.log('  getFunctionName(): ' + cs.getFunctionName());
    console.log('  getMethodName(): ' + cs.getMethodName());
    // console.log('  getEvalOrigin(): ' + cs.getEvalOrigin());
    // console.log('  isTopLevel(): ' + (cs.isTopLevel ? cs.isTopLevel() : null));
    // console.log('  isEval(): ' + cs.isEval());
    // console.log('  isNative(): ' + cs.isNative());
    // console.log('  isConstructor(): ' + cs.isConstructor());
}
function getCallSiteIndexes(cond) {
    var cond = cond || function() { return true; };
    var options = arguments[1] || {};
    var css = options['callsites'] || callsites().slice(1);
    var r = [];
    for (var i = 0; i < css.length; i++) {
        var cs = css[i];
        if (cond(cs)) {
            if (options['first'])
                return i;
            r.push(i);
        }
    }
    return options['first'] ? null : r;
}
function getFirstCallSiteIndex(cond) {
    var css = callsites().slice(1);
    return getCallSiteIndexes(cond, {first: true, callsites: css});
}
function getCallSites(cond) {
    var options = arguments[1] || {};
    var css = options['callsites'] || callsites().slice(1);
    var indexes = getCallSiteIndexes(cond,
        Object.assign({}, {callsites: css}, options));
    if (options['first'])
        return css[indexes];
    return indexes.map(function(i) {
        return css[i];
    });
}
function getFirstCallSite(cond) {
    var css = callsites().slice(1);
    return getCallSites(cond, {first: true, callsites: css});
}

fucntion f() {
    var firstCS = callsites()[0];
    var runAsChildCSIndex = getFirstCallSiteIndex(function(cs) {
        return cs.getFileName() == firstCS.getFileName() && cs.getFunctionName() == 'Compiler.runAsChild';
    });
    if (runAsChildCSIndex) {
        printCallSite(callsites()[runAsChildCSIndex + 1]);
    } else {
        var compilerRunCS = getFirstCallSite(function(cs) {
            return cs.getFileName() == firstCS.getFileName() && cs.getFunctionName() == 'Compiler.run';
        });
        printCallSite(compilerRunCS);
    }
    ...

我的 2 美分:

假设您有一个log对象将调用者的文件名作为额外信息添加到控制台,例如log响应log.info(msg)并执行类似于以下内容的操作:

// my_module.js
log.info('hello')
$> [[my_module.js]] hello

info 将是:

info: function(msg) {
  let caller = path.basename(module.parent.filename);
  console.log(`[[${caller}]] ${msg}`);
}

问题:如前所述,parent.filename将返回首先需要该module的您,而不是调用者本身。

替代方案堆栈跟踪是一个可以解决问题的module:

const stackTrace = require('stack-trace');
...
info: function(msg) {
  let caller = path.basename(stackTrace.get()[0].getFilename());
  console.log(`[[${caller}]] ${msg}`);
}

要点:stackTrace.get()[0]返回Caller响应的最后一个(只是其中的一些)

  • getFileName()
  • getColumnNumber()
  • getFunctionName()
  • getLineNumber()
  • getMethodName()

获取节点中调用者函数路径的唯一方法是通过堆栈跟踪(忘记外部库):

function getCallerFilePath(path) {
    let stack = new Error().stack.split('\n')
    return stack[2].slice(
        stack[2].lastIndexOf('(')+1, 
        stack[2].lastIndexOf('.js')+3
    )
}