muduo网络库剖析——日志Log类

已于 2024-01-09 10:23:26 修改
阅读量1.0k 收藏 20
点赞数 22
分类专栏： muduo网络库精解，重构与拓展 文章标签： 网络 c++ 开源 服务器 linux 后端 个人开发
于 2024-01-05 01:13:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_62021811/article/details/135329778
版权
本文详细介绍了muduo网络库中的Log类，涉及日志级别、单例模式的应用以及如何通过预处理器宏实现统一的日志格式。作者分享了项目实践中的经验和心得，鼓励读者养成写博客的习惯以提升技术水平。
摘要由CSDN通过智能技术生成

muduo网络库剖析——日志Log类

前情

从muduo到my_muduo

作为一个宏大的、功能健全的muduo库，考虑的肯定是众多情况是否可以高效满足；而作为学习者，我们需要抽取其中的精华进行简要实现，这要求我们足够了解muduo库。

做项目 = 模仿 + 修改，不要担心自己学了也不会写怎么办，重要的是积累，学到了这些方法，如果下次在遇到通用需求的时候你能够回想起之前的解决方法就够了。送上一段话！

在这里插入图片描述

概要

日志

日志是用来记录重大事件的工具。
日志文件是重要的系统信息文件，其中记录了很多重要的系统事件。包括用户的登录信息，系统的启动信息，系统的安全信息，邮件相关信息，各种服务相关信息。
日志对于安全来说也很重要，它记录了每天系统发生的各种事情，通过日志来检查错误发生的原因，或者受到攻击时攻击者留下的痕迹。

日志级别

在这里插入图片描述
上面是muduo库的主要日志级别。
在这里插入图片描述
上面是我搜索到的日志级别解释。

框架与细节

成员

  1. 日志级别划分

    我们这里主要用到INFO、DEBUG、WARN、ERROR、FATAL作为我们小规模的日志库日志级别划分。

函数

  1. 日志级别设置

    在这里插入图片描述

    static修饰类成员函数则该成员函数属于整个类，而非类对象，调用需要加类域，初始化要在类外。

  2. 日志实例创建——单例模式

    我们通过返回静态变量能够获得唯一的日志实例，使用的是懒汉式单例模式。有关单例模式，想要了解复习的uu可以跳转到此。

  3. 写日志

    • 关于写日志，我们需要确定统一的写的格式，muduo库选择使用宏定义的方式来统一我们写单条日志的格式。
      在这里插入图片描述 这里使用到了是将宏定义做成流对象进行传输，类似于c++中的cout。我们同样可以使用类似于printf的格式类型来实现我们的日志输出格式化。比如：

       #define LOG_INFO(logmsgformat, ...)                             \
     do {                                                        \
         Log& lp = Log::getInstance();                           \
         lp.setLogLevel(INFO);                                   \
         char buf[64] = {0};                                     \
         snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
         lp.writeLog(buf);                                       \
     } while (0)
 
 #define LOG_DEBUG(logmsgformat, ...)                            \
     do {                                                        \
         Log& lp = Log::getInstance();                           \
         lp.setLogLevel(DEBUG);                                  \
         char buf[64] = {0};                                     \
         snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
         lp.writeLog(buf);                                       \
     } while (0)
 
 #define LOG_WARN(logmsgformat, ...)                             \
     do {                                                        \
         Log& lp = Log::getInstance();                           \
         lp.setLogLevel(WARN);                                   \
         char buf[64] = {0};                                     \
         snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
         lp.writeLog(buf);                                       \
     } while (0)
 
 #define LOG_ERROR(logmsgformat, ...)                            \
     do {                                                        \
         Log& lp = Log::getInstance();                           \
         lp.setLogLevel(ERROR);                                  \
         char buf[64] = {0};                                     \
         snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
         lp.writeLog(buf);                                       \
     } while (0)
 
 #define LOG_FATAL(logmsgformat, ...)                            \
     do {                                                        \
         Log& lp = Log::getInstance();                           \
         lp.setLogLevel(FATAL);                                  \
         char buf[64] = {0};                                     \
         snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
         lp.writeLog(buf);                                       \
         exit(-1);                                               \
     } while (0)

    • VA_ARGS 是一个预处理宏，用于可变参数宏中。当你在一个宏定义中使用可变参数时，VA_ARGS 允许你捕获那些参数。它常用于宏定义的可变参数列表。

    • Log& lp = Log::getInstance();注意这行细节，我们使用引用可以避免赋值运算符。另外，我们也可以修改getInstance返回值，返回一个指针，这样也是可以实现功能的。

    • 因为FATAL定义为出现不可逆转的错误，所以采用程序结束的方式，exit(-1);

    • 对于writeLog函数的实现，我进行了规范的定义，[] : time, msg。输出结果应该如下：在这里插入图片描述
      后面将对时间功能进行重写。

    • 关于日志msg的格式输出，应该统一标准，至少需要达到这样的标准，才可以更好地在后期进行调试。
      在这里插入图片描述
      在此还要注意，buf的长度要大于我们输出的长度！！！

    源码

//Log.h
#pragma once 

#include <string>
#include <iostream>
#include <unistd.h>

#include "noncopyable.h"

enum LogLevel {
    INFO,
    ERROR,
    WARN,
    FATAL,
    DEBUG,
};

#define LOG_INFO(logmsgformat, ...)                             \
    do {                                                        \
        Log& lp = Log::getInstance();                           \
        lp.setLogLevel(INFO);                                   \
        char buf[128] = {0};                                     \
        snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
        lp.writeLog(buf);                                       \
    } while (0)

#define LOG_DEBUG(logmsgformat, ...)                            \
    do {                                                        \
        Log& lp = Log::getInstance();                           \
        lp.setLogLevel(DEBUG);                                  \
        char buf[128] = {0};                                     \
        snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
        lp.writeLog(buf);                                       \
    } while (0)

#define LOG_WARN(logmsgformat, ...)                             \
    do {                                                        \
        Log& lp = Log::getInstance();                           \
        lp.setLogLevel(WARN);                                   \
        char buf[128] = {0};                                     \
        snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
        lp.writeLog(buf);                                       \
    } while (0)

#define LOG_ERROR(logmsgformat, ...)                            \
    do {                                                        \
        Log& lp = Log::getInstance();                           \
        lp.setLogLevel(ERROR);                                  \
        char buf[128] = {0};                                     \
        snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
        lp.writeLog(buf);                                       \
    } while (0)

#define LOG_FATAL(logmsgformat, ...)                            \
    do {                                                        \
        Log& lp = Log::getInstance();                           \
        lp.setLogLevel(FATAL);                                  \
        char buf[128] = {0};                                     \
        snprintf(buf, sizeof buf, logmsgformat, ##__VA_ARGS__); \
        lp.writeLog(buf);                                       \
        exit(-1);                                               \
    } while (0)

class Log : noncopyable {
public:
    
    static Log& getInstance(); 
    void writeLog(const char* s);
    void setLogLevel(LogLevel logLevel) {
        logLevel_ = logLevel;
    }
private:
    //Log() {};
    LogLevel logLevel_;
    
};

//Log.cc
#include "Log.h"

Log& Log::getInstance() {
    static Log log;
    return log;
}


// [] : time, msg
void Log::writeLog(const char* s) {
    std::string ss;
    switch (logLevel_)
    {
    case INFO:
        ss += "[INFO] : ";
        break;
    case DEBUG:
        ss += "[DEBUG] : ";
        break;
    case ERROR:
        ss += "[ERROR] : ";
        break;
    case FATAL:
        ss += "[FATAL] : ";
        break;
    case WARN:
        ss += "[WARN] : ";
        break;
    default:
        break;
    }
    std::cout << ss << "time, " << s << std::endl;
}

结尾

以上就是日志Log类的相关介绍，以及我在进行项目重写的时候遇到的一些问题，和我自己的一些心得体会。发现写博客真的会记录好多你的成长，而且对于一个好的项目，写博客也是证明你确实有过深度思考，并且在之后面试或者工作时遇到同样的问题能够进行复盘的一种有效的手段。所以，希望uu们也可以像我一样，养成写博客的习惯，逐渐脱离菜鸡队列，向大佬前进！！！加油！！！

也希望我能够完成muduo网络库项目的深度学习与重写，并在功能上能够拓展。也希望在完成这个博客系列之后，能够引导想要学习muduo网络库源码的人，更好地探索这篇美丽繁华的土壤。致敬chenshuo大神！！！

鉴于博主只是一名平平无奇的大三学生，没什么项目经验，所以可能很多东西有所疏漏，如果有大神发现了，还劳烦您在评论区留言，我会努力尝试解决问题！

Apylee 后继
关注
专栏目录
muduo日志库原理以及源码分析
m0_70418130的博客
10-11 656
muduo的这些特点使得其作为高性能日志库被广泛使用。
Muduo日志库
要回杭州的李同学
11-13 2565
本文是笔者通过学习Muduo多线程网络程序开发库日志模块所做出的总结，文中大量引用了陈硕所著的《Linux多线程服务端编程：使用muduo C++网络库》以及luotuo44《muduo日志库学习》博客中的内容。此外，本文代码取自analogous_love的开源项目flamingo，笔者在此一并表示感谢。 由于笔者接触多线程开发时间较短，文中所书难免有误，还请多多包涵~ 日志是服务器端...
详解Muduo库
最新发布
m0_71124168的博客
07-01 1426
Muduo网络库：底层实质上为Linux的epoll + pthread线程池，且依赖boost库。muduo的网络设计核心为一个线程一个事件循环，有一个main Reactor负载accept连接，然后把连接分发到某个sub Reactor(采用轮询的方式来选择sub Reactor)，该连接的所用操作都在那个sub Reactor所处的线程中完成。多个连接可能被分派到多个线程中，以充分利用CPU，Reactor poll的大小是固定的，根据CPU的数目确定。
【Muduo源码剖析笔记】 基础组件之日志库
LeeEdgar的博客
06-07 254
Muduo库源码阅读笔记
muduo网络库学习笔记之日志系统
升级打怪记录
08-10 217
muduo日志系统采用的是多生产者单消费者模型，基本思路是，前端线程（产生日志消息的线程）和后端线程（负责将缓冲区中的日志信息写入磁盘文件的线程）各自维护一块buffer，前端线程维护bufferA，后端线程维护bufferB。
muduo网络库——日志
0 error(s)
08-02 438
日志 在网络设备、系统及服务程序等运作时都会产生一个叫log的事件记录；每一行日志都记载着相关信息。muduo网络库也不例外。 日志级别 日志一般有5个正常级别： WARN 警告信息表明潜在错误。 INFO打印重要流程信息 ERROR错误，不影响软件正常进行 FATAL影响程序执行 DEBUG 调试信息 另外，还有两个可用的特别的日志记录级别： ALL 是最低等级的，用于打开所有的日志记录 OFF 是最高等级的，用于关闭所有日志记录 在本项目中，仅用INFO、ERROR、FATAL、DEBUG四个
muduo库——LOG日志的文件缓冲区的探索
weixin_43999747的博客
10-12 499
阅读muduo 日志系统产生的一些疑问。
muduo net库学习笔记2——muduo网络库相关类图的关系、EventLoop、Channel、 Poller
qq_37299596的博客
07-18 630
Acceptor接收到客户端请求，调用TcpServer回调函数 TcpServer回调函数中创建TcpConnection对象，代表着一个Tcp连接 TcpConnection构造函数中创建Channel对象，保存客户端套接字fd和关心的事件（可读） Channel 注册自己到所属事件驱动循环（EventLoop）中的Poller上 Poller开始监听，当发现Channel被激活后将其添加到EventLoop的激活队列中 EventLoop在poll返回后处理激活队列中的Channel，调用其处理函数
muduo网路库——高效的多线程日志
amoscykl的博客
10-18 1169
在服务端编程中，日志是必不可少的，通常用于故障诊断和追踪，也可用于性能分析。在生产环境中应该做到 "Log Everything All The Time"。   一个日志库大体可分为前端(frontend)和后端(backend)两部分。前端是供应用程序使用的接口(API),并生成日志消息；后端则负责把日志消息写到目的地。 在多线程程序中，每个线程有自己的前端，整个程序共用一个后端。对于C...
sylar服务器框架分析——日志系统
JMasker的博客
11-10 1415
sylar服务器框架中对于日志系统的重点难点分析
【C++】开源：Muduo网络库配置与使用
DevFrank的博客
07-27 2622
muduo使用
C++Stream风格异步日志（muduo日志）
09-13
陈硕 muduo 异步日志的实现， 去除对boost库的依赖，可直接编译使用.
muduo库的log
tianyexing2008的博客
07-20 115
muduo 库里的日志打印比较复杂，跟标准库 std::cout
muduo 日志库学习(一)
大洋深处
03-17 445
muduo的日志库由LogStream{.h,.cc}、Logging{.h, .cc}、LogFile{.h, .cc}、AsyncLogging{.h, .cc}组成。这里主要说明一下，这些文件（主要是文件里面对应的类）之间是怎么关联，并协同工作的。 LogStream类里面有一个Buffer成员（一个模板类，并非muduo::Buffer类）。该类主要负责将要记录的日志内容放到这个Buffe...
muduo 10 Logger日志
加油加油
07-02 191
debug： 调试信息呢，一般来说是非常非常多的，可能我们在系统正常运行的情况下，会默认把debug日志关掉，当我们需要去输出debug日志的时候，再打开一个开关。对于debug日志，一般不使用时将其关闭，因为debug日志一般信息比较多，一直开着占用资源，所以我们定义#ifdef #endif 条件编译指令。定义一个日志类，由 noncopyable类继承而来，私有化构造函数，静态成员函数获取唯一日志实列对象，包括设置日志级别、写入日志信息函数。infer： 正常的一个日志输出，打印一些重要的流程信息；
muduo学习笔记：base部分之高性能日志库-AsyncLogging
热爱生活，忠于自己
08-04 702
https://blog.csdn.net/q5707802/article/details/79277665
muduo库的高性能日志库（四）——LogFile文件
m0_61705102的博客
11-19 1095
1. 在AppendFile类在构造时将文件的默认缓冲区设置为本地缓冲区 ```为什么要这样做？能带来什么样的性能优势？``` 2. AppendFile中写函数采用的是fwrite_unlock函数，非线程安全的写函数，在LogFile设计写的时候又设计成是否使用互斥锁，调用AppendFile中的append函数。 ```为什么不直接采用线程安全的fwite函数?这样的做的优势体现在哪？```
muduo日志1
abcd1f2的专栏
06-28 571
日志流程 TRACE 指出比DEBUG粒度更细的一些信息事件（开发过程中使用） DEBUG 指出细粒度信息事件对调试应用程序是非常有帮助的。（开发过程中使用） INFO 表明消息在粗粒度级别上突出强调应用程序的运行过程。 WARN 系统能正常运行，但可能会出现潜在错误的情形。 ERROR 指出虽然发生错误事件，但仍然不影响系统的继续运行。 FATAL 指
muduo库日志架构
u012125696的专栏
03-11 266
转载请说明出处！！！ 一、架构概述： 1、采用基于对象的设计： 2、每条日志都采用申请一个logger临时对象，然后获取logger对象中的logStream类成员对象，调用 logStream的<<运算符将日志缓存到logStream的Buffer类成员对象的FixBuffer成员对象的固定缓 存空间中，临时logger对象释放时,在析构函数中调用输出函数将缓存区中的日志输...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值