Trace调试

优质
小牛编辑
189浏览
2023-12-01

调试模式并不能完全满足我们调试的需要,有时候我们需要手动的输出一些调试信息。除了本身可以借助一些开发工具进行调试外,ThinkPHP还提供了一些内置的调试工具和函数。

Trace调试功能就是ThinkPHP提供给开发人员的一个用于开发调试的辅助工具。可以实时显示当前页面或者请求的请求信息、运行情况、SQL执行、错误信息和调试信息等,并支持自定义显示,并且支持没有页面输出的操作调试。

Trace调试功能对调试模式和部署模式都有效,可以单独开启和关闭。 只是在部署模式下面,显示的调试信息没有调试模式完整,通常我们建议Trace配合调试模式一起使用。

开启Trace调试

该功能默认关闭,要开启Trace调试功能,只需要在应用配置app.php文件中配置下面参数:

// 开启应用Trace调试
'app_trace' =>  true,

如果定义了环境变量APP_TRACE,那么以环境变量配置为准。

页面Trace功能开启后,运行后并且你的页面有输出的话,页面右下角会显示ThinkPHP的LOGO:

LOGO后面的数字就是当前页面的执行时间(单位是秒) 点击该图标后,会展开详细的Trace信息,如图:

Trace框架有6个选项卡,分别是基本、文件、流程、错误、SQL和调试,点击不同的选项卡会切换到不同的Trace信息窗口。

选项卡描述
基本当前页面的基本摘要信息,例如执行时间、内存开销、文件加载数、查询次数等等
文件详细列出当前页面执行过程中加载的文件及其大小
流程会列出当前页面执行到的行为和相关流程
错误当前页面执行过程中的一些错误信息,包括警告错误
SQL当前页面执行到的SQL语句信息
调试开发人员在程序中进行的调试输出

Trace的选项卡是可以定制和扩展的,如果你希望增加新的选项卡,则可以修改配置目录下的trace.php文件中的配置参数如下:

return [
    'type'       =>  'Html',
    'trace_tabs' =>  [
         'base'=>'基本',
         'file'=>'文件',
         'info'=>'流程',
         'error'=>'错误',
         'sql'=>'SQL',
         'debug'=>'调试',
         'user'=>'用户'
     ]
];

basefile是系统内置的,其它的选项其实都属于日志的等级(user是用户自定义的日志等级)。

也可以把某几个选项卡合并,例如:

return [
    'type'       =>  'Html',
    'trace_tabs' =>  [
         'base'=>'基本',
         'file'=>'文件',
         'error|notice|warning'=>'错误',
         'sql'=>'SQL',
         'debug|info'=>'调试',
     ]
];

更改后的Trace显示效果如图:

浏览器控制台输出

trace功能支持在浏览器的console直接输出,这样可以方便没有页面输出的操作功能调试,只需要在配置文件中设置:

    // 使用浏览器console输出trace信息
    'type'  =>  'console',

运行后打开浏览器的console控制台可以看到如图所示的信息:

浏览器Trace输出同样支持trace_tabs设置。