Wallogit.com
2017 © Pedro Peláez
Secondary development luofei614/socketlog
SocketLog适合Ajax调试和API调试， 举一个常见的场景，用SocketLog来做微信调试， 我们在做微信API开发的时候，如果API有bug，微信只提示“改公众账号暂时无法提供服务，请稍候再试” ，我们根本不知道API出来什么问题。 有了SocketLog就不一样了， 我们可以知道微信给API传递了哪些参数， 程序有错误我们也能看见错误信息(下方有张图片，可能加载慢，请耐心等待一下), (*1)
, (*2)
npm install -g socketlog-server , 运行命令 socketlog-server 即可启动服务。 将会在本地起一个websocket服务 ，监听端口是1229 。 如果想服务后台运行： socketlog-server > /dev/null & 我们提供公用的服务端，需要去申请client_id : http://slog.thinkphp.cn/在自己的程序中发送日志：, (*3)
<?php
include './php/slog.function.php';
slog('hello world');
?>
用slog函数发送日志， 支持多种日志类型：, (*4)
slog('msg','log'); //一般日志
slog('msg','error'); //错误日志
slog('msg','info'); //信息日志
slog('msg','warn'); //警告日志
slog('msg','trace');// 输入日志同时会打出调用栈
slog('msg','alert');//将日志以alert方式弹出
slog('msg','log','color:red;font-size:20px;');//自定义日志的样式，第三个参数为css样式
通过上面例子可以看出， slog函数支持三个参数：, (*5)
例如：我们如果想将程序的报错信息页输出到console，可以配置, (*6)
<?php
include './php/slog.function.php';
slog(array(
'error_handler'=>true
),'config');
echo notice;//制造一个notice报错
slog('这里是输出的一般日志');
?>
还支持其他配置项, (*7)
<?php include './php/slog.function.php'; slog(array( 'enable'=>true,//是否打印日志的开关 'host'=>'localhost',//websocket服务器地址，默认localhost 'optimize'=>false,//是否显示利于优化的参数，如果运行时间，消耗内存等，默认为false 'show_included_files'=>false,//是否显示本次程序运行加载了哪些文件，默认为false 'error_handler'=>false,//是否接管程序错误，将程序错误显示在console中，默认为false 'force_client_id'=>'',//日志强制记录到配置的client_id,默认为空 'allow_client_ids'=>array()////限制允许读取日志的client_id，默认为空,表示所有人都可以获得日志。 ) ,'config'); ?>
[运行时间：0.081346035003662s][吞吐率：12.29req/s][内存消耗：346,910.45kb] 
设置client_id后能实现以下功能：, (*8)
1，配置allow_client_ids 配置项，让指定的浏览器才能获得日志，这样就可以把调试代码带上线。 普通用户访问不会触发调试，不会发送日志。 开发人员访问就能看的调试日志， 这样利于找线上bug。 Client_ID 建议设置为姓名拼命加上随机字符串，这样如果有员工离职可以将其对应的client_id从配置项allow_client_ids中移除。 client_id除了姓名拼音，加上随机字符串的目的，以防别人根据你公司员工姓名猜测出client_id,获取线上的调试日志。, (*9)
设置allow_client_ids示例代码：, (*10)
slog(array(
'allow_client_ids'=>array('luofei_zfH5NbLn','easy_DJq0z80H')
),'set_config')
2, 设置force_client_id配置项，让后台脚本也能输出日志到chrome。 网站有可能用了队列，一些业务逻辑通过后台脚本处理， 如果后台脚本需要调试，你也可以将日志打印到浏览器的console中， 当然后台脚本不和浏览器接触，不知道当前触发程序的是哪个浏览器，所以我们需要强制将日志打印到指定client_id的浏览器上面。 我们在后台脚本中使用SocketLog时设置force_client_id 配置项指定要强制输出浏览器的client_id 即可。, (*11)
示例代码:, (*12)
<?php
include './php/slog.function.php';
slog(array(
'force_client_id'=>'luofei_zfH5NbLn'
),'config');
slog('test'); `
使用composer安装命令 composer require luofei614/socketlog, (*13)
直接调用静态方法, (*14)
<?php
require './vendor/autoload.php';
use think\org\Slog
//配置socketlog
Slog::config(array(
'enable'=>true,//是否打印日志的开关
'host'=>'localhost',//websocket服务器地址，默认localhost
'optimize'=>false,//是否显示利于优化的参数，如果运行时间，消耗内存等，默认为false
'show_included_files'=>false,//是否显示本次程序运行加载了哪些文件，默认为false
'error_handler'=>false,//是否接管程序错误，将程序错误显示在console中，默认为false
'force_client_id'=>'',//日志强制记录到配置的client_id,默认为空
'allow_client_ids'=>array()////限制允许读取日志的client_id，默认为空,表示所有人都可以获得日志。
));
Slog::log('log'); //一般日志
Slog::error('msg'); //错误日志
Slog::info('msg'); //信息日志
Slog::warn('msg'); //警告日志
Slog::trace('msg');// 输入日志同时会打出调用栈
Slog::alert('msg');//将日志以alert方式弹出
Slog::log('msg','color:red;font-size:20px;');//自定义日志的样式，第三个参数为css样式
ThinkPHP5后， 在框架层集成了SocketLog ，只需要设置配置即可用
用slog函数打印sql语句是，第二个参数传递为mysql或mysqli的对象即可。 示例代码：, (*15)
$link=mysql_connect( 'localhost:3306' , 'root' , '123456' , true ) ;
mysql_select_db('kuaijianli',$link);
$sql="SELECT * FROM `user`";
slog($sql,$link);
后面会以OneThink为实例再对数据库调试进行演示。, (*16)
通过上面的方法，socketlog还能自动为你检测没有where语句的sql操作，然后自动提示你。, (*17)
网站调用了API ，如何将API程序的调试信息也打印到浏览器的console中？ 前面我们讲了一个配置 force_client_id， 能将日志强制记录到指定的浏览器。 用这种方式也可以将API的调试信息打印到console中，但是force_client_id 只能指定一个client_id， 如果我们的开发环境是多人共用，这种方式就不方便了。 其实只要将浏览器传递给网站的User-Agent 再传递给API， API程序中不用配置force_client_id， 也能识别当前访问程序的浏览器， 将日志打印到当前访问程序的浏览器， 我们需要将SDK代码稍微做一下修改。 调用API的SDK，一般是用curl写的，增加下面代码可以将浏览器的User-Agent传递到API 。, (*18)
$headers=array();
if(isset($_SERVER['HTTP_USER_AGENT']))
{
$headers[]='User-Agent: '.$_SERVER['HTTP_USER_AGENT'];
}
if(isset($_SERVER['HTTP_SOCKETLOG']))
{
$headers[]='Socketlog: '.$_SERVER['HTTP_SOCKETLOG'];
}
curl_setopt($ch,CURLOPT_HTTPHEADER,$headers);
进入chrome浏览器的“工具”-->“扩展程序” ， 点击SocketLog的“选项”进行设置。, (*19)
有了SocketLog，我们能很方便的分析开源程序，下面以OneThink为例， 大家可以在 http://www.topthink.com/topic/2228.html 下载最新的OneThink程序。 安装好OneThink后，按下面步骤增加SocketLog程序。, (*20)
编辑入口文件index.php, 再代码的最前面加载slog.function.php ,并设置SocketLog, (*21)
<?php
include './slog.function.php';
slog(array(
'error_handler'=>true,
'optimize'=>true,
'show_included_files'=>true
),'config');
编辑ThinkPHP/Library/Think/Db/Driver.class.php 文件，在这个类中的execute 方法为一个执行sql语句的方法，增加代码：, (*22)
slog($this->queryStr,$this->_linkID);
类中的query方法也是一个执行sql语句的地方， 同样需要增加上面的代码, (*23)
然后浏览网站看看效果：, (*24)
![enter image description here][4], (*25)
通过console的日志，访问每一页我们都知道程序干了什么，是一件很爽的事情。, (*26)
http://edu.yuantuan.com/course/198, (*27)
感谢猿团的张盛翔（诺墨）提供教程。, (*28)