logcat是一个微型跨平台日志应用,笔者编写它,主要是用来开发cocos2d游戏的,代码托管在github上。这篇文章介绍如何使用它。
logcat包括两部分,用来打印日志的,下文称它为打印端;另一个部份为客户端编程接口,下文称它为客户端。 打印端和客户端通过udp协议通信。
打印端
打印端是一个electron app。在代码仓库根目录中,名为logcat.7z的文件是已经配置好了的windows版程序,解压后运行里面的electron.exe即可。代码仓库根目录的app文件夹实际上是打印端的程序主体,使用mac或者linux的朋友,可以按照electron官网的说明将它安装到各自平台的electron程序中。 以下为打开打印端界面截图:
- clear按钮用来清除打印的日志。
- level选项用来选择打印日志的最低等级。 等级高低为e>w>d>i。比如选择了d,那么e,w,d等级的日志都会打印,但是i等级的不会。日志的四个等级在下文中的编程端的i,d,w,e部分有介绍。
- 三个输入框:tag、logid、search为关键词过滤,过滤掉不包含关键词的日志。tag输入框对应标签栏,输入的key,如果标签栏内容不包含该key的日志将会被过滤掉;logid为客户端注册的识别码,通常不会打印出来,输入某个logid就只会打印注册的logid为该logid的客户端的日志了;search输入框对应内容栏,过滤掉内容不包含输入的key的日志,并且内容栏中与key吻合的部分会用红字标注出来。
- 时间栏显示客户端产生此日志的时间。
- 等级栏显示日志等级,包括i,d,w,e。
- 标签即为日志的tag。
- 内容即为日志信息主体
客户端(c++)
编程端提供win32 c++,node.js以及lua三个版本,这里主要介绍c++版在vs中的配置。
打印Hello,world!
- 1、在你的项目中附加包含目录,目录为代码仓库根目录下的cpp_win32目录。主要的头文件只有一个UdpLog.h文件。
- 2、通过添加现有项,将cpp_win32目录下的UdpLog.cpp文件添加到项目中。
- 3、在打印日志之前,需调用
UdpLog::resetDst(ip,port,logid)
函数初始化,其中ip为打印端的ip地址,port为打印端监听的端口号(打印端默认端口号为20131),logid为客户端识别码。 - 4、之后添加代码
UdpLog::si("Hello,world!");
即可。
日志等级i,d,w,e
最基础的打印函数为UdpLog::i(tag,msg),UdpLog::d(tag,msg),UdpLog::w(tag,msg)以及UdpLog::e(tag,msg)。msg参数即为要打印的字符串;tag参数也为字符串,主要用来醒目的分类各种日志信息,它将会打印在标签栏中。它们的区别为日志等级不同:
- i: infomation的缩写,通常一些正常状况下的消息使用它打印,打印出来的信息格子背景色为绿色。
- d: debug的缩写,通常一些对调试有帮助的消息使用它,背景色为蓝色。
- w: warning的缩写,通常运行时出了一些不好的故障,但不影响使用时,就用它来打印相关信息,发出警告,背景色为橙色。
- e: error的缩写,打印错误信息,红色。
si、sd、sw、se
有时候我们打印信息可能并不在意tag是什么,此时就可以忽略它。si、sd、sw、se函数分别相当于i、d、w、e函数省略了tag参数,在函数内部会把tag值直接设为logid了。
StackTrace
包括UdpLog::iStackTrace、UdpLog::dStackTrace、UdpLog::wStackTrace、UdpLog::eStackTrace
四个函数,区别为四个日志等级。它们主要是打印调用栈,只有在win32平台中才能使用。
iBytes
函数UdpLog::iBytes(tag,bytes,len)
用来打印unsigned char数组,日志等级为infomation。bytes为数组或者指针,len为数组长度。打印的数组内容都用16进制数字表示,开头的数字为十进制,表示数组长度。