log4cplus库编译

123 阅读11分钟

sourceforge.net/projects/lo…

 其他版本:sourceforge.net/projects/lo…

下载最新的版本log4cplus-2.0.6

解压后打开vs项目

在对应的vs平台编译即可,生成库时要注意字符集,需要和调用平台一致,否者存在编译问题

除此之外,还有不同的调用例子:

 注意:编库时要注意字符集, window一般选择Unicode

注意:导入动态库时,开发环境是release版本对应release库,debug版本对应debug库

Layouts :控制输出消息的格式。 

Appenders :输出位置。 

Logger :日志对象。 

Priorities :优先权,包括TRACE, DEBUG, INFO, WARNING, ERROR, FATAL。

log4cplus****初始化

log4cplus::Initializer Initializer;//当这个初始化变量析构时,log4cplus库释放所有内存空间,也就是退出log4cplus

Singleton<LogManager>::GetInstance();//主线程单例初始化,线程初始化并调用log4cplus会崩溃,不知道为什么

使用步骤:

a.) 生成Appender对象。

b.) 生成Layout对象,并绑定到Appender。(可选)

c.) 生成Logger对象。

d.) 设置Logger优先级。(可选)

e.) 将需要关联Logger的Appender添加到Logger上。

f.) 使用Logger输出信息,所有大于设定的优先级的信息,并在所有挂接在该Logger对象上的Appender上以相应的Layout设定的格式显示出来。

1. 选择logger

Logger logger = Logger::getRoot(); 这个用来选择rootLogger的

其他的还可以配置更多的logger,Logger logger = log4cplus::Logger::getInstance("test");

Logger对象具有层次结构,按名称区分,如下代码:

Logger test = Logger::getInstance(“test”);

Logger subtest = Logger::getInstance(“test.subtest”);对象subtest是test的子对象。

2. 优先级

log4cplus优先级有低到高:

  • NOT_SET_LOG_LEVEL :接受缺省的LogLevel,如果有父logger则继承它的LogLevel
  • ALL_LOG_LEVEL : 开放所有log信息输出
  • TRACE_LOG_LEVEL : 开放trace信息输出(即ALL_LOG_LEVEL)
  • DEBUG_LOG_LEVEL :开放debug信息输出
  • INFO_LOG_LEVEL : 开放info信息输出
  • WARN_LOG_LEVEL :开放warning信息输出
  • ERROR_LOG_LEVEL :开放error信息输出
  • FATAL_LOG_LEVEL : 开放fatal信息输出
  • OFF_LOG_LEVEL :关闭所有log信息输出

各个logger可以通过setLogLevel设置自己的优先级,当某个logger的LogLevel设置成NOT_SET_LOG_LEVEL时,该logger会继承父logger的优先级,

另外,如果定义了重名的多个logger, 对其中任何一个的修改都会同时改变其它logger。

3. appender配置

每个logger可以添加appender,在logger后面的第二个参数即为apppender

如这个例子:log4cplus.rootLogger=ERROR, R

名称为R的appender

在appender上可以设置日志输出位置、日志路径、layout等等内容

Appender输出位置

(1)控制台输出

ConsoleAppender

(2)文件输出

FileAppender / RollingFileAppender / DailyRollingFileAppender .

FileAppender :

实现了基本的文件操作功能,构造函数如下:

FileAppender(filename,mode,immediateFlush);
   filename: 文件名
   mode :    文件类型,可选择的文件类型包括app、ate、binaryinout、trunc,
                 因为实际上只是对stl的一个简单包装,缺省是trunc,表示将先前文件删除。
   immediateFlush :缓冲刷新标志,如果为true表示每向文件写一条记录就刷新一次缓存,
                    否则直到FileAppender被关闭或文件缓存已满才更新文件,一般是要设置true的,
                    比如你往文件写的过程中出现了错误(如程序非正常退出),即使文件没有正常关闭也可以保证程序终
                    止时刻之前的所有记录都会被正常保存。

RollingFileAppender:
RollingFileAppender(filename,maxFileSize,maxBackupIndex,immediateFlush)
      filename                : 文件名
      maxFileSize          : 文件的最大尺寸
      maxBackupIndex : 最大记录文件数
      immediateFlush    : 缓冲刷新标志                                                   
RollingFileAppender类可以根据你预先设定的大小来决定是否转储,当超过该大小,后续log信息会另存到新文件中,
除了定义每个记录文件的大小之外,你还要确定在RollingFileAppender类对象构造时最多需要多少个这样的记录文件
(maxBackupIndex+1),当存储的文件数目超过maxBackupIndex+1时,会删除最早生成的文件,保证整个文件数目等于
maxBackupIndex+1。然后继续记录,

可以根据你预先设定的大小来决定是否转储,当超过该大小,后续log信息会另存到新文件中,除了定义每个记录文件的大小之外,你还要确定在RollingFileAppender类对象构造时最多需要多少个这样的记录文件(maxBackupIndex+1),当存储的文件数目超过maxBackupIndex+1时,会删除最早生成的文件,保证整个文件数目等于maxBackupIndex+1 。

调用

#define LOOP_COUNT 200000        
SharedAppenderPtr _append(new RollingFileAppender("Test.log", 5*1024, 5));    
_append->setName("file test");    
_append->setLayout( std::auto_ptr(new TTCCLayout()) );    
Logger::getRoot().addAppender(_append);    
Logger root = Logger::getRoot();    
Logger test = Logger::getInstance("test");    
Logger subTest = Logger::getInstance("test.subtest");    
for(int i=0; i<1000;i++)    {        
            NDCContextCreator _context("loop");        
            LOG4CPLUS_DEBUG(subTest, "Entering loop #" << i)   
   }    

运行结果:运行后会产生6个输出文件,Test.log、Test.log.1、Test.log.2、Test.log.3、Test.log.4、Test.log.5
                       其中Test.log存放着最新写入的信息,而最后一个文件中并不包含第一个写入信息,说明已经被不断更新了。
                       需要指出的是,这里除了Test.log之外,每个文件的大小都是200K,而不是我们想像中的5K,
                       这是因为log4cplus中隐含定义了文件的最小尺寸是200K,只有大于200K的设置才生效,<= 200k的设置都会被认为是200K.

DailyRollingFileAppender:

 构造函数如下:

DailyRollingFileAppender::DailyRollingFileAppender(const log4cplus::tstring& filename,
                                                    DailyRollingFileSchedule schedule,                                                  
                                                    bool immediateFlush,                                                  
                                                    int maxBackupIndex)                                                  
       filename       : 文件名
       schedule       : 存储频度
       immediateFlush : 缓冲刷新标志
       maxBackupIndex : 最大记录文件数

DailyRollingFileAppender类可以根据你预先设定的频度来决定是否转储,当超过该频度,后续log信息会另存到新文件中,这里的频度包括:MONTHLY(每月)、WEEKLY(每周)、DAILY(每日)、TWICE_DAILY(每两天)、HOURLY(每时)、MINUTELY(每分)。

maxBackupIndex的含义同上所述,比如以下代码片段:

SharedAppenderPtr _append(new DailyRollingFileAppender("Test.log", MINUTELY, true, 5));    
_append->setName("file test");    
_append->setLayout( std::auto_ptr(new TTCCLayout()) );    
Logger::getRoot().addAppender(_append);    
Logger root = Logger::getRoot();    
Logger test = Logger::getInstance("test");    
Logger subTest = Logger::getInstance("test.subtest");    
for(int i=0; i<100;i++)    {        
             NDCContextCreator _context("loop");        
             LOG4CPLUS_DEBUG(subTest, "Entering loop #" << i)    
}       

        运行结果:运行后会以分钟为单位,分别生成名为Test.log.2004-10-17-03-03、Test.log.2004-10-17-03-04和Test.log.2004-10-17-03-05这样的文件。
需要指出的是,刚看到按照频度(如HOURLY、MINUTELY)转储这样的概念,以为log4cplus提供了内部定时器,感觉很奇怪,因为日志系统不应该主动记录,而loging事件总是应该被动触发的啊。仔细看了源代码后才知道这里的"频度"并不是你写入文件的速度,其实是否转储的标准并不依赖你写入文件的速度,而是依赖于写入的那一时刻是否满足了频度条件,即是否超过了以分钟、小时、周、月为单位的时间刻度,如果超过了就另存。本部分详细介绍log信息的几种文件操作方式,下面将重点介绍一下如何有选择地控制log信息的输出。

4.Layout格式输出

1.SimpleLayout

是一种简单格式的布局器,在输出的原始信息之前加上LogLevel和一个”-“。

2.PatternLayout

是一种有词法分析功能的模式布局器,类似正则表达式。以“%”作为开头的特殊预定义标识符,将产生特殊的格式信息。

1.”%%”,转义为% 。

2.”%c”,输出logger名称,如test.subtest 。也可以控制logger名称的显示层次,比如”%c{1}”时输出”test”,其中数字表示层次。

3.” %D”,显示本地时间,比如:”2004-10-16 18:55:45”, %d显示标准时间。 可以通过%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 – 在大括号里表示哪个月
  • %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 – 输出当前记录器所在的文件名称,比如”main.cpp”

5,%L – 输出当前记录器所在的文件行号,比如”51”

6,%l – 输出当前记录器所在的文件名称和行号,比如”main.cpp:51”

7,%m – 输出原始信息。

8,%n – 换行符。

9,%p – 输出LogLevel,比如”DEBUG”

10,%t – 输出记录器所在的线程ID,比如 “1075298944”

11,%x – 嵌套诊断上下文NDC (nested diagnostic context) 输出,从堆栈中弹出上下文信息,NDC可以用对不同源的log信息(同时地)交叉输出进行区分。

格式对齐,比如”%-10m”时表示左对齐,宽度是10,当然其它的控制字符也可以相同的方式来使用,比如”%-12d”,”%-5p”等等。

3.TTCCLayout

其格式由时间,线程ID,Logger和NDC 组成。

 是在PatternLayout基础上发展的一种缺省的带格式输出的布局器, 其格式由时间,线程ID,Logger和NDC 组成(consists of time, thread, Logger and nested diagnostic context information, hence the name),因而得名, 关于NDC请参见6.4小节。

   以下代码片段演示了如何使用TTCCLayout。   

 ... ...
    /* step 1: Instantiate an appender object */
    SharedObjectPtr _append (new ConsoleAppender());
   _append->setName("append for test");
   
    /* step 2: Instantiate a layout object */
   std::auto_ptr _layout(new TTCCLayout());
   
    /* step 3: Attach the layout object to the appender */
   _append->setLayout( _layout );
   
    /* step 4: Instantiate a logger object */
   Logger _logger = Logger::getInstance("test_logger");
   
    /* step 5: Attach the appender object to the logger  */
   _logger.addAppender(_append);
   
     /* log activity */
    LOG4CPLUS_DEBUG(_logger, "teststr")
   
    ... ...

输出结果:

10-16-04 19:08:27,501 [1075298944] DEBUG test_logger <> - teststr
   TTCCLayout在构造时有机会选择显示本地时间或GMT时间,缺省是按照本地时间显示:
   TTCCLayout::TTCCLayout(bool use_gmtime  = false)
   如果需要构造TTCCLayout对象时选择GMT时间格式,则使用方式如下代码片断所示。
   ... ...
   
    /* step 2: Instantiate a layout object */
    std::auto_ptr _layout(new TTCCLayout(true));
   
    ... ...
输出结果:
10-16-04 11:12:47,678 [1075298944] DEBUG test_logger <> - teststr

测试代码:

#pragma once
#include "log4cplus/log4cplus.h"
#include "log4cplus/fileappender.h"
#include "log4cplus/loggingmacros.h"
#include "log4cplus/layout.h"
#include <log4cplus/helpers/loglog.h>
using namespace log4cplus;

#include "./common/design_pattern.h"
#include <sstream>
#include <mutex>

class LogManager
{
public:
	explicit LogManager();
	void debugWrite(std::string logStr);
	void infoWrite(std::string logStr);
	void warnWrite(std::string logStr);
	void errorWrite(std::string logStr);
private:
	log4cplus::Initializer m_Initializer;//当这个初始化变量释放(析构)时,log4cplus库释放所有内存空间
	Logger m_rootLogger;
	std::mutex m_mutex;
};

#define LOG_DEBUG(info) \
{\
	std::stringstream ss; \
	ss<<info<<"["<<__FILE__<<": "<<__LINE__<<"]" \
	Singleton<LogManager>::GetInstance()->debugWrite(ss.str());\
}\

#define LOG_INFO(info) \
{\
	std::stringstream ss; \
	ss<<info<<"["<<__FILE__<<": "<<__LINE__<<"]"; \
	Singleton<LogManager>::GetInstance()->infoWrite(ss.str());\
}\

#define LOG_ERROR(info) \
{\
	std::stringstream ss;\
	ss<<info<<"["<<__FILE__<<": "<<__LINE__<<"]"; \
	Singleton<LogManager>::GetInstance()->errorWrite(ss.str());\
}\

#include "log4cplus_custom.h"
//#include "string.h"


#pragma comment(lib,"log4cplus.lib")

LogManager::LogManager()
{
	m_mutex.lock();
	//setInternalDebugging()方法用来控制是否屏蔽输出信息中的调试信息,当输入参数为false则屏蔽,缺省设置为false。
	//setQuietMode()方法用来控制是否屏蔽所有输出信息,当输入参数为true则屏蔽,缺省设置为false。
	helpers::LogLog::getLogLog()->setInternalDebugging(true);//启用内部记录
	
	Logger::getRoot().setLogLevel(ALL_LOG_LEVEL);//设置日志级别

	//输出对象
	SharedFileAppenderPtr append_1(
		new RollingFileAppender(LOG4CPLUS_TEXT("logFile/LogFile.log"), 5 * 1024 * 1024, 5,
			true, true));
	append_1->setName(LOG4CPLUS_TEXT("cout"));
	//设置输出格式
	append_1->setLayout(std::unique_ptr<Layout>(new PatternLayout(LOG4CPLUS_TEXT("%D{%m/%d/%y %H:%M:%S} %m%n"))));
	//append_1->getloc();
	//设置输出对象
	Logger::getRoot().addAppender(SharedAppenderPtr(append_1.get()));
	//日志对象
	m_rootLogger = Logger::getRoot();
	Logger test = Logger::getInstance(LOG4CPLUS_TEXT("test"));
 	Logger subTest = Logger::getInstance(LOG4CPLUS_TEXT("test.subtest"));

// 	for (int i = 0; i < 100; i++) {
// 		LOG4CPLUS_DEBUG(m_rootLogger, "Entering loop #" << i);
// 	}
	m_mutex.unlock();
}

void LogManager::debugWrite(std::string logStr)
{
	m_mutex.lock();
	LOG4CPLUS_DEBUG(m_rootLogger, logStr.c_str());
	m_mutex.unlock();
}

void LogManager::infoWrite(std::string logStr)
{
	m_mutex.lock();
	LOG4CPLUS_INFO(m_rootLogger, logStr.c_str());
	m_mutex.unlock();
}
void LogManager::warnWrite(std::string logStr)
{
	m_mutex.lock();
	LOG4CPLUS_WARN(m_rootLogger, logStr.c_str());
	m_mutex.unlock();
}

void LogManager::errorWrite(std::string logStr)
{
	m_mutex.lock();
	LOG4CPLUS_ERROR(m_rootLogger, logStr.c_str());
	m_mutex.unlock();
}