log4cplus学习

最新推荐文章于 2025-04-25 11:52:41 发布

skyztttt

最新推荐文章于 2025-04-25 11:52:41 发布

阅读量1.7k

点赞数

CC 4.0 BY-SA版权

分类专栏： C++ 文章标签： c语言

本文链接：https://blog.youkuaiyun.com/skyztttt/article/details/51492935

C++ 专栏收录该内容

6 篇文章

订阅专栏

由来：

c++程序开发在产品上线后往往需要依靠dump和log文件来追踪软件中的bug，之前总是自己采用writefile等方式进行打log，并没有感觉到有什么特别需要注意的地方。接触到log4cplus是由于工作过的两家公司都是用到了这个开源库，但发现都用得比较初级，发现很多也都是自己去格式化所有输出，并没有发现很多优势。遂网上看了些例子及log4cplus的例子，也算总结出来了一些经验吧…

优势：

开始研究了log4cplus的使用，便发现了一些好处：

1.能够规格化我们的log输出；

因为自己打的log往往内容可能随心情，或者需要特定的约束才能比较规整；而log4cplus只要设置统一的Layout便可以输出统一格式的log；
网上摘抄了一段代码：

SharedAppenderPtr  _append (new ConsoleAppender());    
_append->setName("append for test");   
/* step 2: Instantiate a layout object */    
std::string pattern = "%d{%m/%d/%y %H:%M:%S}  - %m [%l]%n";    
std::auto_ptr<Layout> _layout(new PatternLayout(pattern));   
/* step 3: Attach the layout object to the appender */    
_append->setLayout( _layout );   
/* step 4: Instantiate a logger object */    
Logger _logger = Logger::getInstance("test");   
/* step 5: Attach the appender object to the logger  */   
_logger.addAppender(_append);   
/* step 6: Set a priority for the logger  */    
_logger.setLogLevel(ALL_LOG_LEVEL);   
/* log activity */    
LOG4CPLUS_DEBUG(_logger, "This is the FIRST log message...");

最后程序输出为：

05/26/16 03:53:42 - This is the FIRST log message… [d:\qt_vs2015\log4cplus-1.2.0_vs2010\tests\configandwatch_test\main.cxx:53]

看到没！每次只要调用LOG4CPLUS_DEBUG(_logger, “This is the FIRST log message…”);轻松地帮我们打出了日期，时间还有代码对应的行…
效果相当明显！！！据说使用TTCCLayout也能较为方便地显示：

51 [11604] DEBUG test <> - This is the FIRST log message…

但实际使用好像没有显示出时间呀！其实，是显示着的啦，只是格式不对，设置下Properties就可以了。修改下代码：

log4cplus::helpers::Properties properties;
properties.setProperty(LOG4CPLUS_TEXT("DateFormat"), LOG4CPLUS_TEXT("%y/%m/%d %H:%M:%S"));
properties.setProperty(LOG4CPLUS_TEXT("Use_gmtime"), LOG4CPLUS_TEXT("false"));

std::auto_ptr<Layout> _layout(new TTCCLayout(properties));

搞定，查看输出：

16/05/26 15:44:21 [15072] DEBUG test <> - This is the FIRST log message…
顺便普及下GMT
GMT：格林尼标准时间
北京时间=GMT时间+8小时

TTCCLayout是在PatternLayout基础上发展的一种缺省的带格式输出的布局器，其格式由时间，线程ID，Logger和NDC （Nested Diagnostic Context）组成，其在构造时选择显示本地时间（默认false）或GMT时间。
NDC的内容参看http://blog.youkuaiyun.com/augusdi/article/details/8993481。
下面转下PatternLayout对应的规格化参数

（1）”%%”，转义为%, 即，std::string pattern = “%%” 时输出: “%”
（2）”%c”，输出logger名称，比如std::string pattern =”%c” 时输出: “test_logger.subtest”，
也可以控制logger名称的显示层次，比如”%c{1}”时输出”test_logger”，其中数字表示层次。
（3）”%D”，显示本地时间，当std::string pattern =”%D” 时输出:”2004-10-16 18:55:45”，%d显示标准时间，
所以当std::string pattern =”%d” 时输出 “2004-10-16 10:55:45” （因为我们是东8区，差8个小时啊）。
可以通过%d{…}定义更详细的显示格式，比如%d{%H:%M:%s}表示要显示小时:分钟：秒。大括号中可显示的
预定义标识符如下：
%a – 表示礼拜几，英文缩写形式，比如”Fri”
%A – 表示礼拜几，比如”Friday”
%b – 表示几月份，英文缩写形式，比如”Oct”
%B – 表示几月份，”October”
%c – 标准的日期＋时间格式，如 “Sat Oct 16 18:56:19 2004”
%d – 表示今天是这个月的几号(1-31)”16”
%H – 表示当前时刻是几时(0-23)，如 “18”
%I – 表示当前时刻是几时(1-12)，如 “6”
%j – 表示今天是哪一天(1-366)，如 “290”
%m – 表示本月是哪一月(1-12)，如 “10”
%M – 表示当前时刻是哪一分钟(0-59)，如 “59”
%p – 表示现在是上午还是下午， AM or PM
%q – 表示当前时刻中毫秒部分(0-999)，如 “237”
%Q – 表示当前时刻中带小数的毫秒部分(0-999.999)，如 “430.732”
%S – 表示当前时刻的多少秒(0-59)，如 “32”
%U – 表示本周是今年的第几个礼拜，以周日为第一天开始计算(0-53)，如 “41”
%w – 表示礼拜几，(0-6, 礼拜天为0)，如 “6”
%W – 表示本周是今年的第几个礼拜，以周一为第一天开始计算(0-53)，如 “41”
%x – 标准的日期格式，如 “10/16/04”
%X – 标准的时间格式，如 “19:02:34”
%y – 两位数的年份(0-99)，如 “04”
%Y – 四位数的年份，如 “2004”
%Z – 时区名，比如 “GMT”
（4）”%F”，输出当前记录器所在的文件名称，比如std::string pattern =”%F” 时输出: “main.cpp”
（5）”%L”，输出当前记录器所在的文件行号，比如std::string pattern =”%L” 时输出: “51”
（6）”%l”，输出当前记录器所在的文件名称和行号，比如std::string pattern =”%L” 时输出:
“main.cpp:51”
（7）”%m”，输出原始信息，比如std::string pattern =”%m” 时输出: “teststr”，即上述代码中
LOG4CPLUS_DEBUG的第二个参数，这种实现机制可以确保原始信息被嵌入到带格式的信息中。
（8）”%n”，换行符，没什么好解释的
（9）”%p”，输出LogLevel，比如std::string pattern =”%p” 时输出: “DEBUG”
（10）”%t”，输出记录器所在的线程ID，比如std::string pattern =”%t” 时输出: “1075298944”
（11）”%x”，嵌套诊断上下文NDC (nested diagnostic context) 输出，从堆栈中弹出上下文信息，NDC可以用对
不同源的log信息（同时地）交叉输出进行区分，关于NDC方面的详细介绍会在下文中提到。
（12）格式对齐，比如std::string pattern =”%-10m”时表示左对齐，宽度是10，此时会输出”teststr “，当
然其它的控制字符也可以相同的方式来使用，比如”%-12d”，”%-5p”等等（刚接触log4cplus文档时还以为
“%-5p”整个字符串代表LogLevel呢，呵呵）。

2.当log文件大于一定大小或者指定时间将能够自动转存；

如使用RollingFileAppender可以在log文件超过指定大小时进行转存，且可以设置留下的log总大小

3.各种模式；

比如可以在调试模式，通过loglog来控制输出调试、警告或错误信息，appender输出到屏幕。

4.可以对各种log级别进行过滤输出；

5.还有一点可以通过脚本进行配置输出。

这一点我觉得也很好用，当我们只在指定机器上重现一个bug是，我们可以将log输出级别下调（一般我们release版本都不会打出debug信息），我们可以修改配置文件来打印出debug信息编译发现问题。
一下附上官方的例子：

#include <log4cplus/logger.h>
#include <log4cplus/configurator.h>
#include <log4cplus/helpers/loglog.h>
#include <log4cplus/helpers/stringhelper.h>
#include <log4cplus/helpers/sleep.h>
#include <log4cplus/loggingmacros.h>

using namespace std;
using namespace log4cplus;
using namespace log4cplus::helpers;


Logger log_1 =  Logger::getInstance(LOG4CPLUS_TEXT("test.log_1"));
Logger log_2 =  Logger::getInstance(LOG4CPLUS_TEXT("test.log_2"));
Logger log_3 =  Logger::getInstance(LOG4CPLUS_TEXT("test.log_3"));


void
printMsgs(Logger& logger)
{
    LOG4CPLUS_TRACE_METHOD(logger, LOG4CPLUS_TEXT("printMsgs()"));
    LOG4CPLUS_DEBUG(logger, "printMsgs()");
    LOG4CPLUS_INFO(logger, "printMsgs()");
    LOG4CPLUS_WARN(logger, "printMsgs()");
    LOG4CPLUS_ERROR(logger, "printMsgs()");
}



int
main()
{
    tcout << LOG4CPLUS_TEXT("Entering main()...") << endl;
    log4cplus::initialize ();
    LogLog::getLogLog()->setInternalDebugging(true);
    Logger root = Logger::getRoot();
    try 
    {
        ConfigureAndWatchThread configureThread(
            LOG4CPLUS_TEXT("log4cplus.properties"), 5 * 1000);

        LOG4CPLUS_WARN(root, "Testing....");

        for(int i=0; i<4; ++i) {
            printMsgs(log_1);
            printMsgs(log_2);
            printMsgs(log_3);
            log4cplus::helpers::sleep(1);
        }
    }
    catch(...) {
        tcout << LOG4CPLUS_TEXT("Exception...") << endl;
        LOG4CPLUS_FATAL(root, "Exception occured...");
    }

    tcout << LOG4CPLUS_TEXT("Exiting main()...") << endl;
    return 0;
}

看到cpp代码中ConfigureAndWatchThread configureThread( LOG4CPLUS_TEXT(“log4cplus.properties”), 5 * 1000);可以动态的查看配置文件的状态，所以应该可以在不重启程序的情况下改变log的输出。
看完了cxx文件，该看看对应的脚本文件了。

log4cplus.rootLogger= WARN, TT, M
#log4cplus.logger.test=WARN
log4cplus.logger.test.log_1=FATAL
log4cplus.logger.test.log_2=FATAL
log4cplus.logger.test.log_3=WARN

log4cplus.appender.TT=log4cplus::ConsoleAppender
log4cplus.appender.TT.layout=log4cplus::PatternLayout
log4cplus.appender.TT.layout.ConversionPattern=%d{%m/%d/%y %H:%M:%S} [%t] %-5p %c{2} %%%x%% - %m [%l]%n

log4cplus.appender.M=log4cplus::RollingFileAppender
log4cplus.appender.M.File=output.log
#log4cplus.appender.M.MaxFileSize=5MB
log4cplus.appender.M.MaxFileSize=500KB
log4cplus.appender.M.MaxBackupIndex=5
log4cplus.appender.M.layout=log4cplus::TTCCLayout

看第一句吧，根节点设置了输出过滤级别为WARN，后面的两个名字可以随意取，和下面对应即可（原先demo里叫STDOUT， R），我实验了下，具体名字不重要。
后面设置两个appender的输出位置和layout都比较好理解～
总结了以上几点在实际的使用中该没有问题了，话说遇到问题再解决嘛！
最后还要感谢下这篇博文http://honey-bee.iteye.com/blog/65805，我从中学习到了很多～

缺点：

以上谈的都是有点，话说会有什么劣势么？答案还是有的，不过我知道的还很少。其中之一也是在项目中发现的：就是log4cplus在使用中会抛出异常，有些地方不能够抛出异常（try-catch也用不了），当初发现mfc如果在onPaint中抛出异常将会被吞掉（当时一个空指针异常居然也被吞掉了，这有点匪夷所思！！！），于是，我在其中添加了一个异常捕获，不过在该__except中是不允许使用能够抛出异常的类的，即无法使用log4cplus…，所以当时我使用了fprintf直接写文件，不过这毕竟是一个不常发生的问题，一旦有这个文件，一定是onPaint中发生了比较严重的问题，不牵涉到转储的问题。

__try
{
    ......;
}
__except(EXCEPTION_EXECUTE_HANDLER)
{
    {           
        FILE * file = fopen(".\\xxx", "a");
        fprintf(file, "%s-- CIconListCtrl::DrawNodesRecursive ExceptionCode : d\n", strDataTime, GetExceptionCode());
        // EXCEPTION_ACCESS_VIOLATION 空指针异常
        //#define STATUS_ACCESS_VIOLATION          ((NTSTATUS)0xC0000005L)

        fclose(file); 
    }
}