日志系统——日志格式化模块设计

news2024/12/27 13:50:37

一,模块主要成员

该模块的主要作用是对日志消息进行格式化,将日志消息组织成制定格式的字符串

该模块主要成员有两个:1.格式化字符串。 2.格式化子项数组

1.1 格式化字符串

格式化字符串的主要功能是保存日志输出的格式字符串。其格式化字符主要有下面几种

格式化字符串定义了日志的输出格式,而格式化字符更有助于用户自由的控制日志的输出格式 。这里要注意的是由于我们信息中的日期为时间戳,因此在设置其格式化字符时还应设置对应的子格式化字符如[%d{%H:%M:%S}]指的是按照年月日输出时间

 1.2 格式化子项数组

格式化子项数组:用于按顺序保存格式化字符串对应的子格式化对象(FormatItem类)

那么什么是子格式化类(FormatItem类)?子格式化类主要负责日志消息子项的获取以及格式化,其下包含诸多子类,通过继承关系实现多态,即使是不同的子类也能依靠多态由相同的父类指针指向,从而保存到同一个vector中,Formatltem主要有以下子类:

 格式化字符,以及格式化子项的关系如下,这里我们以日期为例子

 

 

1.3 举例说明

例子:"[%d{%H:%M:%S}] %m%n"

pattern = "[%d{%H:%M:%S}] %m%n"
items = {
 {OtherFormatItem(), "["},
 {TimeFormatItem(), "%H:%M:%S"},
 {OtherFormatItem(), "]"},
 {MsgFormatItem (), ""},
 {NLineFormatItem (), ""}
}
message msg = {
 size_t _line = 22;
 size_t _ctime = 12345678;
 std::thread::id _tid = 0x12345678;
 std::string _logger = "logger";
 std::string _file = "main.cpp";
 std::string _payload = "创建套接字失败";
 LogLevel::level _level = ERROR;
};

格式化的过程其实就是按次序从Msg中取出需要的数据进⾏字符串的连接的过程。

最终组织出来的格式化消息: "[22:32:54] 创建套接字失败\n"

 二,代码实现

2.1 代码

核心代码bool AnalyPattern()的分析如下

 

 

#ifndef _M_FORMAT_H_
#define _M_FORMAT_H_

#include "level.hpp"
#include "message.hpp"
#include "util.hpp"
#include <vector>
#include <memory>
#include <sstream>


namespace mjwlog
{
    // 格式化子项基类
    class Formatlem
    {
    public:
        using ptr=std::shared_ptr<Formatlem>;
        virtual void format(std::ostream &os, const message& msg) = 0;
    };
    // 格式化子项子类
    // 日期类子类
    class TimeFormatlem : public Formatlem
    {
    public:
        TimeFormatlem(std::string format="%H:%M:%S")
            :_fromat(format)
        {}

        void format(std::ostream &os, const message& msg) override
        {
            struct tm time;
            localtime_r((time_t*)&msg._time,&time);
            char str[32];
            strftime(str,sizeof(str)-1,_fromat.c_str(),&time);
            
            os<<str;
        }
    private:
        std::string _fromat;//用来控制输出格式
    };

    //缩进子类
    class TabFormatlem : public Formatlem
    {
    public:
        void format(std::ostream &os, const message& msg) override
        {
            os<<"\t";
        }
    };

    //线程id子类
    class ThreadFormatlem : public Formatlem
    {
    public:
        void format(std::ostream &os, const message& msg) override
        {
            os<<msg._id;
        }
    };

    //日志级别子类
    class LevelFormatlem : public Formatlem
    {
    public:
        void format(std::ostream &os, const message& msg) override
        {
            os<<LogLevel::LeveltoString(msg._level);
        }
    };

    //日志器名称子类
    class NameFormatlem : public Formatlem
    {
    public:
        void format(std::ostream &os, const message& msg) override
        {
            os<<msg._logger;
        }
    };

    //文件名子类
    class CFileFormatlem : public Formatlem
    {
    public:
        void format(std::ostream &os, const message& msg) override
        {
            os<<msg._filename;
        }
    };

    //行号子类
    class CLineFormatlem : public Formatlem
    {
    public:
        void format(std::ostream &os, const message& msg) override
        {
            os<<msg._line;
        }
    };

    //日志消息主体子类
    class MsgFormatlem : public Formatlem
    {
    public:
        void format(std::ostream &os, const message& msg) override
        {
            os<<msg._msg;
        }
    };

    //换行子类
    class NLineFormatlem : public Formatlem
    {
    public:
        void format(std::ostream &os, const message& msg) override
        {
            os<<"\n";
        }
    };

    //其他字符子类,直接原路返回
    class OtherFormatlem : public Formatlem
    {
    public:
        OtherFormatlem(std::string str)
            :_str(str)
        {}
        void format(std::ostream &os, const message& msg) override
        {
            os<<_str;
        }
    private:
        std::string _str;
    };

        
    //格式化类
    class Formatter
    {
        /*
            %d 日期
            %T 缩进
            %t 线程id
            %p 日志级别
            %c 日志器名称
            %f 文件名
            %l 行号
            %m 日志消息
            %n 换行
        */
    public:
        //默认格式:时间{年-月-日 时:分:秒}缩进 线程ID 缩进 [日志级别] 缩进 [日志器名称] 缩进 文件名:行号 缩进 消息换行
        Formatter(std::string pattern="[%d{%H:%M:%S}]%T[%t]%T[%p]%T[%c]%T[%f:%l]%T%n")
            :_pattern(pattern)
        {}
        //对msg进行格式化n

        void format(std::ostream& os,const message& msg)//将格式化后的内容写入os执行流
        {
            if(AnalyPattern())
            {
                for(auto& it:_items)
                {
                    it->format(os,msg);
                }
            }
        }
        std::string format(const message& msg)//将格式化后的内容以string方式返回
        {
            std::stringstream str;
            if(AnalyPattern())
            {
                for(auto& it:_items)
                {
                    it->format(str,msg);
                }
            }
            return str.str();
        }
        //对格式化字符串进行分析
        bool AnalyPattern()
        {
            //遍历_parttern进行逐一分析
            int cur=0;
            std::string key="",val="";
            //"abc[%%d{%H:%M:%S}]"
            while(cur<_pattern.size())
            {
                
                //先排查非格式化字符,如abc
                if(_pattern[cur]!='%')
                {
                    val+=_pattern[cur++];
                    //特殊情况:"aaaa[%%d{%H:%M:%S}]"
                    if(cur==_pattern.size())
                    {
                        _items.push_back(createItem(key,val));
                    }
                    continue;
                }
                //到这一步,说明碰到%,这是需要排除"%[" "%%"等情况
                //"%["
                //if(_pattern[cur]=='%'&&_pattern[cur+1]=='%')
                if(_pattern[cur]=='%'&&(!isalpha(_pattern[cur+1])))
                {
                    val+=_pattern[cur++];
                    //特殊情况:"aaaa[%%d{%H:%M:%S}%"
                    /* if(cur==_pattern.size())
                    {
                        _items.push_back(createItem(key,val));
                    } */
                    continue;
                }
                //此时,key为空,val中全是非格式化字符字符
                //不过也有可能val中没有任何字符
                if(!val.empty()) _items.push_back(createItem(key,val));
                key.clear();
                val.clear();
                //cur+1==_pattern.size()
                if(cur+1==_pattern.size())
                {
                    std::cout<<"格式化字符关键字%后数据错误"<<std::endl;
                    return false;
                }

                //到这一步,说明目前cur指向%,且cur+1指向的为一个字母字符
                cur=cur+1;
                key+=_pattern[cur++];
                //"abc[%%d{%H:%M:%S}]",此时cur指向d后面的{
                //因此,这时候我们需要判断后面是否是子格式化字符
                if(cur<_pattern.size()&&_pattern[cur]=='{')
                {
                    cur++;
                    while(cur<_pattern.size()&&_pattern[cur]!='}')
                    {
                        val+=_pattern[cur++];
                    }
                    //出while循环有下面两种可能
                    //1.cur==_pattern.size(),说明没有找到'}',说明这是非法子格式化字符
                    if(cur==_pattern.size())
                    {
                        std::cout<<"非法子格式化字符...."<<std::endl;
                        abort();
                    }
                    //2._pattern[cur]=='}'
                    _items.push_back(createItem(key,val));
                    key.clear();
                    val.clear();
                    //此时cur指向},因此进入下一个循环前cur应该++
                    cur++;
                }
                else
                {
                    _items.push_back(createItem(key,val));
                    key.clear();
                    val.clear();
                }
                
            }
            return true;
        }
    private:
        //根据不同的格式创建不同的格式化子类对象
        //key用来存储格式化字符,val用来存储格式化字符子字符如[%d{%H:%M:%S}]
        std::shared_ptr<Formatlem> createItem(const std::string& key,const std::string& val)
        {
            if(key=="d") return Formatlem::ptr(new TimeFormatlem(val));
            if(key=="T") return Formatlem::ptr(new TabFormatlem());
            if(key=="p") return Formatlem::ptr(new LevelFormatlem());
            if(key=="t") return Formatlem::ptr(new ThreadFormatlem());
            if(key=="c") return Formatlem::ptr(new NameFormatlem());
            if(key=="f") return Formatlem::ptr(new CFileFormatlem());
            if(key=="l") return Formatlem::ptr(new CLineFormatlem());
            if(key=="n") return Formatlem::ptr(new NLineFormatlem());
            //当key为空时,则说明val里存储的是非格式化化字符,如abcd
            if(key.empty()) return Formatlem::ptr(new OtherFormatlem(val));
            //还有一种情况,就是key中存储的不是设定的格式字符,如%g
            std::cout<<"没有该格式化字符:%"<<key<<std::endl;
            abort();

            return nullptr;
        }
    private:
        std::string _pattern;
        std::vector<Formatlem::ptr> _items;
    };
}

#endif

3.1 测试

 

 

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

网络安全/黑客技术(就业前景与经验分享)

网络安全与我们每一个人都息息相关&#xff0c;无论是企业还是个人&#xff0c;现在都非常重视网络安全。而且网络安全是一个新兴的行业&#xff0c;人才需求量远远大于供给&#xff0c;所以在薪资福利上具有很大的优势&#xff0c;并且对于初学者而言&#xff0c;很多人依旧担…

ThreadPool线程池

文章目录 一.概述和架构二.使用方式和底层原理三.七个参数介绍四.工作流程和拒绝策略五.自定义线程池 一.概述和架构 一种线程使用模式。线程过多会带来调度开销,进而影响缓存局部性和整体性能,而线程池维护着多个线程,等待着监督管理者分配可并发执行的任务,这避免了在短时间…

文件名称是递增的,删除掉其中一部分的文件,导致递增文件缺少,通过python查找出缺少的递增文件名称

文件名称是递增的&#xff0c;删除掉其中一部分的文件&#xff0c;导致递增文件缺少&#xff0c;通过python查找出缺少的递增文件名称 通过python,查找出缺少的递增的文件的名称&#xff1a; 代码如下&#xff1a; import osdef find_missing_numbers(folder_path):file_list …

6000万美元?通用汽车投资初创新贵Mitra,开发“经济型电池”

根据最新消息&#xff0c;通用汽车公司日前宣布领导一轮6000万美元的B轮融资&#xff0c;投资对象为电池材料初创公司Mitra Chem。此次投资旨在帮助通用汽车改进未来电动汽车的电池制造&#xff0c;使其更加经济实惠且易获取。 目前&#xff0c;大多数电池使用的是镍和钴的制造…

linux系统--makefile文件,gdb 以及文件描述符

目录 1 makefile 1.1 makefile的基本规则 1.2 makefile工作原理 1.3 makefile中的变量 1.4 makefile函数 1.5 makefile的清理操作 2 gdb调试 2.1 gdb介绍 2.2 生成调试信息 2.3 启动gdb 2.4 显示源代码 3文件IO 3.1 C库IO函数的工作流程 3.2 C库函数与系统函数的…

Sigmastar SSC8826Q 2K行车记录仪解决方案

一、方案描述 行车记录仪是智能辅助汽车驾驶&#xff0c;和管理行车生活的车联网智能终端设备&#xff0c;利用智能芯片处理器、GPS定位、网络通信、自动控制等技术&#xff0c;将与行车生活有关的各项数据有机地结合在一起。 行车记录仪如今已经成了必不可少的车载用品之一&…

用栈解决有效的括号匹配问题

//用数组实现栈 typedef char DataType; typedef struct stack {DataType* a;//动态数组int top;//栈顶int capacity; //容量 }ST;void STInit(ST*pst);//初始化void STDestroy(ST* pst);//销毁所有空间void STPush(ST* pst, DataType x);//插入数据到栈中void STPop(ST* pst);…

开学有什么平替电容笔值得买?比较好用的ipad手写笔

相信不少的学生党都已经在开学前入手了iPad&#xff0c;而现在&#xff0c;电容笔作为iPad的一种主要配件&#xff0c;其的性能也在不断地提高&#xff0c;使用电容笔的用户也在不断地增加。因此&#xff0c;如何挑选一款物美价廉的电容笔成为大家最关心的问题。那么&#xff0…

C/C++ : C/C++的详解,C语言与C++的常用算法以及算法的各自用法和应用(初级,中级),C++ CSP考题(J居多,S偏少)的详解,NOI的真题题解

目录 1.C语言 2.C 3.C与C语言的共同/不同点 4.导读 5.相关文章 5.1&#xff1a;Dev-C是Windows 环境下的一个轻量级 C/C 集成开发环境&#xff08;IDE&#xff09; 5.2&#xff1a;C是从C语言发展而来的&#xff0c;而C语言的历史可以追溯到1969年 6.C/C最新年度总…

java编译报错,get方法报错

java编译报错&#xff0c;get方法报错 处理方式&#xff1a; 在空间中&#xff0c;将 buid 文件夹删除 再不行的话&#xff0c;重启电脑&#xff0c;删除各种缓存 试试

Java请求Http接口-OkHttp(超详细-附带工具类)

简介&#xff1a;OkHttp是一个默认有效的HTTP客户端&#xff0c;有效地执行HTTP可以加快您的负载并节省带宽&#xff0c;如果您的服务有多个IP地址&#xff0c;如果第一次连接失败&#xff0c;OkHttp将尝试备用地址。这对于IPv4 IPv6和冗余数据中心中托管的服务是必需的。OkHt…

【boost网络库从青铜到王者】第五篇:asio网络编程中的同步读写的客户端和服务器示例

文章目录 1、简介2、客户端设计3、服务器设计3.1、session函数3.2、StartListen函数3、总体设计 4、效果测试5、遇到的问题5.1、服务器遇到的问题5.1.1、不用显示调用bind绑定和listen监听函数5.1.2、出现 Error occured!Error code : 10009 .Message: 提供的文件句柄无效。 [s…

docker限制容器日志大小

文章目录 业务场景问题排查彻底解决 业务场景 我们公司做交通相关业务&#xff0c;我们部门主要负责信控服务&#xff0c;卖信号机的硬件产品和配套的信控平台 由于有部分小项目&#xff0c;可能只有几十个路口&#xff0c;客户预算有限&#xff0c;只给我们老旧的Windows ser…

Google浏览器点击链接打开新标签页

由于新安装的谷歌浏览器点击链接时默认在当前窗口打开非常不方便&#xff0c;这里提供一下解决思路 1、打开浏览器输入任意内容&#xff0c;点击右上角的设置 2、在弹出的选项栏中点击See all Search settings 3、点击Other settings&#xff0c;将指定选项打开即可

数据结构——二叉搜索树

本章代码:二叉搜索树 文章目录 &#x1f332;1.二叉搜索树概念&#x1f333;2. 二叉搜索树操作&#x1f33f;2.1 结构定义&#x1f33f;2.2 插入操作&#x1f33f;2.3 查找操作&#x1f33f;2.4 删除操作&#x1f33f;2.5 遍历 &#x1f334;3. 二叉搜索树应用场景&#x1f340…

[JavaWeb]【五】web后端开发-Tomcat SpringBoot解析

目录 一 介绍Tomcat 二 基本使用 2.1 解压绿色版 2.2 启动TOMCAT 2.3 关闭TOMCAT 2.4 常见问题 2.5 修改端口号 2.6 部署应用程序 三 SpringBootWeb入门程序解析 前言&#xff1a;tomcat与SpringBoot解析 一 介绍Tomcat 二 基本使用 2.1 解压绿色版 2.2 启动TOMCAT 2…

作业day4

1.通过字符设备驱动分步注册方式编写LED灯的驱动&#xff0c;应用程序使用ioctl函数编写硬件控制逻辑 head.h #ifndef __HEAD_H__ #define __HEAD_H__ typedef struct {unsigned int MODER; unsigned int OTYPER; unsigned int OSPEEDR; unsigned int PUPDR; unsigned int …

主机防护的重要性和方式

01 主机防护的重要性 主机防护是网络安全的重要组成部分。在互联网时代&#xff0c;网络攻击成为了一种常见的威胁&#xff0c;而主机防护则是保护计算机系统免受网络攻击的重要手段。 主机防护可以防范各种网络攻击&#xff0c;如病毒、木马、黑客攻击等&#xff0c;从而保…

如何做好会员管理,有哪些好用的会员管理系统?

会员管理对于企业或中小商户来说非常重要&#xff0c;会员管理可以建立和维护与顾客之间的紧密关系&#xff0c;通过会员管理系统记录和分析会员的购买历史、偏好和行为&#xff0c;可以更好地了解他们的需求和兴趣&#xff0c;增加销售机会和满意度。 那么我们应该如何做好会员…

【深度学习 | 感知器 MLP(BP神经网络)】掌握感知的艺术: 感知器和MLP-BP如何革新神经网络

&#x1f935;‍♂️ 个人主页: AI_magician &#x1f4e1;主页地址&#xff1a; 作者简介&#xff1a;CSDN内容合伙人&#xff0c;全栈领域优质创作者。 &#x1f468;‍&#x1f4bb;景愿&#xff1a;旨在于能和更多的热爱计算机的伙伴一起成长&#xff01;&#xff01;&…