php 利用debug_backtrace方法跟踪代码调用

在开发过程中，例如要修改别人开发的代码或调试出问题的代码，需要对代码流程一步步去跟踪，找到出问题的地方进行修改。如果有一个方法可以获取到某段代码是被哪个方法调用，并能一直回溯到最开始调用的地方（包括调用的文件，行数，参数等），这样就能很方便的定位到出问题的地方。

php的debug_backtrace方法可以对代码调用进行跟踪，方便调试代码。

debug_backtrace 方法说明

产生一条回溯跟踪(backtrace)

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

参数
options

DEBUG_BACKTRACE_PROVIDE_OBJECT	是否填充 “object” 的索引。
DEBUG_BACKTRACE_IGNORE_ARGS	是否忽略 “args” 的索引，包括所有的 function/method 的参数，能够节省内存开销。

limit
这个参数能够用于限制返回堆栈帧的数量，默认为(limit=0)，返回所有堆栈帧。

返回值
返回一个包含众多关联数组的array，可能返回的元素：

名字         类型    说明
function    string  当前的函数名，参见： __FUNCTION__。
line        integer 当前的行号。参见： __LINE__。
file        string  当前的文件名。参见： __FILE__。
class       string  当前 class 的名称。参见 __CLASS__
object      object  当前的 object。
type        string  当前调用的类型。如果是一个方法，会返回 "->"。如果是一个静态方法，会返回 "::"。 如果是一个函数调用，则返回空。
args        array   如果在一个函数里，这会列出函数的参数。 如果是在一个被包含的文件里，会列出包含的文件名。

实例

获取订单的用户资料及用户讯息，调用流程是 index->order->user->message，最后返回整理后的信息。

假设我们调试时发现message的数据有误，则可以在message使用debug_backtrace方法，查看调用的流程及调用的参数，检查哪一步出现问题。

使用DEBUG_BACKTRACE_IGNORE_ARGS则会忽略args（方法调用的参数）

index.php

1 <?php
2 require 'order.php';
3 
4 // 获取用户订单资料
5 $order_id = 1000000;
6 
7 $oOrder = new Order;
8 $order_info = $oOrder->get_order($order_id);
9 ?>

index.php

order.php

 1 <?php
 2 require 'user.php';
 3 
 4 // 订单资料
 5 class Order{
 6 
 7     // 获取订单资料
 8     function get_order($order_id){
 9 
10         $user_id = 1001;
11 
12         // 获取用户资料
13         $oUser = new User;
14         $user_info = $oUser->get_user($user_id);
15 
16         // 订单资料
17         $order_info = array(
18             'order_id' => $order_id,
19             'order_name' => 'my order',
20             'user_info' => $user_info,
21         );
22 
23         return $order_info;
24 
25     }
26 
27 }
28 ?>

order.php

user.php

 1 <?php
 2 require 'message.php';
 3 
 4 // 用户资料
 5 class User{
 6 
 7     // 获取用户资料
 8     function get_user($user_id){
 9 
10         // 获取用户讯息
11         $oMessage = new Message;
12         $user_message = $oMessage->get_message($user_id);
13 
14         $user_info = array(
15                 'user_id' => $user_id,
16                 'name' => 'fdipzone',
17                 'message' => $user_message
18         );
19 
20         return $user_info;
21 
22     }
23 
24 }
25 ?>

user.php

message.php

 1 <?php
 2 // 用户讯息
 3 class Message{
 4 
 5     // 获取用户讯息
 6     function get_message($user_id){
 7 
 8         $message = array(
 9             array('id'=>1, 'title'=>'message1'),
10             array('id'=>2, 'title'=>'message2'),
11         );
12 
13         // 加入跟踪调试
14         $backtrace = debug_backtrace();
15         var_dump($backtrace);
16 
17         return $message;
18 
19     }
20 
21 }
22 ?>

message.php

运行index.php, 输出

/message.php:15:
array (size=3)
  0 =>
    array (size=7)
      'file' => string '/user.php' (length=9)
      'line' => int 12
      'function' => string 'get_message' (length=11)
      'class' => string 'Message' (length=7)
      'object' =>
        object(Message)[3]
      'type' => string '->' (length=2)
      'args' =>
        array (size=1)
          0 => int 1001
  1 =>
    array (size=7)
      'file' => string '/order.php' (length=10)
      'line' => int 14
      'function' => string 'get_user' (length=8)
      'class' => string 'User' (length=4)
      'object' =>
        object(User)[2]
      'type' => string '->' (length=2)
      'args' =>
        array (size=1)
          0 => int 1001
  2 =>
    array (size=7)
      'file' => string '/index.php' (length=9)
      'line' => int 8
      'function' => string 'get_order' (length=9)
      'class' => string 'Order' (length=5)
      'object' =>
        object(Order)[1]
      'type' => string '->' (length=2)
      'args' =>
        array (size=1)
          0 => int 1000000

可以看到调用过程是

1.index.php
line 8
class Order
function get_order
args int 1000000

2.order.php
line 14
class User
function get_user
args int 1001

3.user.php
line 12
class Message
function get_message
args int 1001

感谢博主，原文地址

php 利用debug_backtrace方法跟踪代码调用

猜你喜欢