作者开发PHP项目使用的是ThinkPHP3.2+PhpStorm这样的环境,下面结合实际开发经历介绍一下常见的调试方法。
[ThinkPHP框架开启调试模式]
ThinkPHP有专门为开发过程而设置的调试模式,开启调试模式后,会牺牲一定的执行效率,但带来的方便和除错功能非常值得。
如何开启
开启调试模式很简单,只需要在入口文件中增加一行常量定义代码。在完成开发阶段部署到生产环境后,只需要关闭调试模式或者删除调试模式定义代码即可切换到部署模式。
<?php
// 开启调试模式
define('APP_DEBUG', true);
// 定义应用目录
define('APP_PATH', './Application/');
// 加载框架入口文件
require './ThinkPHP/ThinkPHP.php';
调试模式的优点在于:
- 开启日志记录,任何错误信息和调试信息都会详细记录,便于调试;
- 关闭模板缓存,模板修改可以即时生效;
- 记录SQL日志,方便分析SQL;
- 关闭字段缓存,数据表字段修改不受缓存影响;
- 严格检查文件大小写(即使是Windows平台),帮助你提前发现Linux部署可能导致的隐患问题;
- 通过页面Trace功能更好的调试和发现错误;
[日志]
日志的处理工作是由系统自动进行的,在开启日志记录的情况下,会记录下允许的日志级别的所有日志信息。
框架默认是在调试模式下记录日志信息,如果需要在部署模式下开启日志记录,需要在配置中开启LOG_RECORD参数,以及可以在应用配置文件中配置需要记录的日志级别。日志的记录并非实时保存的,只有当当前请求完成或者异常结束后才会实际写入日志信息,否则只是记录在内存中。
'LOG_RECORD' => true, // 开启日志记录
'LOG_LEVEL' =>'EMERG,ALERT,CRIT,ERR', // 只记录EMERG ALERT CRIT ERR 错误
手动记录日志
这里,主要介绍下利用框架提供的Log日志类的三个方法来手动记录日志。
- Log::record(),记录日志信息到内存。
\Think\Log::record('测试日志信息');
\Think\Log::record('测试日志信息,这是警告级别','WARN');//默认的话记录的日志级别是ERR,也可以指定日志级别 - Log::save(),把保存在内存中的日志信息(用指定的记录方式)写入。
由于系统在请求结束后会自动调用Log::save方法,所以通常,你只需要调用Log::record记录日志信息即可。 - Log::write(),实时写入一条日志信息。
采用record方法记录的日志信息不是实时保存的,如果需要实时记录的话,可以采用write方法。write方法写入日志的时候 不受配置的允许日志级别影响,可以实时写入任意级别的日志信息。
\Think\Log::write('测试日志信息,这是警告级别,并且实时写入','WARN');
[利用Xdebug工具]
参见我写的另外一篇文章,Mac下给PhpStorm安装调试工具Xdebug
[变量调试]
变量调试对于简单的问题可以起到很快捷的调试作用,有时候通过对变量的观察可以迅速定位到问题位置,但是对比使用Xdebug方法,缺乏流程性和整体观。
- echo方法
echo 输出一个或者多个字符串或变量值,多个值之间用逗号分隔,他是php语句,不是函数。因为他不是函数,所以没有返回值,不能作为表达式的一部分使用。
echo $str,'world','hello!';
echo $str; - print方法
print()用于输出一个或多个字符串或变量值的信息。它只能打印出简单类型变量的值(如int,string),不能打印数组和对象。稍慢于echo。 - print_r方法
可以把字符串和数字简单地打印出来,而数组则以括起来的键和值得列表形式显示,并以Array开头。print_r返回值是布尔型的,参数是mix类型的,可以是字符串,整形,数组,对象类print_r() 显示关于一个变量的易于理解的信息。如果给出的是 string、integer 或 float,将打印变量值本身。如果给出的是 array,将会按照一定格式显示键和元素。print_r() 对数组作用后将把数组的指针移到最后边。使用 reset() 可让指针回到开始处。
$data = ['test1', 'test2', 'test3', 'test' => 'test'];
print_r($data);//Array ( [0] => test1 [1] => test2 [2] => test3 [test] => test ) - var_dump方法
用于显示关于一个或多个表达式的结构信息,包括表达式的类型与值。数组将递归展开值,通过缩进显示其结构。信息比较详细,用的较多。
$data = ['test1', 'test2', 'test3', 'test' => 'test'];
var_dump($data);
array (size=4)
//输出
0 => string 'test1' (length=5)
1 => string 'test2' (length=5)
2 => string 'test3' (length=5)
'test' => string 'test' (length=4) - dump方法
dump不是php方法,属于ThinkPHP框架自带的,工能和var_dump差不多。
[性能调试]
开发过程中,有些时候为了测试性能,经常需要调试某段代码的运行时间或者内存占用开销,系统提供了G方法可以很方便的获取某个区间的运行时间和内存占用情况。
G('begin','end') 表示统计begin位置到end位置的执行时间(单位是秒),begin必须是一个已经标记过的位置,如果这个时候end位置还没被标记过,则会自动把当前位置标记为end标签,输出的结果类似于:0.0056s
G('begin');
$data = ['test1', 'test2', 'test3', 'test' => 'test'];//这里是其他代码
G('end');
echo G('begin', 'end', 5) . 's';//数字代表保留几位小数
如果环境支持内存占用统计的话,还可以使用G方法进行区间内存开销统计(单位为kb)
G('begin','end','m').'kb';
[模型调试]
- 调试执行的SQL语句
用getLastsql方法来输出上次执行的sql语句,有时候数据不符合预期时,用此方法可以方便的观察查询语句,判断逻辑是否有误。
$User = M("User"); // 实例化User对象
$User->find(1);
echo $User->getLastSql();
// 3.2版本中可以使用简化的方法
echo $User->_sql(); - 调试数据库错误信息
CURD操作如果返回值为false,表示数据库操作发生错误,这个时候就需要使用模型的getDbError方法来查看数据库返回的具体错误信息。
$User = M("User"); // 实例化User对象
$result = $User->find(1);
if(false === $result){
echo $User->getDbError();
}