打印 PHP 调用堆栈

Posted 2023-02-24

【中文标题】打印 PHP 调用堆栈

【英文标题】：Print PHP Call Stack

【发布时间】：2010-11-28 05:35:09

【问题描述】：

我正在寻找一种在 php 中打印调用堆栈的方法。

如果函数刷新 IO 缓冲区，则奖励积分。

【问题讨论】：

How can I get PHP to produce a backtrace upon errors? 的可能重复项

...但这些反应更好。

【参考方案1】：

比debug_backtrace()更具可读性：

$e = new \Exception;
var_dump($e->getTraceAsString());

#2 /usr/share/php/PHPUnit/Framework/TestCase.php(626): SeriesHelperTest->setUp()
#3 /usr/share/php/PHPUnit/Framework/TestResult.php(666): PHPUnit_Framework_TestCase->runBare()
#4 /usr/share/php/PHPUnit/Framework/TestCase.php(576): PHPUnit_Framework_TestResult->run(Object(SeriesHelperTest))
#5 /usr/share/php/PHPUnit/Framework/TestSuite.php(757): PHPUnit_Framework_TestCase->run(Object(PHPUnit_Framework_TestResult))
#6 /usr/share/php/PHPUnit/Framework/TestSuite.php(733): PHPUnit_Framework_TestSuite->runTest(Object(SeriesHelperTest), Object(PHPUnit_Framework_TestResult))
#7 /usr/share/php/PHPUnit/TextUI/TestRunner.php(305): PHPUnit_Framework_TestSuite->run(Object(PHPUnit_Framework_TestResult), false, Array, Array, false)
#8 /usr/share/php/PHPUnit/TextUI/Command.php(188): PHPUnit_TextUI_TestRunner->doRun(Object(PHPUnit_Framework_TestSuite), Array)
#9 /usr/share/php/PHPUnit/TextUI/Command.php(129): PHPUnit_TextUI_Command->run(Array, true)
#10 /usr/bin/phpunit(53): PHPUnit_TextUI_Command::main()
#11 main"

【讨论】：

该死，这好多了，为什么他们不能把它作为 debug_print_backtrace() 的默认输出？可以为那些希望在变量中而不是回显的人添加一个布尔参数“returnTrace”，这将是完美的！

我不知道有多少个月我一直在试图弄清楚如何做到这一点，没想到它会起作用

这个解决方案似乎也比捕获 debug_backtrace() 的输出作为一个数组然后使用 print_r() 打印它占用更少的内存，这是我在看到这个之前一直在做的事情！跨度>

我正在寻找一种方法来限制 debug_backtrace 只返回堆栈跟踪中的第一级 - 这个解决方案为我工作。谢谢！

@Andrew print_r 将保留所有消息。

【参考方案2】：

如果您想生成回溯，您正在寻找 debug_backtrace 和/或 debug_print_backtrace。

例如，第一个会给你一个像这样的数组（引用手册）：

array(2) 
[0]=>
array(4) 
    ["file"] => string(10) "/tmp/a.php"
    ["line"] => int(10)
    ["function"] => string(6) "a_test"
    ["args"]=>
    array(1) 
      [0] => &string(6) "friend"
    

[1]=>
array(4) 
    ["file"] => string(10) "/tmp/b.php"
    ["line"] => int(2)
    ["args"] =>
    array(1) 
      [0] => string(10) "/tmp/a.php"
    
    ["function"] => string(12) "include_once"
  

它们显然不会刷新 I/O 缓冲区，但您可以自己使用 flush 和/或 ob_flush。

（请参阅第一个手册页以找出“和/或”的原因;-)）

【讨论】：

这经常使我的 php 内存不足。我推荐 Tobiasz 的解决方案。

如果您觉得难以阅读/理解，我也推荐 Tobiasz 的解决方案

@peedee 只需提供可选的DEBUG_BACKTRACE_IGNORE_ARGS 参数之一；这使得它们在功能上等同于(new \Exception())->getTraceAsString()

【参考方案3】：

奇怪没有人这样发帖：

debug_print_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

这实际上打印了没有垃圾的回溯——只是调用了什么方法以及在哪里调用。

【讨论】：

确实，真的相当于主要的投票解决方案，而且更短。谢谢

这个打印到哪里？

【参考方案4】：

记录跟踪

$e = new Exception;
error_log(var_export($e->getTraceAsString(), true));

感谢@Tobiasz

【讨论】：

在我看来与上面的前一个答案非常相似，但包含在导出功能中，如果我不忽略任何内容，也可以作为评论发布

【参考方案5】：

Backtrace 会转储大量您不需要的垃圾。它需要很长，很难阅读。您通常想要的只是“从哪里来的什么叫什么？”这是一个简单的静态函数解决方案。我通常将它放在一个名为“调试”的类中，其中包含我所有的调试实用程序函数。

class debugUtils 
    public static function callStack($stacktrace) 
        print str_repeat("=", 50) ."\n";
        $i = 1;
        foreach($stacktrace as $node) 
            print "$i. ".basename($node['file']) .":" .$node['function'] ."(" .$node['line'].")\n";
            $i++;
        
     

你这样称呼它：

debugUtils::callStack(debug_backtrace());

它会产生如下输出：

==================================================
 1. DatabaseDriver.php::getSequenceTable(169)
 2. ClassMetadataFactory.php::loadMetadataForClass(284)
 3. ClassMetadataFactory.php::loadMetadata(177)
 4. ClassMetadataFactory.php::getMetadataFor(124)
 5. Import.php::getAllMetadata(188)
 6. Command.php::execute(187)
 7. Application.php::run(194)
 8. Application.php::doRun(118)
 9. doctrine.php::run(99)
 10. doctrine::include(4)
==================================================

【讨论】：

'file' and 'line' are not always present in $node

为什么不在那些函数调用中添加参数呢？类名也可用于类成员函数。您可以添加更多代码，然后在 GitHub 上发布。

【参考方案6】：

如果你想要一个看起来非常类似于 php 格式化异常堆栈跟踪的堆栈跟踪，而不是使用我写的这个函数：

function debug_backtrace_string() 
    $stack = '';
    $i = 1;
    $trace = debug_backtrace();
    unset($trace[0]); //Remove call to this function from stack trace
    foreach($trace as $node) 
        $stack .= "#$i ".$node['file'] ."(" .$node['line']."): "; 
        if(isset($node['class'])) 
            $stack .= $node['class'] . "->"; 
        
        $stack .= $node['function'] . "()" . PHP_EOL;
        $i++;
    
    return $stack;
 

这将返回格式如下的堆栈跟踪：

#1 C:\Inetpub\sitename.com\modules\sponsors\class.php(306): filePathCombine()
#2 C:\Inetpub\sitename.com\modules\sponsors\class.php(294): Process->_deleteImageFile()
#3 C:\Inetpub\sitename.com\VPanel\modules\sponsors\class.php(70): Process->_deleteImage()
#4 C:\Inetpub\sitename.com\modules\sponsors\process.php(24): Process->_delete() 

【讨论】：

或只是$e = new Exception; echo $e->getTraceAsString();

布拉德，该解决方案不会从堆栈跟踪中删除最后一项，因此您不会显示由新异常引起的跟踪项

【参考方案7】：

var_dump(debug_backtrace());

这样做是你想要的吗？

【参考方案8】：

见debug_print_backtrace。我想你可以在之后打电话给flush。

【参考方案9】：

phptrace 是一个很棒的工具，可以随时打印 PHP 堆栈，而无需安装任何扩展。

phptrace主要有两个功能：一是打印PHP的调用栈，不需要安装任何东西，二是跟踪php执行流程，需要安装它提供的扩展。

如下：

$ ./phptrace -p 3130 -s             # phptrace -p <PID> -s
phptrace 0.2.0 release candidate, published by infra webcore team
process id = 3130
script_filename = /home/xxx/opt/nginx/webapp/block.php
[0x7f27b9a99dc8]  sleep /home/xxx/opt/nginx/webapp/block.php:6
[0x7f27b9a99d08]  say /home/xxx/opt/nginx/webapp/block.php:3
[0x7f27b9a99c50]  run /home/xxx/opt/nginx/webapp/block.php:10 

【讨论】：

有Windows版本吗？

我喜欢这里显示的内存地址..这可能会有所帮助

【参考方案10】：

使用debug_backtrace 来追溯调用了哪些函数和方法，以及包含哪些文件导致debug_backtrace 被调用。

【参考方案11】：

请看看这个 utils 类，可能会有所帮助：

用法：

<?php
/* first caller */
 Who::callme();

/* list the entire list of calls */
Who::followme();

源类：https://github.com/augustowebd/utils/blob/master/Who.php

【参考方案12】：

Walltearer 的解决方案非常出色，特别是如果包含在“pre”标签中：

<pre>
<?php debug_print_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); ?>
</pre>

- 在单独的行中列出呼叫，整齐地编号

【参考方案13】：

debug_backtrace()

【参考方案14】：

您可能想查看debug_backtrace 或debug_print_backtrace。

【参考方案15】：

我已调整 Don Briggs's answer above 以使用内部错误记录而不是公共打印，这可能是您在实时服务器上工作时最关心的问题。此外，还添加了一些修改，例如包含完整文件路径而不是基本名称的选项（因为不同路径中可能存在同名文件），以及（对于需要它的人）完整的节点堆栈输出：

class debugUtils 
    public static function callStack($stacktrace) 
        error_log(str_repeat("=", 100));
        $i = 1;
        foreach($stacktrace as $node) 
            // uncomment next line to debug entire node stack
            // error_log(print_r($node, true));
            error_log( $i . '.' . ' file: ' .$node['file'] . ' | ' . 'function: ' . $node['function'] . '(' . ' line: ' . $node['line'] . ')' );
            $i++;
        
        error_log(str_repeat("=", 100));
     


// call debug stack
debugUtils::callStack(debug_backtrace());

【参考方案16】：

如果您只对调用的文件感兴趣 - 您可以使用以下内容：

print_r(array_column(debug_backtrace(),'file'));

同样，您可以将 file 替换为不同的密钥，以查看该数据。