【Linux】写一个日志类

文章目录

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

在这里插入图片描述

1. 源代码

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

主要功能

  • 日志级别转换:将日志级别从整数转换为字符串。
  • 日志输出方式:支持屏幕输出、单个文件输出和分类文件输出。
  • 日志格式化:支持格式化日志信息,包括时间戳和自定义日志内容。
  • 文件操作:使用系统调用进行文件操作,确保日志写入文件中。
#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 函数

    • 根据设置的输出方式调用对应的日志打印函数(ScreenOnefileClassfile)。
  6. printOneFile 函数

    • 将日志写入单个文件。文件名为传入的 logname,实际路径为 path + logname
  7. printClassFile 函数

    • 将日志按级别分类写入不同的文件,文件名为 “log.txt.日志级别”。
  8. 析构函数 ~Log()

    • 没有特殊操作。
  9. 重载的 operator()

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

3. 代码详细解释

3.1 头文件和宏定义

#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类定义

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 打印日志的方法

    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 操作符重载和析构函数

    ~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); 结束可变参数处理。
  • leftbufferrightbuffer 拼接到 logtxt 中。
  • printLog(level, logtxt)输出日志。

3.5 可变参数函数的原理

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

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

4. 测试用例

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

#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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/668890.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

[无监督学习] 11.详细图解LSA

LSA LSA&#xff08;Latent Semantic Analysis&#xff0c;潜在语义分析&#xff09;是一种自然语言处理技术。作为一种降维算法&#xff0c;它常被用于信息搜索领域。使用 LSA 能够从大量的文本数据中找出单词之间的潜在关联性。 概述 LSA 是在 1988 年被提出的算法&#xff…

Java(七)——Clonable接口与深拷贝

文章目录 Clonable接口与深拷贝克隆对象深拷贝 Clonable接口与深拷贝 克隆对象 考虑&#xff1a;怎样将对象克隆一份&#xff1f; 答案就在本文&#xff0c;我们先给出一步一步的思考过程&#xff0c;然后总结&#xff1a; 首先设置情景&#xff1a;我们有一个Person类&#x…

Wireshark Lua插件入门

摘要 开发中经常通过抓包分析协议&#xff0c;对于常见的协议如 DNS wireshark 支持自动解析&#xff0c;便于人类的理解&#xff0c;对于一些私有协议&#xff0c;wireshark 提供了插件的方式自定义解析逻辑。 1 动手 废话少说&#xff0c;直接上手。 第一步当然是装上wiresh…

[C++]vector的模拟实现

下面是简单的实现vector的功能&#xff0c;没有涉及使用内存池等复杂算法来提高效率。 一、vector的概述 &#xff08;一&#xff09;、抽象数据类型定义 容器&#xff1a;向量&#xff08;vector&#xff09;vector是表示大小可以变化的数组的序列容器。像数组一样&#xf…

GPT-4o vs. GPT-4 vs. Gemini 1.5 性能评测,谁更胜一筹!

OpenAI 最近推出了 GPT-4o&#xff0c;OpenAI有一次火爆了&#xff0c;其图像、音频、视频的处理能力非常强。 最令人印象深刻的是&#xff0c;它支持用户与 ChatGPT 实时互动&#xff0c;并且能够处理对话中断。 而且&#xff0c;OpenAI 免费开放了 GPT-4o API 的访问权限。…

[ROS 系列学习教程] 建模与仿真 - 使用 Xacro 优化 urdf

ROS 系列学习教程(总目录) 本文目录 一、使用属性表示常量二、使用公式三、使用宏定义四、include 其他文件五、优化实践 对于前文介绍的 urdf 模型&#xff0c;我们可以使用 xacro 来优化&#xff0c;使其更易于维护。 优化点&#xff1a; 多次用到的尺寸用常量定义计算使用…

嵌入式linux系统中图片处理详解

大家好,今天给大家分享一下,嵌入式中如何进行图像处理,常见的处理方式有哪几种?这次将详细分析一下 第一:BMP图形处理方式 图形的基本特点,所有的图像文件,都是一种二进制格式文件,每一个图像文件,都可以通过解析文件中的每一组二进制数的含义来获得文件中的各种信息…

Scriptings Tracker

"Scriptings Tracker"&#xff08;脚本追踪器&#xff09;可能是一个用于追踪脚本&#xff08;scriptings&#xff09;的工具或系统。它可以用于记录和管理脚本的创建、修改、版本控制和执行情况。这种工具可能被用于软件开发、自动化任务、电影制作、戏剧等领域。 …

ubuntu系统下安装mysql的步骤详解

一、下载安装包 下载地址&#xff1a; https://dev.mysql.com/downloads/repo/apt 跳转到这个页面&#xff1a; 直接点击Download。 直接点击最下面的开始下载安装包即可。 二、将安装包下载到ubuntu系统中 先将用户切换成root用户&#xff0c;把下载好的安装包复制到桌面上&…

windows配置dns访问git , 加快访问速度保姆级教程

设置 DNS 访问 Git 需要修改电脑的 DNS 配置。下面是具体的操作流程&#xff1a; 第一步&#xff1a;打开命令提示符或终端窗口 在 Windows 系统中&#xff0c;可以按下 Win R 组合键&#xff0c;然后输入 “cmd”&#xff0c;按下 Enter 键打开命令提示符窗口。在 macOS 或 …

TCP/IP(网络编程)

一、网络每一层的作用 &#xff0a;网络接口层和物理层的作用&#xff1a;屏蔽硬件的差异&#xff0c;通过底层的驱动&#xff0c;会提供统一的接口&#xff0c;供网络层使用 &#xff0a;网络层的作用&#xff1a;实现端到端的传输 &#xff0a;传输层:数据应该交给哪一个任…

[数据集][目标检测]老鼠检测数据集VOC+YOLO格式4107张1类别

数据集格式&#xff1a;Pascal VOC格式YOLO格式(不包含分割路径的txt文件&#xff0c;仅仅包含jpg图片以及对应的VOC格式xml文件和yolo格式txt文件) 图片数量(jpg文件个数)&#xff1a;4107 标注数量(xml文件个数)&#xff1a;4107 标注数量(txt文件个数)&#xff1a;4107 标注…

测试工具fio

一、安装部署 fio是一款优秀的磁盘IO测试工具&#xff0c;在Linux中比较常用于测试磁盘IO 其下载地址&#xff1a;https://brick.kernel.dk/snaps/fio-2.1.10.tar.gz 或者登录其官网&#xff1a;http://freshmeat.sourceforge.net/projects/fio/ 进行下载。 tar -zxvf fio-…

RabbitMQ延时队列

一、RabbitMQ下载并使用插件 1、查看RabbitMQ插件的文件路径 docker inspect rabbitmq 找到Mounts下面Name:rabbitmq_plugin的Source即为插件路径 使用 cd 进入到该目录 2、下载插件 wget https://github.com/rabbitmq/rabbitmq-delayed-message-exchange/releases/download…

vue前端Echars

<template><div :class"className" :style"{height:height,width:width}" /> </template><script> import * as echarts from echarts require(echarts/theme/macarons) // echarts theme 柱状图 import resize from ./mixins/re…

win10环境下nodejs安装过程

打开 https://nodejs.org/en/官网下载node.js 2.下载完成后的安装文件为node-v16.16.0-x64.msi&#xff0c;双击进行安装即可。 3.一直默认安装&#xff0c;记得可以更改安装路径 4.其他不用打勾&#xff0c;一直next&#xff0c;安装完成即可。 5.安装完成后&#xff0c;wi…

AI在线UI代码生成,不需要敲一行代码,聊聊天,上传图片,就能生成前端页面的开发神器

ioDraw的在线UI代码生成器是一款开发神器&#xff0c;它可以让您在无需编写一行代码的情况下创建前端页面。 主要优势&#xff1a; 1、极简操作&#xff1a;只需聊天或上传图片&#xff0c;即可生成响应式的Tailwind CSS代码。 2、节省时间&#xff1a;自动生成代码可以节省大…

【论文复现|智能算法改进】融合黑寡妇思想的蜣螂优化算法

目录 1.算法原理2.改进点3.结果展示4.参考文献5.代码获取 1.算法原理 【智能算法】蜣螂优化算法&#xff08;DBO&#xff09;原理及实现 2.改进点 ICMIC混沌映射 z n 1 sin ⁡ ( α z n ) , α ∈ ( 0 , ∞ ) (1) z_{n1}\sin(\frac{\alpha}{z_n}),\alpha\in(0,\infty)\ta…

3D目标检测入门:探索OpenPCDet框架

前言 在自动驾驶和机器人视觉这两个飞速发展的领域中&#xff0c;3D目标检测技术扮演着核心角色。随着深度学习技术的突破性进展&#xff0c;3D目标检测算法的研究和应用正日益深入。OpenPCDet&#xff0c;这个由香港中文大学OpenMMLab实验室精心打造的开源工具箱&#xff0c;…

【六一儿童节】的科技奇幻旅程:解锁【机器学习】与【人工智能】的无限创意

目录 一、机器学习与人工智能简介 二、六一儿童节的特殊意义 三、项目概述&#xff1a;智能绘画助手 四、技术栈和工具 五、数据准备 六、模型训练 1. 数据预处理 2. 构建和训练模型 七、智能绘画助手的实现 1. 搭建Flask应用 2. 客户端界面 八、扩展功能与优化 1…