c++日志工具之——log4cplus

1 日志简介

程序都不可避免地会出现错误输出或崩溃的情况，这种情况往往在开发阶段很难发现，需要在特定的环境下才会出现，一旦出现这种情况，我们需要快速地定位到问题。很显然，当程序出现这种问题时，如果程序自己能够将当时出现该问题的原因记录下来，则能给我们带来莫大的效率，正是因为有了这种需求，所以就有了日志系统。所谓日志，就是程序运行时自动记录每日运行状态的一种行为，这跟我们传统说的打debug的方法有点区别，我们在刚开始学习C/C++语言的时候，接触到的只是类似于printf/cout的一些标准输入输出的东西，我们通常利用这些函数来辅助调试程序，当时也完全没有日志的概念。实际上到了真正做项目你会发现，这种传统的打debug的方式有明显的不足，不但输出的信息不美观，也不能做到实时记录，更不方便根据需求随意控制输出，这一切在日志系统中得到解决。

2 log4cplus简介

log4cplus移植于Java中的日志系统log4j，使用上也和log4j大同小异，这是一个很优秀的日志系统。log4j由三个组件构成——布局组件（Layouts）、追加组件（Appends）及真正实现日志功能的日志组件（Loggers）。布局组件用来控制日志输出的格式。追加组件定义日志输出的设备，如控制台、文件、socket、共享内存等，都可以成为追加组件，我们通常使用控制台和文件作为日志输出设备，在调试时我们将日志定位到控制台，而实际发布运行时将其定位到文件。日志组件提供对日志级别的控制，级别从高到低依次为FATAL_LOG_LEVEL、 ERROR_LOG_LEVEL、 WARN_LOG_LEVEL、 INFO_LOG_LEVEL 、DEBUG_LOG_LEVEL、 TRACE_LOG_LEVEL、 NOT_SET_LOG_LEVEL。

3 log4cplus的安装

log4cplus是开源的，源代码可在这里找到。下载源代码压缩包后解压，进入主目录。和大多数autotools工程一样，顺序执行以下命令即可完成安装。

./configure
make
make install

安装文件将默认安装到/usr/local，库文件置于/usr/local/lib，头文件置于/usr/local/include。

是的，这里介绍的安装及下面介绍的应用都是基于linux系统。

4 log4cplus的使用

以下是官方提供的“hello, world”的示例程序：

#include 
#include 
#include 
#include 

using namespace log4cplus;

int main()
{
    BasicConfigurator config;
    config.configure();
    
    Logger logger = Logger::getInstance(LOG4CPLUS_TEXT("main"));
    LOG4CPLUS_WARN(logger, LOG4CPLUS_TEXT("Hello, World!"));
    return 0;
}

程序包含了一些必要的头文件，编译时需要链接log4cplus库，将这段代码保存为 test.cpp，执行以下命令编译：

g++ test.cpp -o test -llog4cplus

编译后生成 test 可执行文件，运行./test，得到如下输出：

WARN - Hello, World!

这个程序使用的是log4cplus内置的默认配置选项，实际使用中一般要自己配置选项，接下来你会看到。

5 log4cplus配置

log4cplus配置就是定义appender, 定义输出的格式即 layout。以下列出两种常用配置，以供参考。

配置输出到控制台（通常用于前台程序）：

log4cplus.logger.logmain = TRACE, console
log4cplus.appender.console = log4cplus::ConsoleAppender
log4cplus.appender.console.layout = log4cplus::PatternLayout
log4cplus.appender.console.layout.ConversionPattern = [%D{%m/%d/%y %H:%M:%S,%q} %-5p] - %m%n

配置输出到文件（通常用于后台程序）：

log4cplus.logger.logmain = INFO, file
log4cplus.appender.file = log4cplus::FileAppender
log4cplus.appender.file.File = /var/log/myapp.log
log4cplus.appender.file.MaxFileSize = 10M
log4cplus.appender.file.Append = true
log4cplus.appender.file.layout = log4cplus::PatternLayout
log4cplus.appender.file.layout.ConversionPattern = [%D{%m/%d/%y %H:%M:%S,%q} %-5p] - %m%n

简单说明一下，配置文件中log4cplus.logger.logmain即定义一个logmain对象，后面跟的两个字段前一个表示log级别，后一个指定使用的appender，即日志输出对象。log级别按严重程度从低到高依次为TRACE、DEBUG、INFO、WARN、ERROR、FATAL。log4cplus.appender.xxx定义具体的appender属性，如是控制台还是文件，进一步配置文件名、文件大小等。

将配置保存到一个配置文件中（如log4cplus.conf），以下你将看到如何使用配置文件。有关更详细的配置，读者可自行摸索。

6 log4cplus运用于项目

以上“hello, world”程序只是大概演示log4cplus的用法，实际项目使用要有系统观念，就是怎样用才更方便，我们可以再做点封装。我们可以定义一个全局logger对象，将log4cplus初始化配置放到一个源文件中，重新定义一些简化的宏置于头文件，比如笔者就定义了Log.h/Log.cpp两个文件，代码如下：

Log.h文件：

#pragma once

#include 
#include 

using namespace log4cplus;
using namespace log4cplus::helpers;

// global object
extern Logger logger;

// define some macros for simplicity
#define LOG_TRACE(logEvent)			LOG4CPLUS_TRACE(logger, logEvent)
#define LOG_DEBUG(logEvent)			LOG4CPLUS_DEBUG(logger, logEvent)
#define LOG_INFO(logEvent)			LOG4CPLUS_INFO(logger, logEvent)
#define LOG_WARN(logEvent)			LOG4CPLUS_WARN(logger, logEvent)
#define LOG_ERROR(logEvent)			LOG4CPLUS_ERROR(logger, logEvent)
#define LOG_FATAL(logEvent)			LOG4CPLUS_FATAL(logger, logEvent)

extern void InitLogger(bool daemonized);

Log.cpp文件：

#include 
#include 
#include 
#include 
#include 

#include "Log.h"

Logger logger = Logger::getInstance(LOG4CPLUS_TEXT("logmain"));

void InitLogger(bool daemonized)
{
	if (daemonized)
		PropertyConfigurator::doConfigure(LOG4CPLUS_TEXT("/your/path/log4cplusd.conf"));
	else
		PropertyConfigurator::doConfigure(LOG4CPLUS_TEXT("/your/path/log4cplus.conf"));
}

将这两个文件置于你的项目中，然后在 main 函数中调用 InitLogger() 初始化 log4cplus，再在需要加log的文件中包含Log.h即可。注意InitLogger函数的参数daemonized，该参数表示应用程序是否是守护进程（后台运行），一般我们开发的应用程序大多是守护进程（linux后台服务大多是守护进程），但调试的时候会前台运行，对于守护进程，我们只需要把日志记录到某个文件中就行了，而对于前台调试运行，我们就只需要将日志输出到控制台，所以这里是一点使用技巧。做到这点我们只需分别提供两个配置文件即可，"/your/path"就是你放置配置文件的地方，一般可以设为你应用程序部署的目录下的etc目录。

至此我们可以使用log4cplus了！以下是实际的日志输出效果：

[11/05/12 10:28:36,002 INFO ] - TCPDomain - TCPDomain()
[11/05/12 10:28:36,002 INFO ] - TCPDomain - Connect server success!
[11/05/12 10:28:36,002 TRACE] - Session - Thread run.
[11/05/12 10:28:46,006 ERROR] - TCPDomain - SelectRead time out!
[11/05/12 10:28:56,016 ERROR] - TCPDomain - SelectRead time out!

7 log4cplus交叉编译

对于嵌入式应用 ，有交叉编译这么一说。以上的介绍是基于PC的，如果你的平台是嵌入式平台如arm，则只需编译链接arm平台的log4cplus库即可，其它都一样。对于大多数autotools工程，其交叉编译方法大致如下：

./configure --prefix=/your/install/path --host=arm-linux CXX=your-toolkit-g++
make
make install

其中--prefix即指定你的安装目录，如/opt/log4cplus，--host指定目标平台，CXX指定你的交叉编译工具（确保shell环境能找到该工具）。编译安装完后可在安装目录找到arm版本的库文件。

8 总结

日志固然好，但也不建议随意使用，用多了会导致程序性能有所下降，且代码size增加不少。以上是笔者运用log4cplus的些许经验，更深一步的原理机制有待进一步探究。