c++怎么实现一个简单的日志系统_c++文件输出日志【实战】

1次阅读

安全日志写入需全局单例std::ofstream以app模式打开,用mutex保护线程写入,预拼接日志字符串,嵌入裁剪后的__file__和__line__,并实现带锁的文件大小轮转。

c++怎么实现一个简单的日志系统_c++文件输出日志【实战】

怎么用 std::ofstream 安全地写日志到文件

直接用 std::ofstream 每次打开文件追加写,看似简单,但容易在多线程或频繁调用时出问题:文件句柄没关、写入中断导致日志丢失、并发写乱序。安全做法是全局只持有一个 std::ofstream 实例,并用 std::ios::app 模式打开,且每次写完不手动 close()(避免重复打开开销)。

关键点:

  • 初始化时用 std::ofstream m_file{"app.log", std::ios::out | std::ios::app},确保追加且不截断
  • 写入前检查 m_file.is_open()m_file.good(),失败时记录到 stderr 或跳过(别 crash)
  • 每条日志末尾必须带 n,否则缓冲区可能不刷新;若需实时可见,可调用 m_file.flush(),但注意性能损耗
  • 不要在析构里 close——程序退出时 OS 会回收,强行 close 可能和静态对象析构顺序冲突

如何避免多线程下日志错乱

多个线程同时调用 operator 写同一个 <code>std::ofstream,会导致输出碎片化(比如 “INFO[10:23]” 和 “User login” 被拆成两行中间插进别的日志)。最轻量解法是加一层 std::mutex 保护写操作。

实操建议:

立即学习C++免费学习笔记(深入)”;

  • 定义一个全局 std::mutex g_log_mutex,所有日志写入前先 g_log_mutex.lock()(或用 std::lock_guard 自动管理)
  • 避免在锁内做耗时操作(如格式化时间字符串),先在锁外拼好完整日志字符串,再进锁写入
  • 不用 std::Stringstream 在锁内反复构造——提前分配好 std::string 缓冲,用 std::to_string + 字符串拼接更可控
  • 如果对性能极度敏感,可考虑无锁环形缓冲 + 单独日志线程消费,但小项目没必要

__FILE____LINE__ 怎么嵌入日志内容

编译器内置宏 __FILE__const char*,__LINE__int,直接塞进日志流会输出地址或数字,但你想看到的是 “main.cpp:42” 这种可读路径。需要预处理拼接,且注意 __FILE__ 返回的是绝对路径,通常要裁剪。

推荐做法:

  • 写个辅助函数 const char* basename(const char* path),从最后一个 / 后截取文件名
  • 用宏封装日志调用,例如:
    #define LOG_INFO(msg) do {      auto now = std::chrono::system_clock::now();      auto time_t = std::chrono::system_clock::to_time_t(now);      std::string tstr = std::put_time(std::localtime(&time_t), "%H:%M:%S");      std::string full_msg = "[" + tstr + "] INFO [" + basename(__FILE__) + ":" + std::to_string(__LINE__) + "] " + msg;      log_write(full_msg.c_str());  } while(0)
  • 宏里不要用 std::endl(会 flush),统一用 "n" 结尾
  • 避免宏里调用复杂函数(如 std::put_time)——它可能抛异常,而宏上下文难捕获

日志文件太大了怎么自动轮转

不处理的话日志会无限增长。简易轮转不需要第三方库,核心逻辑是:每次写入前检查当前文件大小,超阈值就关闭当前文件,重命名为 app.log.1,已有 .1 的先挪成 .2,最多保留 N 份。

注意点:

  • 轮转必须在加锁后执行(防止两个线程同时触发 rename)
  • std::Filesystem::file_size()c++17)获取大小,比 fstat 更跨平台
  • rename 前先 m_file.close(),再 rename,最后用原名重新 open(仍用 app 模式)
  • 删除旧日志用 std::filesystem::remove(),别用 system("rm") —— 不安全且不可移植
  • 轮转失败(如磁盘满)不能让日志功能瘫痪,应降级为继续写原文件并报错到 stderr

实际最难的不是写进去,是保证「写进去的内容一定落盘、顺序不错、崩溃不丢、查的时候不翻十份文件」——这些细节都在上面几条里埋着了。

text=ZqhQzanResources