打印PHP调用堆栈

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

如果函数刷新IO缓冲区,则加分。

199633 次浏览

如果你想要生成一个回溯,你需要寻找debug_backtrace和/或debug_print_backtrace

< p > < br > 例如,第一个函数会给你一个这样的数组(引用手册):

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"
}
}
< p > < br > 它们显然不会刷新I/O缓冲区,但你可以自己做,使用< a href = " http://php.net/flush " rel = " noreferrer > flush < / >和/或< a href = " http://php.net/ob_flush " rel = " noreferrer > ob_flush < / >.

(请参阅第一个的手册页,找出为什么“and/or”;-))

看到debug_print_backtrace。我想如果你愿意,你可以在后面调用flush

debug_backtrace()

你可能想查看debug_backtrace,或者debug_print_backtrace

使用debug_backtrace可以获得被调用的函数和方法的反向跟踪,以及被包含到调用debug_backtrace的文件。

var_dump(debug_backtrace());

这是你想要的吗?

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

记录跟踪

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

由于@Tobiasz

回溯会转储大量您不需要的垃圾。它需要很长时间,很难阅读。你想要的通常是"什么从哪里叫什么?"这里是一个简单的静态函数解决方案。我通常把它放在一个名为“调试”的类中,其中包含了我所有的调试实用程序函数。

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

如果你想要一个堆栈跟踪,它看起来非常类似于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()

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

请看看这个utils类,可能会有帮助:

用法:

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


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

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

奇怪的是没有人这样发帖:

debug_print_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

这实际上是在没有垃圾的情况下打印backtrace -只是调用了什么方法和在哪里。

Walltearer的解决方案非常出色,特别是如果包含在'pre'标签中:

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

-它将调用放在单独的行上,整齐地编号

我已经调整了以上是唐·布里格斯的回答以使用内部错误记录而不是公共打印,这可能是您在活动服务器上工作时的大问题。此外,增加了一些更多的修改,如选项包括完整的文件路径,而不是基本名称(因为,可能有相同名称的文件在不同的路径),以及(对于那些需要它的人)一个完整的节点堆栈输出:

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

如果一个人只是对文件感兴趣,你可以使用以下:

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

同样地,你可以用不同的键替换file来查看该数据。