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

问题描述 投票：0回答：6

这是来自三个文件的一些示例代码：

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

javascript node.js
6个回答
48
投票

你需要摆弄

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
}

还有一个包含 

omfg
模块的测试：

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

var omfg = require("./omfg")

omfg()

您将在控制台上看到

test.js
的绝对路径。

解释

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

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

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

因此，我们可以用我们自己的函数覆盖 

Error.prepareStackTrace
，该函数将返回我们想要的任何内容 - 在本例中，仅返回 
structuredStackTrace
参数。

那么，

structuredStackTrace[1].receiver
是代表调用者的对象。

43
投票

或者不用摆弄 V8 引擎的内部工作，而是使用 

module.parent.filename
来获取需要您的模块的模块的绝对路径。如此处所示：https://gist.github.com/capaj/a9ba9d313b79f1dcd9a2

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

8
投票

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

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

您可以使用

caller-callsite
配套：

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

替代方案是 

callsites
和 
stackman
 包。 
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);
    }
    ...
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()
0
投票

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

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

        const filePathPattern = /file:\/{3}(.+)(?=:[0-9]+:[0-9]+)/;

        const stack = error.stack?.split('\n');

        let data = '';

        let result: RegExpExecArray | null;

        let filePath = '';

        if (stack) {
            data = stack[3];
        }

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

        return filePath;
    }
最新问题
© www.soinside.com 2019 - 2024. All rights reserved.