Question

以下是三个文件的示例代码：

// 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动态获取调用函数的文件路径，而不传递任何额外的参数。

Answer 1

你需要摆弄v8的内部运作。请参阅：the wiki entry about the JavaScript Stack Trace API。

我对a proposed commit中的一些代码进行了一些测试，但似乎有效。你最终得到了绝对的道路。

// 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
}

包含omfg模块的测试：

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

var omfg = require("./omfg")

omfg()

你将在控制台上获得test.js的绝对路径。

<强>说明

这不是一个“node.js”问题，因为它是一个“v8”问题。

请参阅：Stack Trace Collection for Custom Exceptions

Error.captureStackTrace(error, constructorOpt)为error参数添加了stack属性，默认情况下评估为String（通过FormatStackTrace）。如果Error.prepareStackTrace(error, structuredStackTrace)是Function，则会调用它而不是FormatStackTrace。

因此，我们可以使用我们自己的函数覆盖Error.prepareStackTrace，该函数将返回我们想要的任何内容 - 在这种情况下，只是structuredStackTrace参数。

然后，structuredStackTrace[1].receiver是表示调用者的对象。

Answer 2

或者使用module.parent.filename来获取需要模块的模块的绝对路径，而不是摆弄V8引擎的内部工作。如下所示：https://gist.github.com/capaj/a9ba9d313b79f1dcd9a2

请记住，模块是缓存的，因此如果任何其他文件需要它并调用它，它将始终是第一个导入程序的路径。

Answer 3

我的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会返回首先需要模块的人，而不是调用者本身。

替代：stack-trace是一个可以解决问题的模块：

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()

Answer 4

您可以使用caller-callsite包：

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

备选方案是callsites和stackman个包。 callsites为您提供所有呼叫站点（＆＃34;堆栈帧＆＃34;在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);
    }
    ...

Answer 5

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

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

Answer 6

如果您不想使用第三方库，您可以这样做：

    function getFileCallerURL(): string {
        const error: Error = new Error();

        const stack: string[] = error.stack?.split('\n') as string[];

        const data: string = stack[3];

        const filePathPattern: RegExp = new RegExp(`(file:[/]{2}.+[^:0-9]):{1}[0-9]+:{1}[0-9]+`);

        const result: RegExpExecArray = filePathPattern.exec(data) as RegExpExecArray;

        let filePath: string = '';

        if (result && (result.length > 1)) {
            filePath = result[1];
        }

        return filePath;
    }

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

6 个答案: