ThinkPHP5.0增强了开发调整功能,通过强化\think\Log类的功能实现了在不同的环境下面可以使用相同的方法进行调试和输出。
## 调试方法
系统提供了统一的调试和写入方法,例如:
~~~
// 记录调试信息到内存 系统由 \think\Log::save()方法统一写入
\think\Log::record('调试信息','日志类型');
// 直接写入调试信息
\think\Log::write('调试信息','日志类型');
~~~
最主要的方法就是 `\think\Log::record()`,系统也提供了一个快捷操作方法trace:
~~~
trace('调试信息','log');
trace(['aaa','bbb'],'debug');
~~~
> record方法支持各种变量的调试输出。
使用`Log::record()`或者`trace`方法后,通过设置就可以在下面不同的环境中输出调试结果。
## 本地文件调试
设置如下:
~~~
'log'=>[
'type'=>'file',
'path'=> LOG_PATH,
]
~~~
会在`LOG_PATH`下面生成调试日志文件。
## 页面Trace调试
设置如下:
~~~
'response_exit'=>false,
'log'=>[
'type'=>'trace',
'trace_file'=> THINK_PATH.'tpl/page_trace.tpl',
]
~~~
运行后可以看到右下角出现了如下图示:
![](https://box.kancloud.cn/2015-12-21_5677e629294b9.png)
点击图标后可以看到详细的页面Trace信息
![](https://box.kancloud.cn/2015-12-21_5677e62936858.png)
可以切换显示不同的Tab项查看不同类型的日志信息。
> 需要注意的是,如果要使用页面Trace调试功能,需要设置response_exit为false(否则无法在控制器输出之后显示页面Trace信息)。
## SocketLog调试
ThinkPHP5.0版本开始,整合了SocketLog用于本地和远程调试。
设置如下:
~~~
'log'=>[
'type' => 'socket',
'host' => 'slog.thinkphp.cn',
//日志强制记录到配置的client_id
'force_client_ids' => [],
//限制允许读取日志的client_id
'allow_client_ids' => [],
]
~~~
使用Chrome浏览器运行后,打开审查元素->Console,可以看到如下所示:
![](https://box.kancloud.cn/2015-12-21_5677e629495bb.png)
SocketLog通过websocket将调试日志打印到浏览器的console中。你还可以用它来分析开源程序,分析SQL性能,结合taint分析程序漏洞。
### 安装Chrome插件
SocketLog首先需要安装chrome插件
Chrome插件安装页面: https://chrome.google.com/webstore/detail/socketlog/apkmbfpihjhongonfcgdagliaglghcod (需翻墙)
### 使用方法
* 首先,请在chrome浏览器上安装好插件。
* 安装服务端`npm install -g socketlog-server` , 运行命令 `socketlog-server` 即可启动服务。 将会在本地起一个websocket服务 ,监听端口是1229 。 如果想服务后台运行: `socketlog-server > /dev/null &` 我们提供公用的服务端,需要去申请client_id : [http://111.202.76.133/](http://111.202.76.133/)
### 参数
* `client_id`: 在chrome浏览器中,可以设置插件的`Client_ID` ,**Client_ID**是你任意指定的字符串。
![](https://box.kancloud.cn/2015-12-10_56696b0402f84.png)
* 设置`client_id`后能实现以下功能:
* 1,配置`allow_client_ids` 配置项,让指定的浏览器才能获得日志,这样就可以把调试代码带上线。 普通用户访问不会触发调试,不会发送日志。 开发人员访问就能看的调试日志, 这样利于找线上bug。 **Client_ID** 建议设置为姓名拼音加上随机字符串,这样如果有员工离职可以将其对应的`client_id`从配置项allow_client_ids中移除。 `client_id`除了姓名拼音,加上随机字符串的目的,以防别人根据你公司员工姓名猜测出`client_id`,获取线上的调试日志。
* 设置allow_client_ids示例代码:
~~~
'allow_client_ids'=>['thinkphp_zfH5NbLn','luofei_DJq0z80H'],
~~~
* 2, 设置`force_client_id`配置项,让后台脚本也能输出日志到chrome。 网站有可能用了队列,一些业务逻辑通过后台脚本处理, 如果后台脚本需要调试,你也可以将日志打印到浏览器的console中, 当然后台脚本不和浏览器接触,不知道当前触发程序的是哪个浏览器,所以我们需要强制将日志打印到指定`client_id`的浏览器上面。 我们在后台脚本中使用SocketLog时设置`force_client_id` 配置项指定要强制输出浏览器的`client_id` 即可。