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

最新推荐文章于 2020-04-14 17:06:53 发布

转载最新推荐文章于 2020-04-14 17:06:53 发布 · 333 阅读

PHP 专栏收录该内容

44 篇文章

订阅专栏

本文介绍PHP中debug_backtrace函数的使用方法及其在代码调试中的应用。通过具体实例展示了如何利用此函数追踪代码调用流程，从而快速定位问题。

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

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

debug_backtrace 方法说明

产生一条回溯跟踪(backtrace)

<span style="color:#000000"><code>array debug_backtrace ([ <span style="color:#000088">int</span> <span style="color:#4f4f4f">$options</span> = DEBUG_BACKTRACE_PROVIDE_OBJECT [, <span style="color:#000088">int</span> <span style="color:#4f4f4f">$limit</span> = <span style="color:#006666">0</span> ]] )</code></span>

参数

options

DEBUG_BACKTRACE_PROVIDE_OBJECT
是否填充 “object” 的索引。

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

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

返回值

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

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

实例

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

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

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

index.php

<span style="color:#000000"><code class="language-php"><span style="color:#009900"><?php</span>
<span style="color:#000088">require</span> <span style="color:#009900">'order.php'</span>;

<span style="color:#880000">// 获取用户订单资料</span>
<span style="color:#4f4f4f">$order_id</span> = <span style="color:#006666">1000000</span>;

<span style="color:#4f4f4f">$oOrder</span> = <span style="color:#000088">new</span> Order;
<span style="color:#4f4f4f">$order_info</span> = <span style="color:#4f4f4f">$oOrder</span>->get_order(<span style="color:#4f4f4f">$order_id</span>);
<span style="color:#009900">?></span></code></span>

order.php

<span style="color:#000000"><code class="language-php"><span style="color:#009900"><?php</span>
<span style="color:#000088">require</span> <span style="color:#009900">'user.php'</span>;

<span style="color:#880000">// 订单资料</span>
<span style="color:#000088">class</span> <span style="color:#4f4f4f">Order</span>{

    <span style="color:#880000">// 获取订单资料</span>
    <span style="color:#000088">function</span> <span style="color:#009900">get_order</span><span style="color:#4f4f4f">(<span style="color:#4f4f4f">$order_id</span>)</span>{

        <span style="color:#4f4f4f">$user_id</span> = <span style="color:#006666">1001</span>;

        <span style="color:#880000">// 获取用户资料</span>
        <span style="color:#4f4f4f">$oUser</span> = <span style="color:#000088">new</span> User;
        <span style="color:#4f4f4f">$user_info</span> = <span style="color:#4f4f4f">$oUser</span>->get_user(<span style="color:#4f4f4f">$user_id</span>);

        <span style="color:#880000">// 订单资料</span>
        <span style="color:#4f4f4f">$order_info</span> = <span style="color:#000088">array</span>(
            <span style="color:#009900">'order_id'</span> => <span style="color:#4f4f4f">$order_id</span>,
            <span style="color:#009900">'order_name'</span> => <span style="color:#009900">'my order'</span>,
            <span style="color:#009900">'user_info'</span> => <span style="color:#4f4f4f">$user_info</span>,
        );

        <span style="color:#000088">return</span> <span style="color:#4f4f4f">$order_info</span>;

    }

}
<span style="color:#009900">?></span></code></span>

user.php

<span style="color:#000000"><code><span style="color:#009900"><?php</span>
<span style="color:#000088">require</span> <span style="color:#009900">'message.php'</span>;

<span style="color:#880000">// 用户资料</span>
<span style="color:#000088">class</span> <span style="color:#4f4f4f">User</span>{

    <span style="color:#880000">// 获取用户资料</span>
    <span style="color:#000088">function</span> <span style="color:#009900">get_user</span><span style="color:#4f4f4f">(<span style="color:#4f4f4f">$user_id</span>)</span>{

        <span style="color:#880000">// 获取用户讯息</span>
        <span style="color:#4f4f4f">$oMessage</span> = <span style="color:#000088">new</span> Message;
        <span style="color:#4f4f4f">$user_message</span> = <span style="color:#4f4f4f">$oMessage</span>->get_message(<span style="color:#4f4f4f">$user_id</span>);

        <span style="color:#4f4f4f">$user_info</span> = <span style="color:#000088">array</span>(
                <span style="color:#009900">'user_id'</span> => <span style="color:#4f4f4f">$user_id</span>,
                <span style="color:#009900">'name'</span> => <span style="color:#009900">'fdipzone'</span>,
                <span style="color:#009900">'message'</span> => <span style="color:#4f4f4f">$user_message</span>
        );

        <span style="color:#000088">return</span> <span style="color:#4f4f4f">$user_info</span>;

    }

}
<span style="color:#009900">?></span></code></span>

message.php

<span style="color:#000000"><code><span style="color:#009900"><?php</span>
<span style="color:#880000">// 用户讯息</span>
<span style="color:#000088">class</span> <span style="color:#4f4f4f">Message</span>{

    <span style="color:#880000">// 获取用户讯息</span>
    <span style="color:#000088">function</span> <span style="color:#009900">get_message</span><span style="color:#4f4f4f">(<span style="color:#4f4f4f">$user_id</span>)</span>{

        <span style="color:#4f4f4f">$message</span> = <span style="color:#000088">array</span>(
            <span style="color:#000088">array</span>(<span style="color:#009900">'id'</span>=><span style="color:#006666">1</span>, <span style="color:#009900">'title'</span>=><span style="color:#009900">'message1'</span>),
            <span style="color:#000088">array</span>(<span style="color:#009900">'id'</span>=><span style="color:#006666">2</span>, <span style="color:#009900">'title'</span>=><span style="color:#009900">'message2'</span>),
        );

        <span style="color:#880000">// 加入跟踪调试</span>
        <span style="color:#4f4f4f">$backtrace</span> = debug_backtrace();
        var_dump(<span style="color:#4f4f4f">$backtrace</span>);

        <span style="color:#000088">return</span> <span style="color:#4f4f4f">$message</span>;

    }

}
<span style="color:#009900">?></span></code></span>

运行index.php, 输出

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

可以看到调用过程是

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