C++Logger日志库的实现

最新推荐文章于 2024-04-07 13:06:26 发布
最新推荐文章于 2024-04-07 13:06:26 发布
阅读量3.5k 收藏 40
点赞数 7
分类专栏： 现代C++ # C++项目 文章标签： c++ 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Thinking777/article/details/128734269
版权

文章目录

一、日志库的特点

该项目是基于C++实现的简单日志库系统，代码方面大约200多行，比较简单，封装的接口很容易看懂，使用起来也十分方便，通过定义的宏来实现打印输出到日志文件中。

二、日志库的需求

  • 日志库的存储：文本文件。
  • 日志存储的内容：时间、日志级别、文件名、行号、日志内容。
  • 日志级别：debug<info<warn<erro<fatal。
  • 日志翻滚：通过设置日志文件最大可以存储内容的字节，若文件存储超过当前最大字节数，则重新创建一个新的日志文件用来存储日志内容。

三、日志库的实现

该日志库使用了单例模式来创建日志库对象，从而调用接口，如下是单例模式的代码：

//创建Logger对象
Logger *Logger::getInstance()
{
    if(m_instance==nullptr)
    {
        std::mutex mtx;
        mtx.lock();
        m_instance=new Logger();
        mtx.unlock();
    }
    return m_instance;
}

日志打印的接口是该日志库的重要部分，如下是日志打印的代码：

/**
 * @brief:打印日志
 * @param:参数一:日志级别，参数二：打印日志的的文件名，参数三：打印日志所在的行号，参数四:打印格式,参数5:C++中的不定参数
*/
void Logger::log(Level level,const char *fileName,int line,const char *format,...)
{
    //过滤低级别日志
    if(levels>level)
    {
        return;
    }
    if (m_fout.fail())
    {
        throw std::logic_error("open file failed "+m_fileName);
    }
    //获取当前时间戳
    auto timeTicks=time(nullptr);
    //将当前时间戳转化为时间结构体
    auto ptns=localtime(&timeTicks);
    //存储格式化后的时间
    char timeArray[32];
    //初始化字符数组
    memset(timeArray,0,sizeof(timeArray));
    //格式化时间结构体
    strftime(timeArray,sizeof(timeArray),"[%Y-%m-%d %H:%M:%S]",ptns);

    //日志格式化的结果(日期 日志级别 日志打印位置:日志打印的行号位置)
    const char *fmt="%s %s %s:%d ";
    //获取格式化后的字符串长度
    int size=snprintf(nullptr,0,fmt,timeArray,m_Level[level],fileName,line);
    if(size>0)
    {
        char *buffer=new char[size+1];
        memset(buffer,0,size+1);
        snprintf(buffer,size+1,fmt,timeArray,m_Level[level],fileName,line);
        std::cout<<buffer<<std::endl;
        //将字符串写入日志中
        m_fout<<buffer;
        m_len+=size;
        delete []buffer;
    }

    //获取写入日志内容
    va_list arg_ptr;
    va_start(arg_ptr,format);
    size=vsnprintf(nullptr,0,format,arg_ptr);
    va_end(arg_ptr);
    if(size>0)
    {
        char *content=new char[size+1];
        va_start(arg_ptr,format);
        vsnprintf(content,size+1,format,arg_ptr);
        va_end(arg_ptr);
        std::cout<<content<<std::endl;
        m_fout<<content;
        m_len+=size;
        delete []content;
    }
    m_fout<<"\n";
    //刷新文件内容
    m_fout.flush();

    if(m_len>=m_max && m_max>0)
    {
        rotate();
    }

    //std::cout<<timeArray<<std::endl;
}

首先是通过C语言中的time()获取当前时间戳，然后再将其存放到时间结构体中，然后创建一个字符数组存放当前时间，最后将当前时间格式化存放到时间字符串的数组中。日志打印方面是通过snprintf和vsnprintf实现的，具体可看代码。

snprintf和vsprintf的区别是：snprintf发送格式化输出到指定数组。格式化用法与 printf一致，相当于把 printf输出的内容放入指定数组中。而vsnprintf使用不确定参数的方式封装，可直接输入数组和未知的参数。从而精简 sprintf需要先创建数组再传入参数的操作。

最后是实现宏打印的方式来写日志，因为直接调用log()方法很麻烦，如下是两者的对比：

//Log打印
Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,"hello Sakura");
//宏打印
debug("hello Sakura");

由此可看出宏打印的效率高，如下是宏打印的实现：

//定义debug打印，参数一是打印格式，参数二是不定参数
#define debug(format,...) \
    Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,format,##__VA_ARGS__);
//定义info打印，参数一是打印格式，参数二是不定参数
#define info(format,...) \
    Logger::getInstance()->log(Logger::INFO,__FILE__,__LINE__,format,##__VA_ARGS__);
//定义warn打印，参数一是打印格式，参数二是不定参数
#define warn(format,...) \
    Logger::getInstance()->log(Logger::WARN,__FILE__,__LINE__,format,##__VA_ARGS__);
//定义erro打印，参数一是打印格式，参数二是不定参数
#define erro(format,...) \
    Logger::getInstance()->log(Logger::ERRO,__FILE__,__LINE__,format,##__VA_ARGS__);
//定义fatal打印，参数一是打印格式，参数二是不定参数
#define fatal(format,...) \
    Logger::getInstance()->log(Logger::FATAL,__FILE__,__LINE__,format,##__VA_ARGS__);

通过上面的代码可知，宏打印首先是通过定义一个宏的名称来实现，里面的参数是打印格式和不定参数，类似于C语言的printf和C++20的std::format格式化打印。然后是通过调用log()方法，向log()方法传入参数。
//__FILE__是指正在编译文件的文件名，__LINE__指正在编译文件的行号。
//fomat是指打印的格式，##__VA_ARGS__是指不定参数。

四、日志库的完整代码

Logger.h如下：

#ifndef LOGGER_H
#define LOGGER_H

#include<string>
#include<fstream>

namespace Sakura
{
namespace Logger{

#define debug(format,...) \
    Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,format,##__VA_ARGS__);

#define info(format,...) \
    Logger::getInstance()->log(Logger::INFO,__FILE__,__LINE__,format,##__VA_ARGS__);

#define warn(format,...) \
    Logger::getInstance()->log(Logger::WARN,__FILE__,__LINE__,format,##__VA_ARGS__);

#define erro(format,...) \
    Logger::getInstance()->log(Logger::ERRO,__FILE__,__LINE__,format,##__VA_ARGS__);

#define fatal(format,...) \
    Logger::getInstance()->log(Logger::FATAL,__FILE__,__LINE__,format,##__VA_ARGS__);


class Logger{

public:
    //日志级别
    enum Level
    {
        DEBUG=0,
        INFO,
        WARN,
        ERRO,
        FATAL,
        LEVEL_COUNT  //记录日志级别个数  
    };

    //打开并创建日志文件
    void open(const std::string &fileName);
    //关闭文件
    void close();
    //创建Logger对象
    static Logger *getInstance();
    //打印日志
    void log(Level level,const char *fileName,int line,const char *format,...);
    //设置日志级别
    void setLevel(Level level)
    {
        levels=level;
    }
    //设置日志文件最大字节长度
    void setMax(int bytes)
    {
        m_max=bytes;
    }
    //日志翻滚
    void rotate();

private:
    Logger();
    ~Logger();

private:
    //保存日志文件所在位置
    std::string m_fileName;
    //文件输出流对象
    std::fstream m_fout;
    //存放日志级别
    static const char *m_Level[LEVEL_COUNT];
    //单例对象
    static Logger*m_instance;
    //当前日志级别(用于过滤低级别日志内容)
    Level levels;
    //日志文件存放的最大字节数长度
    int m_max;
    //日志文件当前字节数长度
    int m_len;
};
}
}
#endif //LOGGER_H

Logger.cpp如下：

#include"Logger.h"
#include<stdexcept>
#include<iostream>
#include<stdarg.h>
#include<string.h>
#include<time.h>
#include<mutex>
using namespace Sakura::Logger;

Logger * Logger::m_instance=nullptr;
const char * Logger::m_Level[LEVEL_COUNT]={
    "DEBUG",
    "INFO",
    "WARN",
    "ERRO",
    "FATAL"
};

Logger::Logger() : m_len(0),m_max(0),levels(DEBUG)
{

}

Logger::~Logger()
{
    close();
}

//打开并创建日志文件
void Logger::open(const std::string &fileName)
{
    m_fileName=fileName;
    m_fout.open(fileName,std::ios::app);
    if(m_fout.fail())
    {
        throw std::logic_error("open file failed "+fileName);
    }
    //从日志文件开始读到最后
    m_fout.seekp(0,std::ios::end);
    //读取到当前文件内容所在位置
    m_len=m_fout.tellp();
}
//关闭文件
void Logger::close()
{
    m_fout.close();
}
//创建Logger对象
Logger *Logger::getInstance()
{
    if(m_instance==nullptr)
    {
        std::mutex mtx;
        mtx.lock();
        m_instance=new Logger();
        mtx.unlock();
    }
    return m_instance;
}

/**
 * @brief:打印日志
 * @param:参数一:日志级别，参数二：打印日志的的文件名，参数三：打印日志所在的行号，参数四:打印格式,参数5:C++中的不定参数
*/
void Logger::log(Level level,const char *fileName,int line,const char *format,...)
{
    //过滤低级别日志
    if(levels>level)
    {
        return;
    }
    if (m_fout.fail())
    {
        throw std::logic_error("open file failed "+m_fileName);
    }
    //获取当前时间戳
    auto timeTicks=time(nullptr);
    //将当前时间戳转化为时间结构体
    auto ptns=localtime(&timeTicks);
    //存储格式化后的时间
    char timeArray[32];
    //初始化字符数组
    memset(timeArray,0,sizeof(timeArray));
    //格式化时间结构体
    strftime(timeArray,sizeof(timeArray),"[%Y-%m-%d %H:%M:%S]",ptns);

    //日志格式化的结果(日期 日志级别 日志打印位置:日志打印的行号位置)
    const char *fmt="%s %s %s:%d ";
    //获取格式化后的字符串长度
    int size=snprintf(nullptr,0,fmt,timeArray,m_Level[level],fileName,line);
    if(size>0)
    {
        char *buffer=new char[size+1];
        memset(buffer,0,size+1);
        snprintf(buffer,size+1,fmt,timeArray,m_Level[level],fileName,line);
        std::cout<<buffer<<std::endl;
        //将字符串写入日志中
        m_fout<<buffer;
        m_len+=size;
        delete []buffer;
    }

    //获取写入日志内容
    va_list arg_ptr;
    va_start(arg_ptr,format);
    size=vsnprintf(nullptr,0,format,arg_ptr);
    va_end(arg_ptr);
    if(size>0)
    {
        char *content=new char[size+1];
        va_start(arg_ptr,format);
        vsnprintf(content,size+1,format,arg_ptr);
        va_end(arg_ptr);
        std::cout<<content<<std::endl;
        m_fout<<content;
        m_len+=size;
        delete []content;
    }
    m_fout<<"\n";
    //刷新文件内容
    m_fout.flush();

    if(m_len>=m_max && m_max>0)
    {
        rotate();
    }

    //std::cout<<timeArray<<std::endl;
}

//日志翻滚
void Logger::rotate()
{
    close();
    //获取当前时间戳
    auto timeTicks=time(nullptr);
    //将当前时间戳转化为时间结构体
    auto ptns=localtime(&timeTicks);
    //存储格式化后的时间
    char timeArray[32];
    //初始化字符数组
    memset(timeArray,0,sizeof(timeArray));
    //格式化时间结构体
    strftime(timeArray,sizeof(timeArray),".%Y-%m-%d_%H-%M-%S",ptns);
    std::string fileName=m_fileName+timeArray;
    if(rename(m_fileName.c_str(),fileName.c_str())!=0)
    {
        return;
    }
    open(m_fileName);
}

main.cpp如下：

#include<iostream>
#include"Logger/Logger.h"
#include"Logger/Logger.cpp"
using namespace Sakura::Logger;

int main()
{
    //std::cout<<"hello Sakura"<<std::endl;
    Logger::getInstance()->open("./test.log");
    Logger::getInstance()->setMax(1024);
    //Logger::getInstance()->setLevel(Logger::INFO);
    //Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,"hello Sakura");
    //Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,"name is %s,age is %d","旋涡鸣人",18);

    debug("hello Sakura");
    debug("name is %s,age is %d","旋涡鸣人",18);
    info("info message");
    warn("warn message");
    erro("erro message");
    fatal("fatal message");

    return 0;
}

测试的结果:
在这里插入图片描述
日志文件内容：
在这里插入图片描述

神威难藏泪~
关注
  • 7
    点赞
  • 踩
  • 40
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
专栏目录
c++日志库(windows、linux)
08-04
自己写的一个小小的日志库，功能比较简单，单一。主要用到__FILE_、__FUNCTION__、__FILE__等宏定义。日志主要记录文件、行数、函数名、日志信息。日志的格式最终保存为json格式，方便查看。
超级好用的C++实用库之日志类
最新发布
hope_wisdom的技术博客
05-14 1225
日志类主要用于在程序运行过程中记录信息、错误、警告以及其他需要跟踪的数据，这对于调试、监控应用状态及后期问题分析至关重要。一个高效且灵活的日志类应该满足以下几个核心需求。日志级别管理：可定义多个日志级别，比如：DEBUG、INFO、WARN、ERROR、FATAL等，以便根据情况筛选日志的详细程度。同时，还允许运行时动态调整日志输出级别，便于在生产环境中减少不需要的日志输出，或增加更详细的日志输出。多线程安全：在多线程的环境下，可确保日志写入操作是线程安全的，避免日志内容混乱或程序崩溃。
C++实现日志库
05-11
C++自己实现日志库，包括XML文件解析，日志信息分级，多种方式存储
C++ 实现简易 log 日志库
热门推荐
Dablelv 的博客专栏。
07-16 2万+
DEBUG（调试）：DEBUG级别的日志用于记录应用程序的调试信息，例如变量的值、函数的执行路径等。TRACE（跟踪）：这是最详细的日志级别，通常用于记录应用程序中最细微的操作和事件，以帮助调试和追踪问题。FATAL（致命）： FATAL级别的日志用于记录严重的错误，通常表示应用程序遇到了无法继续运行的情况，可能会导致应用程序崩溃。WARN（警告）：WARNING级别的日志用于记录警告信息，例如潜在的问题或不正常的情况，但不会导致应用程序终止。由此可见log日志在系统中的重要地位和存在的必要性。
c++日志库
luck_anan的博客
05-22 2625
c++/Qt日志库实现 可通过UDP远程查看和远程干预 前言 因为我有很多服务是跑在后台的，每次查看日志都很麻烦需要ssl 到服务后台去查看，如果日志每次UDP通过打过来，同时也可以远程控制它的输出模式，那该多好啊。 日志库需求 1.最基本的控制台、文件和UDP输出，因为是qt程序用，所以要兼容qDebug输出 2.使用方便，简单，易用。 3.如果同时支持配置文件或者直接调用日志文件接口...
C++高效日志类（库）
07-03
前段时间在做毕业设计需要有一个功能模块是写日志，为了配合高性能服务器不拖延服务器的效率所以必须要写出一个十分高效确不太占用系统资源的日志类。 经过参考前辈们写的资料加上自己不断地研究改进，现在完成了一个C++高效日志的类。经过我本人的测试发现该类库可以在WINDOWS平台、多线程环境下出色完成写日志的任务，可以达到50M/S的日志输出量。同时做了日志切割，当日志文件大小达到设定值时自动切入下一个文件，并用日期加序列号命名。 其中用到了BOOST多线程的锁，没有安装BOOST的机器可以屏蔽BOOST的相关代码，但是在多线程执行时会出错。
C++通用日志系统Logger
03-25
本日志模块的主旨是提供一个基于Qt框架，简单易用、可拓展性好、支持多种输出目标和格式的底层日志库，方便上层调用。模块设计过程中参考了Log4j等软件，并结合C++特性，具有高度可拓展、使用灵活、高性能等优点。
c++开源日志库
12-05
本篇将详细探讨“c++经典好使精简易懂易用开源日志库”的相关知识点。 首先，我们关注的是“Logger.cpp”和“Logger.h”这两个文件。在C++中，通常`.cpp`文件用于存放函数实现，而`.h`文件则包含类定义和函数声明。...
一个c++的跨平台日志库
05-08
5. **可扩展性**：为了适应不同的需求，日志库应允许用户自定义处理器或过滤器，实现特定的日志处理逻辑，比如日志压缩、归档或者发送邮件报警等。 在提供的`log_test`文件中，我们可以预期它包含了一些示例代码或...
C++轻量级日志类Logger的使用
11-10
Logger是轻量级日志类，提供写日志功能，支持多线程，支持可变形参数操作，支持写日志级别的设置。 博客地址： http://blog.csdn.net/sunflover454/article/details/49758801
Logger:一个用于处理日志消息的Arduino库
05-16
- **Logger.cpp**: 实现库功能的源代码文件。 - **examples**: 示例代码目录，展示如何在项目中使用Logger库。 - **README.md**: 文档文件，详细介绍了库的安装、使用和配置方法。 - **LICENSE**: 许可证文件，规定...
C/C++log日志库
嵌入式技术
06-18 1144
C/C++log日志库比较 超轻量级、高性能 C/C++ 日志库 EasyLogger C语言日志库zlog总结
C++plog库，轻量级日志框架（日志库）
Dontla的博客
02-28 5048
在使用自动捕获’this’指针技术时，当用户使用日志记录器记录一条消息时，plog库会自动捕获当前对象的指针，并将其添加到日志消息中，以便用户在查看日志时能够识别与对象相关的消息，并更好地理解程序的行为和状态。在使用延迟流评估技术时，当用户使用日志记录器记录一条消息时，不会立即将消息转换为字符串格式，而是将消息的内容保存到一个缓存区中，直到真正需要输出消息时，才将缓存区中的内容格式化为字符串，然后输出到目标位置。这个头文件定义了一个滚动文件输出的日志附加器，可以将日志写入到滚动的日志文件中。
C++中好用的Logger库
小诺的博客
08-08 3422
这是我在联想时，我直属领导告知我的，可以说是越用越好用。 原文github：https://github.com/bmoscon/Logger 如果原文失效，也可以在我的github中下载，其中一部分（logger.h以及Logger文件夹）：https://github.com/xiaonuo911teamo/BaseException。我有改过h文件，本文后面会提到。 优点 使用很简单，共有3个文件（为什么是3个后面说），包含一个头文件，然后给定一个全局变量即可。 支持多级输出，DEBUG、INF.
C++日志库
qq_35653349的博客
10-09 121
Google glog 使用 google glog 简单使用小结 google-glog 学习 C++日志操作开源函数库之Google-glog 无法解析的外部符号 "__declspec(dllimport) void __cdecl google::InstallFailureSignalHandle unresolved external symbol错误及其解决方法 windows下使用log4cplus教程 C++：日志库log4cplus 2.0的使用说明 log4cplus下载 c++日志库
【C++风云录】优秀的C++日志库：让日志记录与调试变得轻松
记录我的学习历程
04-07 3814
本文介绍了几个常用的C++日志库，分别是spdlog、Boost.Log、Log4cpp、Easylogging++、Poco Logging和Google Logging Library (glog)。对于每个库，我们提供了它们的概述、主要特点和使用示例。这些库都具有各自独特的特点和优势，例如多线程支持、灵活的配置选项和高性能等。通过学习和了解这些库，开发者可以根据项目需求选择合适的日志库来进行日志记录和调试操作，提高项目开发效率和代码质量。
C++简易日志库
小哥
07-08 908
学习C++已经很久了，一直不知道该用来做些什么。前几天看到了sylar的C++高性能服务器的视频，自己也就用C++写了一个简易的日志库。 功能要求 Log功能框图可输出基本的日志信息可修改日志输出方式可以多种方式同时输出日志信息可设置日志输出的格式 Log分类日志类型异常日志业务日志性能日志日志级别错误日志警告日志通知日志调试日志跟踪日志日志格式可设置日志输出方式控制台日志文件其他设备 实现 运行环境：Ubuntu20 系统一共实现了三个类——FORMAT、APPENDER、LOG FORMAT：主要负责日
c++ logger 简单
10-28
logger 是一种用于记录程序运行状态和输出信息的工具。它可以帮助开发者在程序运行过程中输出各种日志，以便于调试和追踪问题。 使用 logger 的好处有很多。首先，它可以将程序输出信息分类和记录，比如错误日志、警告日志、调试日志等，可以根据需要选择不同的日志级别进行输出。这样在程序出现问题时，我们可以根据日志的级别和内容来定位问题的所在，更快速地进行故障排查。 其次，logger 可以将日志输出到不同的地方，比如控制台、文件、数据库等。这样我们可以根据实际需求来选择合适的输出方式，方便我们查看和分析日志信息。 此外，logger 还支持日志的格式化，可以根据需要定义日志的输出格式，包括时间戳、线程信息、日志级别等。这样可以使日志信息更加规范和易于阅读。 最后，logger 还支持日志的过滤和配置，可以根据不同的需求对日志进行过滤和处理。比如可以设置只输出特定级别以上的日志，或者将特定类型的日志保存到单独的文件中。 总的来说，logger 是一个简单且实用的工具，可以帮助我们记录程序运行过程中的各种信息，并方便地进行查看和分析。通过合理使用 logger，我们可以更快速地定位和解决问题，提升程序的稳定性和可靠性。
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值