PHP如何打印跟蹤調試信息

更新時間：2021年04月27日 09:02:39 作者：硬核項目經理

這篇文章主要介紹了PHP如何打印跟蹤調試信息，幫助大家更好的理解和學習使用PHP，感興趣的朋友可以了解下

對于大部分編譯型語言來說，比如 C 、 Java 、 C# ，我們都能很方便地進行斷點調試，但是 PHP 則必須安裝 XDebug 并且在編輯器中進行復雜的配置才能實現斷點調試的能力。不過，如果只是簡單的調試并且查看堆?；厮莸脑挘鋵?PHP 已經為我們準備好了兩個函數，能夠讓我們非常方便的看到程序運行時的調用情況。

debug_backtrace()

從這個方法的字面意思上就可以看出，它的意思就是調試回溯，返回的也正是一段回溯信息的數組。

function a_test($str)
{
    echo "Hi: $str", PHP_EOL;
    var_dump(debug_backtrace());
}

var_dump(debug_backtrace());

a_test("A");

// Hi: A/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php:7:
// array(1) {
//   [0] =>
//   array(4) {
//     'file' =>
//     string(93) "/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php"
//     'line' =>
//     int(12)
//     'function' =>
//     string(6) "a_test"
//     'args' =>
//     array(1) {
//       [0] =>
//       string(1) "A"
//     }
//   }
// }

這個方法必須在函數中調用，在函數方法外部使用是不會有內容的。從內容中看，它輸出了關于這個函數的 __FILE__ 、 __LINE__ 、 __FUNCTION__ 、$argv 等信息。其實就是關于當前打印這行所在函數的相關內容。

我們當然也可以多嵌套幾層函數來看一下打印出的內容是什么。

function b_test(){
    c_test();
}

function c_test(){
    a_test("b -> c -> a");
}

b_test();

// Hi: b -> c -> a
// /Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php:7:
// array(3) {
//   [0] =>
//   array(4) {
//     'file' =>
//     string(93) "/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php"
//     'line' =>
//     int(37)
//     'function' =>
//     string(6) "a_test"
//     'args' =>
//     array(1) {
//       [0] =>
//       string(11) "b -> c -> a"
//     }
//   }
//   [1] =>
//   array(4) {
//     'file' =>
//     string(93) "/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php"
//     'line' =>
//     int(33)
//     'function' =>
//     string(6) "c_test"
//     'args' =>
//     array(0) {
//     }
//   }
//   [2] =>
//   array(4) {
//     'file' =>
//     string(93) "/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php"
//     'line' =>
//     int(40)
//     'function' =>
//     string(6) "b_test"
//     'args' =>
//     array(0) {
//     }
//   }
// }

沒錯，數組的輸出順序就是一個棧的執(zhí)行順序，b_test() 最先調用，所以它在棧底，對應的輸出也就是數組中的最后一個元素。

在類中也是類似的使用方法。

class A{
    function test_a(){
        $this->test_b();
    }
    function test_b(){
        var_dump(debug_backtrace());
    }
}

$a = new A();
$a->test_a();

// /Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php:90:
// array(2) {
//   [0] =>
//   array(7) {
//     'file' =>
//     string(93) "/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php"
//     'line' =>
//     int(87)
//     'function' =>
//     string(6) "test_b"
//     'class' =>
//     string(1) "A"
//     'object' =>
//     class A#1 (0) {
//     }
//     'type' =>
//     string(2) "->"
//     'args' =>
//     array(0) {
//     }
//   }
//   [1] =>
//   array(7) {
//     'file' =>
//     string(93) "/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php"
//     'line' =>
//     int(95)
//     'function' =>
//     string(6) "test_a"
//     'class' =>
//     string(1) "A"
//     'object' =>
//     class A#1 (0) {
//     }
//     'type' =>
//     string(2) "->"
//     'args' =>
//     array(0) {
//     }
//   }
// }

在類中使用的時候，在數組項中會多出一個 object 字段，顯示的是這個方法所在類的信息。

debug_backtrace() 的函數聲明是：

debug_backtrace ([ int $options = DEBUG_BACKTRACE_PROVIDE_OBJECT [, int $limit = 0 ]] ) : array

其中 options 是有兩個常量可以定義，DEBUG_BACKTRACE_PROVIDE_OBJECT 表明是否填充 "object" 的索引；DEBUG_BACKTRACE_IGNORE_ARGS 是否忽略 "args" 的索引，包括所有的 function/method 的參數，能夠節(jié)省內存開銷。limits 可用于限制返回堆棧幀的數量，默認為0返回所有的堆棧。

debug_backtrace() 以及下面要介紹的 debug_print_backtrace() 方法都是支持 require/include 文件以及 eval() 中的代碼的，在嵌入文件時，會輸出嵌入文件的路徑，這個大家可以自行嘗試。

debug_print_backtrace()

這個方法從名稱也可以看出，它會直接打印回溯內容，它的函數聲明和 debug_backtrace() 是一樣的，不過 $options 默認是 DEBUG_BACKTRACE_IGNORE_ARGS ，也就是說，它只打印調用所在文件及行數。

function a() {
    b();
}

function b() {
    c();
}

function c(){
    debug_print_backtrace();
}

a();

#0  c() called at [/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php:144]
#1  b() called at [/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php:140]
#2  a() called at [/Users/zhangyue/MyDoc/博客文章/dev-blog/php/202004/source/PHP打印跟蹤調試信息.php:151]

另外就是這個函數不需要使用 var_dump() 或 print_r() 進行輸出，直接使用這個函數就會進行輸出。能夠非?？旖莘奖愕淖屛覀冞M行調試，比如在 laravel 這類大型框架中，我們在控制器需要查看堆棧信息時，就可以使用 debug_print_backtrace() 快速地查看當前的堆棧調用情況。而 debug_backtrace() 如果沒有指定 $options 的話，則會占用非常大的內存容量或者無法完整顯示。