如何优雅的跨平台输出log日志 C++

已于 2022-04-07 11:12:47 修改
阅读量1.7k 收藏 5
点赞数 2
分类专栏： C++之开源框架 文章标签： c++ 日志 跨平台
于 2022-04-06 18:59:26 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42956179/article/details/123991436
版权

文章目录

前言

作为一名合格的程序员，进行调试，找bug的时候不可能单单只靠断点或者进行printf输出，这种方式不仅不够准确与及时，比如解决一些不能够必现的问题，而且如果产品到了用户发生了问题，没有日志就很有可能遗漏了当时的场景。

所以我们就需要一种可以记录程序运行状态的日志，这里采用的是goole推出的glog，是一种跨windows、mac、ios、android、linux的强大开源工具。笔者为了方便书写代码，添加了部分宏定义。

本文只在windows下进行示范，其他平台基本一致。

一、glog

1.基本满足的功能

一个合格的日志在笔者看来最少要拥有日志类型、日期、时间、文件名、行号、线程号、日志内容才能够准确的帮助定位到一些问题的所在，也就是这样的格式：

IWEFmmddhh:mm:ss.uuuuuuthreadidfile:line]msg

其中类型含义：

IWEF
INFOWARNNINGERRORFATAL

最终输出的日志看起来像是这样的

Log file created at: 2022/04/06 17:37:49
Running on machine: A120282
Running duration (h:mm:ss): 0:00:00
Log line format: [IWEF]yyyymmdd hh:mm:ss.uuuuuu threadid file:line] msg
I20220406 17:37:49.679339 20356 main.cpp:21] hello world

2.进阶的功能

在实际使用过程中，除了上面基本的功能，其实有的时候会遇到以下的问题：例如格式化输出日志，日志打满，如何多线程使用，更有的希望在用户那边使用的时候进行加密处理。笔者会接下来做一些测试证明以下glog都是支持的，除了加解密笔者自己没有进行尝试过，但是从glog的API中是看到可以进行加解密的（后面笔者如果使用到会再次添加）。

  1. 可以正常输出Unicode字符集（中文日志）
  2. 支持加/解密
  3. 支持多线程输出日志
  4. 控制日志文件大小
  5. 日志打满后自动新建文件

|版本声明：山河君，未经博主允许，禁止转载

2.glog源码编译

直接从github上下载，使用CMake编译就好了，如果想省事，可以直接下载别人编好的
github：https://github.com/google/glog
在这里插入图片描述
笔者这边编译的是动态库，注意有些头文件需要稍微移动一下，总体使用的头文件和编译成功的库如下：
在这里插入图片描述

二、使用

这边就直接省略工程创建和基本的配置拉…

1.初步使用

这里值得注意的是一些flag的配置，使用的拼接的语法，感兴趣的小伙伴可以自行跟踪代码进去查看。google的注释写的真的是没话说。

同时，如果采用不同的连接方式（静态/动态） 宏定义（如动态库为：GLOG_NO_ABBREVIATED_SEVERITIES）是不同的，不过在编译的时候有错误输出，可以很直观的看到，就不过多介绍了。

要注意宏定义要加载glog/logging.h 头文件之前


#define GLOG_NO_ABBREVIATED_SEVERITIES

#include "glog/logging.h"
#include <string>
#include <iostream>

int main()
{
	std::string strLogName = "test";
	std::string strLogPath = "E:/log/";
	std::string strDestination = strLogPath + strLogName;
	google::InitGoogleLogging(strLogName.c_str());
	google::SetStderrLogging(google::GLOG_FATAL);
	google::SetLogDestination(google::GLOG_INFO, strDestination.c_str());
	FLAGS_colorlogtostderr = true;	//如果输出到终端是否需要颜色标记
	FLAGS_logbufsecs = 0;		//设置日志输出等待时间
	FLAGS_max_log_size = 50;	//设置输出日志文件大小
	FLAGS_stop_logging_if_full_disk = true;	//磁盘满时是否停止

	LOG(INFO) << "hello " << "world";

	google::ShutdownGoogleLogging();

	return 0;
}

直接进行运行，可以看到磁盘E:/log/下有对应的文件生成

在这里插入图片描述

且文件内容为

Log file created at: 2022/04/06 17:37:49
Running on machine: A120282
Running duration (h:mm:ss): 0:00:00
Log line format: [IWEF]yyyymmdd hh:mm:ss.uuuuuu threadid file:line] msg
I20220406 17:37:49.679339 20356 main.cpp:21] hello world

2.跨线程使用

跨线程使用核心其实就是全局使用，跟踪glog源码，我们可以很清楚的看到再每次输入日志，并刷新到log文件中，其实都会进行加锁，所以使用时不必担心跨线程使用时造成资源竞态。

glog源码节选：

inline void LogDestination::FlushLogFiles(int min_severity) {
  // Prevent any subtle race conditions by wrapping a mutex lock around
  // all this stuff.
  MutexLock l(&log_mutex);
  for (int i = min_severity; i < NUM_SEVERITIES; i++) {
    LogDestination* log = log_destination(i);
    if (log != NULL) {
      log->logger_->Flush();
    }
  }
}

所以我们只要在真正使用之前进行创建就可以了。

这里为了方便，新建一个Logger类
头文件：

#pragma once
#define GLOG_NO_ABBREVIATED_SEVERITIES

#include "glog/logging.h"
#include <string>
#include <iostream>

//方便输出采用宏定义方式

#define LOG_DEBUG DLOG(INFO)
#define LOG_INFO LOG(INFO)
#define LOG_WARNING LOG(WARNING)
#define LOG_ERROR LOG(ERROR)
#define LOG_FATAL LOG(FATAL)

class Logger
{
public:
	static Logger* GetInstance(const std::string &strLogPath, const std::string &strLogName);
	~Logger();

private:
	Logger(const std::string &strLogPath, const std::string &strLogName);
	static Logger* m_pInstance;
};

源文件：

#include "Logger.h"
Logger* Logger::m_pInstance = nullptr;

Logger* Logger::GetInstance(const std::string &strLogPath, const std::string &strLogName)
{
	if (m_pInstance == nullptr)
	{
		m_pInstance = new Logger(strLogPath, strLogName);
		LOG_INFO << "The Logger is new init";
	}
	else
	{
		LOG_INFO << "The logger has init";
	}

	return m_pInstance;
}

Logger::Logger(const std::string &strLogPath, const std::string &strLogName)
{
	std::string strDestiona = strLogPath + strLogName + "_";
	google::InitGoogleLogging(strLogName.c_str());
	google::SetStderrLogging(google::GLOG_FATAL);
	google::SetLogDestination(google::GLOG_INFO, strDestiona.c_str());
	FLAGS_colorlogtostderr = true;
	FLAGS_logbufsecs = 0;
	FLAGS_max_log_size = 50;
	FLAGS_stop_logging_if_full_disk = true;
}

Logger::~Logger()
{
	LOG_INFO << "The logger is over";
	google::ShutdownGoogleLogging();
}

main函数（测试）：

#include "Logger.h"
#include <string>
#include <iostream>
#include <thread>

void Thread1()
{
	int i = 100;
	while (i--)
	{
		LOG_INFO << "this is thread one";
	}
}

void Thread2()
{
	int i = 100;
	while (i--)
	{
		LOG_INFO << "this is thread two";
	}
}

int main()
{
	Logger* pLogger = Logger::GetInstance("E:/Log/", "LogTest");
	std::thread thread1(Thread1);
	std::thread thread2(Thread2);

	thread1.join();
	thread2.join();
	delete pLogger;
	return 0;
}

我们可以看到，多线程输出并没有杂乱的现象

Log file created at: 2022/04/06 18:25:39
Running on machine: A120282
Running duration (h:mm:ss): 0:00:00
Log line format: [IWEF]yyyymmdd hh:mm:ss.uuuuuu threadid file:line] msg
I20220406 18:25:39.786847 6324 logger.cpp:9] The Logger is new init
I20220406 18:25:39.790838 23468 main.cpp:11] this is thread one
I20220406 18:25:39.790838 23468 main.cpp:11] this is thread one
I20220406 18:25:39.790838 23468 main.cpp:11] this is thread one
I20220406 18:25:39.790838 23468 main.cpp:11] this is thread one
I20220406 18:25:39.790838 23468 main.cpp:11] this is thread one
I20220406 18:25:39.790838 23468 main.cpp:11] this is thread one
I20220406 18:25:39.790838 23468 main.cpp:11] this is thread one
I20220406 18:25:39.790838 16488 main.cpp:20] this is thread two
I20220406 18:25:39.790838 23468 main.cpp:11] this is thread one
I20220406 18:25:39.790838 16488 main.cpp:20] this is thread two
I20220406 18:25:39.790838 23468 main.cpp:11] this is thread one
I20220406 18:25:39.790838 16488 main.cpp:20] this is thread two

3.测试疯狂打中文日志日志

测试main.cpp

#include "Logger.h"
#include <string>
#include <iostream>
#include <thread>

void Thread1()
{
	int i = 100;
	while (true)
	{
		LOG_INFO << "你好";
	}
}


int main()
{
	Logger* pLogger = Logger::GetInstance("E:/Log/", "LogTest");
	std::thread thread1(Thread1);

	thread1.join();
	delete pLogger;
	return 0;
}

由输出日志看，每到50M之后，会新建一个日志，同时中文也没有乱码

Log file created at: 2022/04/06 18:34:25
Running on machine: A120282
Running duration (h:mm:ss): 0:00:00
Log line format: [IWEF]yyyymmdd hh:mm:ss.uuuuuu threadid file:line] msg
I20220406 18:34:25.704986 11584 logger.cpp:9] The Logger is new init
I20220406 18:34:25.708976 19268 main.cpp:11] 你好
I20220406 18:34:25.708976 19268 main.cpp:11] 你好
I20220406 18:34:25.708976 19268 main.cpp:11] 你好
I20220406 18:34:25.708976 19268 main.cpp:11] 你好
I20220406 18:34:25.708976 19268 main.cpp:11] 你好

在这里插入图片描述

总结

如果想在工程任意地方使用，只要包含Logger.h头文件即可。

如果感觉对您有点用，请点个赞吧👍！

山河君
关注
  • 2
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
C++ Log4cpp跨平台日志库使用记录(Window与Linux)
cpp_learner的博客
03-20 2903
介绍log4cpp的项目用法，将在项目中常用的用法代码写下来分享！
C++ 宏定义打印日志
shuizhizhiyin的专栏
09-05 561
该类提供了 `addTask` 方法以添加任务队列，并使用条件变量 `cond_` 唤醒空闲线程来执行任务。在宏定义中，使用线程池的 `ThreadPoo::addTask` 方法来将任务加入任务队列中。为了解决这个问题，可以考虑使用线程池来重用线程，减少创建和销毁线程的开销。线程池可以通过预先创建一定数量的线程，并维护一个任务队列来实现。当需要执行任务时，先将任务加入队列，然后由线程池内的线程来执行。使用线程来延迟日志输出的做法可以避免当前线程暂停，但也会带来线程频繁创建与销毁的问题。
2024年【MySQL必知必会】 日志Log详解 数据备份_备份log文件的阈值，华为C C++面试真题解析
最新发布
2401_84976182的博客
05-13 751
innodb_undo_tablespaces | 2 | – 表示回滚日志有自己的独立表空间，而不是在共享表空间ibdata文件中。| innodb_undo_log_truncate | ON | – 表示回滚日志是否自动截断回收，前提是设置了独立表空间。– 这步操作的目的是：产生一个新的二进制日志文件，使这个文件只保存数据备份之后的数据更新事件，这样可以方便我们查看文件的内容。| innodb_log_files_in_group | 2 | – 有 2 个重做日志文件。– 关闭通用查询日志。
Glog使用文档
taosimin87的专栏
11-17 1074
来自Google的Glog是一个应用程序的日志库。它提供基于C++风格的流的日志API，以及各种辅助的宏。打印日志只需以流的形式传给LOG(level)，例如： #include <glog/logging.h> int main(int argc, char* argv[]) { // Initialize Google's logging library. google::InitGoogleLogging(argv[0]); // ... LOG(INFO) &..
C++调式日志log输出至文件方法
EvenNiu的博客
07-28 1785
C++ 记录调试日志信息至文件
GLOG从入门到入门
耳东小白的小笔记本儿
06-19 9275
google日志系统glog库的说明
Log4Qt - Qt跨平台应用框架的日志
01-27
Log4Qt - Qt跨平台应用框架的日志-源码
linux系统中c++写日志文件功能分享
09-04
在Windows环境下，`FileHelper`使用了如`_access`和`_mkdir`等特定于Windows的函数，而在Linux环境下，这些函数被替换为`access`和`mkdir`，确保了跨平台兼容性。这个类的实现使用了标准库中的`<fstream>`，`...
基于Windows C++ 应用程序通用日志组件的使用详解
09-05
第一种是采用如Log4CXX之类的开源日志库，它们具有强大的跨平台功能和高度可配置性。然而，这些组件可能过于复杂，对于只需要基本日志记录功能的Windows C++应用来说，可能会显得多余，而且可能涉及到字符编码问题，...
C/C++格式化日志库实现代码
08-26
该C/C++格式化日志库实现代码提供了一个跨平台的日志函数，适用于Linux和Windows等多种操作系统。该实现代码可以根据不同的日志等级和格式字符串，生成对应的日志信息，并将其输出到指定文件或控制台。
yaolog v1.6(很有特色的C++跨平台日志库)
04-01
易用而又强大的C++跨平台日志库，可以输出日志到控制台窗口，文件，http服务器。特点： # printf风格的接口，包括LOGA__, LOGW__, LOG__, LOGBIN__，LOGBIN_F__ # 日志附加信息包括时间，源代码文件，函数，行号 ...
logging:简单的C ++日志记录库
03-29
测井 简单的C ++日志记录库
C++打印log日志
xy_77777的博客
03-21 865
C++打印log日志
C++ - single header跨平台高效开源日志库Easylogging++的配置和使用
HW140701的博客
10-26 1081
Easylogging++是一个只有单个头文件的开源跨平台日志库，拥有简单易集成，速度极快，线程安全，高效并可配置可扩展等等优点，现在也是我的主力日志库。
基于C++高性能、跨平台日志模块的分析与实现
三哥的技术专栏
12-20 4258
C++高性能、跨平台日志模块的分析与实现
c语言输出log到文件路径,C/C++知识点之打印并输出 log/日志到文件（C++）
weixin_39843093的博客
05-23 2028
本文主要向大家介绍了 C/C++知识点之打印并输出 log/日志到文件(C++)，通过具体的内容向大家展示，希望对大家学习C/C++知识点有所帮助。#include#defineMAX_LEN1024booldebug_mode;//使用方法同printfvoidlprintf(constchar*fmt,...){staticboolprint_time=true;...
一文详解 C++ 日志框架
青春不老，奋斗不止！
10-18 7173
日志框架 - 一个经过专门设计的实用程序，用于规范应用程序的日志记录过程。
自己写的一个基于C++的跨平台的轻量级日志类
great3779的专栏
01-29 8628
写在最前：该日志类的所有源代码可至http://download.csdn.net/detail/great3779/4034521免费下载。 目前C++下比较常用的日志类是log4cpp。这是一个大而全的日志类，提供了很多的功能和扩展。但其缺点是使用起来比较繁杂，而且携带的库也比较大。因此有时我们希望使用一些轻量级的、接口简单易用的日志库。基于此目的，我自己开发了一个轻量级跨平台的日志
c++ vs 输出log到窗口_console.log 花样玩法
weixin_39612849的博客
11-30 1050
基本用法console.log() // 打印日志console.debug() // 打印调试console.error() // 打印错误console.info() // 打印信息console.warn() // 打印警告console.assert() // 打印断言console.clear() // 清空%s 字符串格式化；%d/%i 整数格式化；%f ...
字符串输出成Log文件c++
05-31
要将字符串输出成Log文件，可以使用以下步骤： 1. 打开一个文件流，指定要输出的Log文件路径。 2. 调用文件流的写入方法，将字符串写入文件。 3. 关闭文件流，确保数据被写入文件并保存。 以下是一个示例代码，演示如何输出字符串到Log文件： ```c++ #include <iostream> #include <fstream> #include <ctime> void write_to_log_file(std::string log_string) { // 获取当前时间作为Log的时间戳 std::time_t current_time = std::time(nullptr); std::tm* local_time = std::localtime(&current_time); char timestamp[20]; std::strftime(timestamp, sizeof(timestamp), "%Y-%m-%d %H:%M:%S", local_time); // 打开文件流，指定要输出的Log文件路径 std::ofstream log_file("log.txt", std::ios::app); // 写入时间戳和Log内容 log_file << timestamp << ": " << log_string << std::endl; // 关闭文件流 log_file.close(); } // 测试代码 int main() { write_to_log_file("这是一条Log信息"); return 0; } ``` 注意，以上代码中的 `log.txt` 文件需要事先存在，否则会报文件不存在的错误。如果需要在程序中自动创建Log文件，可以在代码中添加相关逻辑。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值