采用log4cpp三方库实现c++项目的日志管理demo

pert666

已于 2023-11-07 22:58:22 修改

阅读量114

点赞数

文章标签： c++ java 前端

于 2023-11-07 22:55:38 首次发布

本文链接：https://blog.csdn.net/pert666/article/details/134278018

版权

调用日志打印格式为：

LOG_DEBUG("这是一条DEBUG消息 %d, %s, %4f", a, str.c_str(),3.14159265);
LOG_INFO("这是一条信息消息%d,%s", a, str.c_str());
LOG_WARN("这是一条警告消息");
LOG_ERROR("这是一条错误消息");

可自定义日志生成格式，日志文件生成如下log：

2023-10-29 14:03:59,034 [DEBUG] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:111 main]这是一条DEBUG消息 10, aaa, 3.141593
2023-10-29 14:03:59,034 [INFO] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:112 main]这是一条信息消息10,aaa
2023-10-29 14:03:59,034 [WARN] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:113 main]这是一条警告消息
2023-10-29 14:03:59,034 [ERROR] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:114 main]这是一条错误消息
2023-10-29 14:03:59,034 [DEBUG] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:111 main]这是一条DEBUG消息 10, aaa, 3.141593
2023-10-29 14:03:59,035 [INFO] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:112 main]这是一条信息消息10,aaa
2023-10-29 14:03:59,035 [WARN] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:113 main]这是一条警告消息
2023-10-29 14:03:59,035 [ERROR] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:114 main]这是一条错误消息
2023-10-29 14:03:59,035 [DEBUG] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:111 main]这是一条DEBUG消息 10, aaa, 3.141593
2023-10-29 14:03:59,035 [INFO] [28232] [F:\vsTest\pert_2023_demo\code\cpp_test\cpp_log4Cpp\source\log4cpp_pet.cpp:112 main]这是一条信息消息10,aaa

注：以上日志格式为：时间+日志等级+线程号+文件路径名+函数名+打印内容

可以配置多个日志生成器实例，实现日志生成不同文件的日志：

其配置文件内容如下：

# 定义root Category的属性：指定rootcategory的log优先级为DEBUG，其中根Category包含两个appender，分别为 rootAppender1和 rootAppender2。
# log4cpp.rootCategory=DEBUG, rootAppender1, rootAppender2

log4cpp.rootCategory=DEBUG, rootAppender

# 自定义三个 category 的属性
#log4cpp.category.demo=DEBUG, sample   :自定义了一个名字为demo的category，其日志优先级为DEBUG，appender的名字为sample。

log4cpp.category.sub1=DEBUG, A1, A2
log4cpp.category.sub1.sub2=DEBUG, A3
log4cpp.category.txhAppender=DEBUG, txh
 
# 配置root Category中 rootAppender 的输出位置 输出格式，
#log4cpp.appender.rootAppender=ConsoleAppender   #打印控制台
#log4cpp.appender.rootAppender.layout=PatternLayout
#log4cpp.appender.rootAppender.layout.ConversionPattern=%d [%p] %m%n 

#log4cpp.appender.rootAppender=FileAppender #输出到文件
log4cpp.appender.rootAppender=RollingFileAppender #输出到文件，多了可以回滚
log4cpp.appender.rootAppender.fileName=logs/log4cpp.log
#当日志文件到达maxFileSize大小时，将会自动滚动
log4cpp.appender.rootAppender.maxFileSize=8388608 #最大1M
#maxBackupIndex指定可以产生的滚动文件的最大数
log4cpp.appender.rootAppender.maxBackupIndex=20  #10个文件
log4cpp.appender.rootAppender.threshold=DEBUG  #配置日志生效等级
#append=true 信息追加到上面指定的日志文件中，false表示将信息覆盖指定文件内容
#log4cpp.appender.rootAppender.append=true
log4cpp.appender.rootAppender.layout=PatternLayout
log4cpp.appender.rootAppender.layout.ConversionPattern=%d [%p] %m%n 



# 配置自定义 appender “A1” 的 输出位置和输出格式
log4cpp.appender.A1=FileAppender
log4cpp.appender.A1.fileName=logs/A1.log
log4cpp.appender.A1.layout=BasicLayout

# 配置自定义 appender “A2” 的 输出位置和输出格式
log4cpp.appender.A2=FileAppender
log4cpp.appender.A2.threshold=WARN
log4cpp.appender.A2.fileName=logs/A2.log
log4cpp.appender.A2.layout=PatternLayout
log4cpp.appender.A2.layout.ConversionPattern=%d [%p] %m%n 

# 配置自定义 appender “A3” 的 输出位置和输出格式
log4cpp.appender.A3=RollingFileAppender
log4cpp.appender.A3.fileName=logs/A3.log
log4cpp.appender.A3.maxFileSize=200
log4cpp.appender.A3.maxBackupIndex=1
log4cpp.appender.A3.layout=PatternLayout
log4cpp.appender.A3.layout.ConversionPattern=%d [%p] %m%n 
 
# 配置名字为  “txh”  的 自定义 appender的 输出位置和输出格式
log4cpp.appender.txh=SyslogAppender
log4cpp.appender.txh.layout=PatternLayout
log4cpp.appender.txh.layout.ConversionPattern=%d [%p] %m%n

项目中创建日志生成器及生成日志功能，具体代码实现demo如下：

/**
* @brief 采用log4cpp三方库实现c++项目的日志管理
*
* @param pert
* @param 2023年11月7日12:39:00
*/

#include <log4cpp/Category.hh>
#include <log4cpp/FileAppender.hh>
#include <log4cpp/PatternLayout.hh>
#include <log4cpp/PropertyConfigurator.hh>
#include <sstream>
#include <thread>
#include <chrono>
#include <iomanip>
#include <iostream>
#include <sys/stat.h>
#include <direct.h>


#define LOG4CPP_CATEGORY(priority, msg, ...) \
do { \
log4cpp::Category& logger = log4cpp::Category::getRoot(); \
logger.setPriority(log4cpp::Priority::priority); \
std::ostringstream oss; \
oss << "[" << std::this_thread::get_id() << "] [" << __FILE__ << ":" << __LINE__ << " " << __FUNCTION__ << "]" << msg; \
logger.log(log4cpp::Priority::priority, oss.str().c_str(), ##__VA_ARGS__); \
} while(0)



#define LOG_DEBUG(msg, ...) LOG4CPP_CATEGORY(DEBUG, msg, ##__VA_ARGS__)
#define LOG_INFO(msg, ...) LOG4CPP_CATEGORY(INFO, msg, ##__VA_ARGS__)
#define LOG_WARN(msg, ...) LOG4CPP_CATEGORY(WARN, msg, ##__VA_ARGS__)
#define LOG_ERROR(msg, ...) LOG4CPP_CATEGORY(ERROR, msg, ##__VA_ARGS__)


bool createDirectory(const std::string& path) {
	struct stat info;
	if (stat(path.c_str(), &info) != 0) {
		if (mkdir(path.c_str()) == 0) {
			std::cout << "Directory created: " << path << std::endl;
			return true;
		}
		else {
			std::cerr << "Failed to create directory: " << path << std::endl;
			return false;
		}
	}
	else if (info.st_mode & S_IFDIR) {
		std::cout << "Directory already exists: " << path << std::endl;
		return true;
	}
	else {
		std::cerr << "Path is not a directory: " << path << std::endl;
		return false;
	}
}

int main() {
	std::string logFolderPath = "logs";
	if (!createDirectory(logFolderPath)) {
		std::cerr <<"create Directory failed" << std::endl;
		return 1;
	}


	// 从YAML文件中加载日志配置
	try
	{
		//log4cpp::PropertyConfigurator::configure("./log4cpp.yaml");
		log4cpp::PropertyConfigurator::configure("./log4cpp.conf");
	}
	catch (log4cpp::ConfigureFailure& f)
	{
		std::cerr << f.what() << std::endl;
		return -1;
	}

	// 记录一些日志消息
	int a = 10;
	std::string str = "aaa";

	while (1) {
		LOG_DEBUG("这是一条DEBUG消息 %d, %s, %4f", a, str.c_str(),3.14159265);
		LOG_INFO("这是一条信息消息%d,%s", a, str.c_str());
		LOG_WARN("这是一条警告消息");
		LOG_ERROR("这是一条错误消息");
		//Sleep(10);
	}



	//再加载其他日志器，打印到其他文件
	
	//log4cpp::Category& root = log4cpp::Category::getRoot();
	log4cpp::Category& sub1 = log4cpp::Category::getInstance(std::string("sub1"));
	log4cpp::Category& sub2 = log4cpp::Category::getInstance(std::string("sub1.sub2"));
	log4cpp::Category& txh = log4cpp::Category::getInstance(std::string("txhAppender"));

	//root.warn("stom is coming%d", 1111);
	//root.debug("stom is coming%d",1111);
	//root.info("Ready for storm.");

	sub1.debug("Received storm warning");
	sub1.info("closing all hatches");
	sub2.debug("Hiding solar panels");
	sub2.error("Solar panels are blocked");
	sub2.debug("Applying protective shield");
	sub2.warn("Unfolding protective shield");
	sub2.info("Solar panels are shielded");

	sub1.info("All hatches closed");

	txh.info("caonima");

	log4cpp::Category::shutdown();


	Sleep(10000);
	return 0;
}