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

複制

沒錯，數組的輸出順序就是一個棧的執行順序，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 的參數，能夠節省記憶體開銷。$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() 進行輸出，直接使用這個函數就會進行輸出。能夠非常快捷友善的讓我們進行調試，比如在 laravel 這類大型架構中，我們在控制器需要檢視堆棧資訊時，就可以使用 debug_print_backtrace() 快速地檢視目前的堆棧調用情況。而 debug_backtrace() 如果沒有指定 $options 的話，則會占用非常大的記憶體容量或者無法完整顯示。

總結

今天介紹的這兩個函數能夠靈活地幫助我們調試代碼或者了解一個架構的調用情況。當然，在正式的情況下還是推薦使用 Xdebug 加上編輯器的支援來進行斷點調試，因為使用 debug_backtrace() 這兩個方法我們無法看到變量的變化情況。

測試代碼：

https://github.com/zhangyue0503/dev-blog/blob/master/php/202004/source/PHP%E6%89%93%E5%8D%B0%E8%B7%9F%E8%B8%AA%E8%B0%83%E8%AF%95%E4%BF%A1%E6%81%AF.php

參考文檔：https://www.php.net/manual/zh/function.debug-backtrace.phphttps://www.php.net/manual/zh/function.debug-print-backtrace.php

PHP列印跟蹤調試資訊PHP列印跟蹤調試資訊

PHP列印跟蹤調試資訊

debug_backtrace()

debug_print_backtrace()

總結