【Linux】写一个日志类

字节连结2024-06-02 13:34

文章目录

  • [1. 源代码](#1. 源代码)
  • [2. 函数功能概览](#2. 函数功能概览)
  • [3. 代码详细解释](#3. 代码详细解释)
    • [3.1 头文件和宏定义](#3.1 头文件和宏定义)
    • [3.2 Log类定义](#3.2 Log类定义)
    • [3.3 打印日志的方法](#3.3 打印日志的方法)
    • [3.4 操作符重载和析构函数](#3.4 操作符重载和析构函数)
    • [3.5 可变参数函数的原理](#3.5 可变参数函数的原理)
  • [4. 测试用例](#4. 测试用例)

1. 源代码

下面代码定义了一个 Log 类，用于记录日志信息。这个类支持将日志信息输出到屏幕、单个文件或者按日志级别分类的多个文件。

主要功能：

  • 日志级别转换：将日志级别从整数转换为字符串。
  • 日志输出方式：支持屏幕输出、单个文件输出和分类文件输出。
  • 日志格式化：支持格式化日志信息，包括时间戳和自定义日志内容。
  • 文件操作：使用系统调用进行文件操作，确保日志写入文件中。
cpp 复制代码 
#pragma once

#include <iostream>
#include <time.h>
#include <stdarg.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <stdlib.h>

#define SIZE 1024

#define Info 0
#define Debug 1
#define Warning 2
#define Error 3
#define Fatal 4

#define Screen 1
#define Onefile 2
#define Classfile 3

#define LogFile "log.txt"

class Log
{
public:
    Log()
    {
        printMethod = Screen;
        path = "./log/";
    }
    void Enable(int method)
    {
        printMethod = method;
    }
    std::string levelToString(int level)
    {
        switch (level)
        {
        case Info:
            return "Info";
        case Debug:
            return "Debug";
        case Warning:
            return "Warning";
        case Error:
            return "Error";
        case Fatal:
            return "Fatal";
        default:
            return "None";
        }
    }
    void printLog(int level, const std::string &logtxt)
    {
        switch (printMethod)
        {
        case Screen:
            std::cout << logtxt << std::endl;
            break;
        case Onefile:
            printOneFile(LogFile, logtxt);
            break;
        case Classfile:
            printClassFile(level, logtxt);
            break;
        default:
            break;
        }
    }
    void printOneFile(const std::string &logname, const std::string &logtxt)
    {
        // ./log/ + log.txt
        std::string _logname = path + logname;
        int fd = open(_logname.c_str(), O_WRONLY | O_CREAT | O_APPEND, 0666);
        if (fd < 0)
            return;
        write(fd, logtxt.c_str(), logtxt.size());
        close(fd);
    }
    void printClassFile(int level, const std::string &logtxt)
    {
        std::string filename = LogFile;
        filename += ".";
        // log.txt.Debug/Warning/Fatal
        filename += levelToString(level);
        printOneFile(filename, logtxt);
    }
    ~Log()
    {
    }
    void operator()(int level, const char *format, ...)
    {
        time_t t = time(nullptr);
        struct tm *ctime = localtime(&t);
        char leftbuffer[SIZE];
        snprintf(leftbuffer, sizeof(leftbuffer), "[%s][%d-%d-%d %d:%d:%d]", levelToString(level).c_str(),
                 ctime->tm_year + 1900, ctime->tm_mon + 1, ctime->tm_mday,
                 ctime->tm_hour, ctime->tm_min, ctime->tm_sec);

        va_list s;
        va_start(s, format);
        char rightbuffer[SIZE];
        vsnprintf(rightbuffer, sizeof(rightbuffer), format, s);
        va_end(s);

        // 格式: 默认部分 + 自定义部分
        char logtxt[SIZE * 2];
        snprintf(logtxt, sizeof(logtxt), "%s %s", leftbuffer, rightbuffer);

        printLog(level, logtxt);
    }

private:
    int printMethod;
    std::string path;
};

2. 函数功能概览

  1. 宏定义：

    • SIZE: 定义缓冲区大小为1024。
    • Info, Debug, Warning, Error, Fatal: 定义日志级别。
    • Screen, Onefile, Classfile: 定义日志输出方式。
    • LogFile: 定义默认日志文件名为 "log.txt"。

  2. 类的构造函数 Log()：

    • 初始化日志输出方式为 Screen（输出到屏幕）。
    • 设置日志文件路径为 "./log/"。

  3. Enable 函数：

    • 设置日志输出方式。

  4. levelToString 函数：

    • 将日志级别转换为对应的字符串表示。

  5. printLog 函数：

    • 根据设置的输出方式调用对应的日志打印函数（Screen、Onefile、Classfile）。

  6. printOneFile 函数：

    • 将日志写入单个文件。文件名为传入的 logname，实际路径为 path + logname。

  7. printClassFile 函数：

    • 将日志按级别分类写入不同的文件，文件名为 "log.txt.日志级别"。

  8. 析构函数 ~Log()：

    • 没有特殊操作。

  9. 重载的 operator()：

    • 使用可变参数处理日志信息，格式化后调用 printLog 打印日志。

3. 代码详细解释

3.1 头文件和宏定义

cpp 复制代码 
#pragma once

#include <iostream>
#include <time.h>
#include <stdarg.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <stdlib.h>

#define SIZE 1024

#define Info 0
#define Debug 1
#define Warning 2
#define Error 3
#define Fatal 4

#define Screen 1
#define Onefile 2
#define Classfile 3

#define LogFile "log.txt"
  • #pragma once：确保头文件只被编译一次。
  • #include：引入了标准库和系统头文件。
  • #define：定义了一些常量，用于日志级别和输出方式。

3.2 Log类定义

cpp 复制代码 
class Log
{
public:
    Log()
    {
        printMethod = Screen;
        path = "./log/";
    }
    void Enable(int method)
    {
        printMethod = method;
    }
    std::string levelToString(int level)
    {
        switch (level)
        {
        case Info:
            return "Info";
        case Debug:
            return "Debug";
        case Warning:
            return "Warning";
        case Error:
            return "Error";
        case Fatal:
            return "Fatal";
        default:
            return "None";
        }
    }
  • Log()：构造函数，初始化日志输出方式为屏幕输出（Screen），并设置日志文件路径为./log/。
  • Enable(int method)：设置日志输出方法。
  • levelToString(int level)：将日志级别转换为字符串。

3.3 打印日志的方法

cpp 复制代码 
    void printLog(int level, const std::string &logtxt)
    {
        switch (printMethod)
        {
        case Screen:
            std::cout << logtxt << std::endl;
            break;
        case Onefile:
            printOneFile(LogFile, logtxt);
            break;
        case Classfile:
            printClassFile(level, logtxt);
            break;
        default:
            break;
        }
    }
    void printOneFile(const std::string &logname, const std::string &logtxt)
    {
        std::string _logname = path + logname;
        int fd = open(_logname.c_str(), O_WRONLY | O_CREAT | O_APPEND, 0666);
        if (fd < 0)
            return;
        write(fd, logtxt.c_str(), logtxt.size());
        close(fd);
    }
    void printClassFile(int level, const std::string &logtxt)
    {
        std::string filename = LogFile;
        filename += ".";
        filename += levelToString(level);
        printOneFile(filename, logtxt);
    }
  • printLog(int level, const std::string &logtxt)：根据不同的输出方式打印日志。
  • printOneFile(const std::string &logname, const std::string &logtxt)：将日志写入单个文件。
  • printClassFile(int level, const std::string &logtxt)：根据日志级别写入分类文件。

3.4 操作符重载和析构函数

cpp 复制代码 
    ~Log()
    {
    }
    void operator()(int level, const char *format, ...)
    {
        time_t t = time(nullptr);
        struct tm *ctime = localtime(&t);
        char leftbuffer[SIZE];
        snprintf(leftbuffer, sizeof(leftbuffer), "[%s][%d-%d-%d %d:%d:%d]", levelToString(level).c_str(),
                 ctime->tm_year + 1900, ctime->tm_mon + 1, ctime->tm_mday,
                 ctime->tm_hour, ctime->tm_min, ctime->tm_sec);

        va_list s;
        va_start(s, format);
        char rightbuffer[SIZE];
        vsnprintf(rightbuffer, sizeof(rightbuffer), format, s);
        va_end(s);

        char logtxt[SIZE * 2];
        snprintf(logtxt, sizeof(logtxt), "%s %s", leftbuffer, rightbuffer);

        printLog(level, logtxt);
    }

operator()：重载了函数调用操作符，使得Log类的对象可以像函数一样被调用。

  • time_t t = time(nullptr); 获取当前时间。
  • struct tm *ctime = localtime(&t); 将时间转换为本地时间结构。
  • snprintf()格式化时间和日志级别。
  • va_list s; 定义一个可变参数列表。
  • va_start(s, format); 初始化可变参数列表。
  • vsnprintf(rightbuffer, sizeof(rightbuffer), format, s); 将可变参数格式化为字符串。
  • va_end(args); 结束可变参数处理。
  • 将 leftbuffer 和 rightbuffer 拼接到 logtxt 中。
  • printLog(level, logtxt)输出日志。

3.5 可变参数函数的原理

C++ 的可变参数函数使用 stdarg.h 中定义的一组宏来处理任意数量的参数。这些宏包括：

  • va_list: 声明一个变量来存储参数列表。
  • va_start: 初始化参数列表。
  • va_arg: 访问参数列表中的下一个参数。
  • va_end: 结束参数列表的访问。

4. 测试用例

下面是一些测试用例，用于测试多参数输入和不同的日志输出方式。

cpp 复制代码 
#include "log.hpp"

int main()
{
    Log logger;

    // 测试屏幕输出
    logger.Enable(Screen);
    logger(Info, "This is an info log with no parameters");
    logger(Warning, "This is a warning log with one parameter: %d", 42);
    logger(Error, "This is an error log with two parameters: %s and %d", "error_code", 404);

    // 测试单文件输出
    logger.Enable(Onefile);
    logger(Debug, "Debug log to one file with one parameter: %f", 3.14);
    logger(Fatal, "Fatal log to one file with no parameters");

    // 测试分类文件输出
    logger.Enable(Classfile);
    logger(Info, "Info log to class file");
    logger(Warning, "Warning log to class file with two parameters: %s and %d", "test", 123);

    return 0;
}

这些测试用例将测试以下功能：

  1. 不同日志级别的信息输出。
  2. 带有不同数量参数的日志格式化。
  3. 日志输出到屏幕、单文件和分类文件。

注意：要保证日志目录存在（默认为 ./log/ ），日志文件才会自动创建在该目录内。

END

相关推荐
Ajiang282473530443 分钟前
对于C++中stack和queue的认识以及priority_queue的模拟实现
开发语言·c++
内核程序员kevin3 小时前
TCP Listen 队列详解与优化指南
linux·网络·tcp/ip
‘’林花谢了春红‘’5 小时前
C++ list （链表）容器
c++·链表·list
qq_17448285757 小时前
springboot基于微信小程序的旧衣回收系统的设计与实现
spring boot·后端·微信小程序
->yjy7 小时前
计算机网络(第一章)
网络·计算机网络·php
机器视觉知识推荐、就业指导7 小时前
C++设计模式：建造者模式（Builder） 房屋建造案例
c++
朝九晚五ฺ7 小时前
【Linux探索学习】第十四弹——进程优先级：深入理解操作系统中的进程优先级
linux·运维·学习
锅包肉的九珍7 小时前
Scala的Array数组
开发语言·后端·scala
自由的dream7 小时前
Linux的桌面
linux
心仪悦悦7 小时前
Scala的Array（2）
开发语言·后端·scala
热门推荐
01(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明02PyTorch机器学习实现液态神经网络03【HarmonyOS】HUAWEI DevEco Studio 下载地址汇总04玄机平台应急响应—webshell查杀05Coze扣子平台完整体验和实践（附国内和国际版对比）06Ubuntu 20.04使用Livox mid 360 测试 FAST_LIO07【目标跟踪】相机运动补偿08Unity中PICO实现 隔空取物 和 接触抓取物体09RAG 实践- Ollama+RagFlow 部署本地知识库10怎样让音频速度变慢？请跟随以下方法进行操作