[C++]——同步异步日志系统(3)

同步异步日志系统

  • 一、日志系统框架设计
    • 1.1模块划分
      • 1.1.1 日志等级模块
      • 1.1.2 日志消息模块
      • 1.1.3 日志消息格式化模块
      • 1.1.4 日志落地模块(日志落地的方向是工厂模式)
      • 1.1.5 日志器模块(日志器的生成是建造者模式)
      • 1.1.6 异步线程模块(日志的输出是用宏完成的代理模式)
      • 1.1.7 单例的日志器管理模块(单例模式实现对日志器的管理)
    • 1.2 模块关系图
  • 二、代码设计
    • 2.1 实用类设计

日志系统:
作用:将一条消息,进行格式化为指定格式的字符串后,写入到指定位置

  1. 日志要写入指定位置(标准输出,指定文件, 滚动文件等等是可扩展得)
    日志系统需要支持将日志消息落地到不同的位置—多落地方向
  2. 日志写入指定位置,支持不同的写入方式(同步,异步)
    同步:业务线程自己负责日志的写入(流程简单,但是有可能会因为阻塞导致效率降低) 异步:业务线程将日志放入缓冲区内存,让其他异步线程负责将日志写入指定位置
  3. 日志输出以日志器为单位,支持多日志器(不同的项目组有不同的输出策略)

一、日志系统框架设计

本项⽬实现的是⼀个多⽇志器⽇志系统,主要实现的功能是让程序员能够轻松的将程序运⾏⽇志信息落地到指定的位置,且⽀持同步异步两种⽅式的⽇志落地⽅式。

1.1模块划分

1.1.1 日志等级模块

枚举出日志分为多少个等级—对不同的日志有不同等级标记–以便于控制输出

  • OFF:关闭
  • DEBUG:调试,调试时的关键信息输出。
  • INFO:提示,普通的提⽰型⽇志信息。
  • WARN:警告,不影响运⾏,但是需要注意⼀下的⽇志。
  • ERROR:错误,程序运⾏出现错误的⽇志。
  • FATAL:致命,⼀般是代码异常导致程序⽆法继续推进运⾏的⽇志。

1.1.2 日志消息模块

封装一条日志所需的各种要素(时间,线程ID,文件名,行号,日志等级,消息主体…)

  • 时间:描述本条⽇志的输出时间。
  • 线程ID:描述本条⽇志是哪个线程输出的。
  • ⽇志等级:描述本条⽇志的等级。
  • ⽇志数据:本条⽇志的有效载荷数据。
  • ⽇志⽂件名:描述本条⽇志在哪个源码⽂件中输出的。
  • ⽇志⾏号:描述本条⽇志在源码⽂件的哪⼀⾏输出的。

1.1.3 日志消息格式化模块

按照指定的格式,对于日志消息中关键要素进行组织,最终得到一个指定格式的字符串

系统默认的输出格式: [%d{%H:%M:%S}]%T[%t]%T[%p]%T[%c]%T%f:%l%T%m%n
[12:38:45] [12345678] [FATAL] [root] main.c:178 套接字创建失败…\n

  • %d{%H:%M:%S}:表⽰⽇期时间,花括号中的内容表示日期时间的格式。
  • %T:表⽰制表符缩进。
  • %t:表⽰线程ID。%p:表⽰⽇志级别。
  • %c:表⽰⽇志器名称,不同的开发组可以创建⾃⼰的⽇志器进⾏⽇志输出,⼩组之间互不影响。
  • %f:表⽰⽇志输出时的源代码⽂件名。
  • %l:表⽰⽇志输出时的源代码⾏号。
  • %m:表⽰给与的⽇志有效载荷数据 。
  • %n:表⽰换行。
  • 设计思想:设计不同的⼦类,不同的⼦类从⽇志消息中取出不同的数据进⾏处理。

1.1.4 日志落地模块(日志落地的方向是工厂模式)

决定了⽇志的落地⽅向,以什么方式输出。

  • 标准输出:表⽰将⽇志进⾏标准输出的打印。
  • ⽇志⽂件输出:表⽰将⽇志写⼊指定的⽂件末尾。
  • 滚动⽂件输出:当前以⽂件⼤⼩进⾏控制,当⼀个⽇志⽂件⼤⼩达到指定⼤⼩,则切换下⼀个⽂件进⾏输出 。
  • 后期,也可以扩展远程⽇志输出,创建客⼾端,将⽇志消息发送给远程的⽇志分析服务器。
  • 设计思想:设计不同的⼦类,不同的⼦类控制不同的⽇志落地⽅向。

1.1.5 日志器模块(日志器的生成是建造者模式)

对上边几个模块的整合,⽤⼾通过⽇志器进⾏⽇志的输出,有效降低⽤⼾的使⽤ 难度。
⽇志消息落地模块对象,⽇志消息格式化模块对象,⽇志输出等级

  • 同步日志器模块—完成日志的同步输出功能。
  • 异步日志器模块—完成日志的异步输出功能(将日志消息发送到日志缓冲器内存)

1.1.6 异步线程模块(日志的输出是用宏完成的代理模式)

负责异步日志的实际落地输出功能

  • 实现对⽇志的异步输出功能,⽤⼾只需要将输出⽇志任务放⼊任务池,异步线程负责⽇志的落地输出功能,提供了更加⾼效的⾮阻塞的⽇志输出。

1.1.7 单例的日志器管理模块(单例模式实现对日志器的管理)

为了方便管理,可以在程序的任意位置使用日志器,我设置一个单例对象。对日志进行全局的管理,以便于能够在项目的任何位置获取指定的日志器进行日志输出。

  • 为了降低项⽬开发的⽇志耦合,不同的项⽬组可以有⾃⼰的⽇志器来控制输出格式以及落地⽅向,因此本项⽬是⼀个多⽇志器的⽇志系统。
  • 管理模块就是对创建的所有⽇志器进⾏统⼀管理。并提供⼀个默认⽇志器,提供标准输出的⽇志输出。

1.2 模块关系图

在这里插入图片描述
通过模块关系图,能够简单快速的了解模块之间的关系。

二、代码设计

2.1 实用类设计

提前完成一些功能和接口。

  1. 首先需要把架子搭起来,功能先声明好。
//  通⽤功能类,与业务⽆关的功能实现
//  1. 获取系统时间
//  2. 判断文件是否存在
//  3. 获取⽂件所在⽬录的路径
//  4. 创建⽬录
//静态接口可以直接使用,不需要实例化对象
#include <iostream>
namespace logsLearn {
    namespace util{
        //日期类
        class Data{
            public:
            //获取系统时间
            static size_t now();
        };
        //文件类
        class File{
            public:
            //判断文件是否存在
            static bool exists(const std::string &pathname);
            //获取⽂件所在⽬录的路径
            static std::string path(const std::string &pathname);
            //创建⽬录
            static void createDirectory(const std::string &pathname);
        };
    } 
}
  1. 其次在实现各个功能。
// 条件编译,防止头文件重复包含
#ifndef __M_UTIL_H__
#define __M_UTIL_H__
//  通⽤功能类,与业务⽆关的功能实现
//  1. 获取系统时间
//  2. 判断文件是否存在
//  3. 获取⽂件所在⽬录的路径
//  4. 创建⽬录
#include <iostream>
#include <ctime>
#include <sys/stat.h>
#include <sys/types.h>
namespace logsLearn
{
    namespace util
    {
        // 日期类
        class Data
        {
        public:
            // 获取系统时间
            static size_t now()
            {
                // 返回当前系统时间
                return time(nullptr);
            }
        };
        // 文件类
        class File
        {
        public:
            // 判断文件是否存在
            static bool exists(const std::string &pathname)
            { // 定义了一个stat的结构体变量
                struct stat st;
                // 获取文件信息不成功,进入条件
                if (stat(pathname.c_str(), &st) < 0)
                {
                    return false;
                }
                return true;
            }
            // 获取⽂件所在⽬录的路径
            static std::string path(const std::string &pathname)
            { 
                if (pathname.empty()) return ".";
                // pos是当前查找的最后“/\\”的位置
                size_t pos = pathname.find_last_of("/\\");
                // 没有找到"/\\"
                if (pos == std::string::npos)
                    return ".";
                // 找到了,返回路径,左闭右开原则,要想包括pos位置,需要加1
                return pathname.substr(0, pos + 1);
            }
            // 创建⽬录
            static void createDirectory(const std::string &pathname)
            { // pos找到的位置,idx是存的位置

                size_t pos = 0, idx = 0;
                while (idx < pathname.size())
                {
                    // 遍历路径每找到最后一个"/\\"创建文件夹
                    size_t pos = pathname.find_first_of("/\\", idx);
                    if (pos == std::string::npos)
                    { // 创建文件夹,pathname.c_str()表示路径名,0777表示权限
                        mkdir(pathname.c_str(), 0777);
                    }
                    // 前面的路径
                    std::string parent_dir = pathname.substr(0, pos + 1);
                    // 文件是否存在
                    if (exists(parent_dir) == true)
                    {
                        idx = pos + 1;
                        continue;
                    }
                    // 文件不存在,创建文件
                    mkdir(parent_dir.c_str(), 0777);
                    idx = pos + 1;
                }
            }
        };
    }
}
#endif
  1. 我们每次编写完一个模块后,要对其进行单元测试,确保程序的准确性。
//测试代码
#include "util.hpp"
int main()
{
    //工具类测试
    std::cout<<logsLearn::util::Data::now()<<std::endl;
    std::string pathname="./abc/bcd/a.txt";
    std::cout<<pathname;
    logsLearn::util::File::createDirectory(logsLearn::util::File::path(pathname));
    return 0;
}
  1. 界面展示
    make运行之前
    在这里插入图片描述
    make运行之后
    在这里插入图片描述
    补充:
    1.stat函数
    stat函数是用于获取文件信息,比如文件权限,文件类型信息等等。
    函数的声明:
    int stat(const char *pathname, struct stat *buf);
    参数说明:
    pathname:表示文件路径名
    buf:用于保存获取到的文件属性信息(这是一个传出参数)
    返回值说明:成功返回0,失败返回-1并设置errno
    2.mkdir函数
    mkdir函数用于创建一个新的目录。如果指定的目录已经存在,并且没有设置相应的标志来允许覆盖或忽略已存在的目录,则函数会失败;它允许用户为新创建的目录设置权限,这些权限决定了谁可以访问该目录。
    函数声明:
    int mkdir(const char * pathname , mode_t mode);
    参数说明:
    pathname(const char * ):指向以null结尾的字符串的指针,该字符串指定了要创建的目录的路径。路径可以是相对路径或绝对路径。
    mode(mode_t):指定新目录的权限。这些权限位使用八进制数表示(例如,0755),并且会受进程的文件模式创建掩码(umask)的影响。最终权限是请求权限与umask的补码的逻辑与结果。通常,mode参数包括文件所有者(user)、组(group)和其他人(other)的读(r)、写(w)和执行(x)权限的组合。
    返回值说明:成功时,返回0;失败时,返回-1,并设置全局变量errno以指示错误类型(如EACCES表示权限不足,EEXIST表示目录已存在等)。

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

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

相关文章

【HBZ分享】TCP连接完成后又是如何保证数据的可靠性传输

前提 发送发发送数据时&#xff0c;需要给出一个seq编号。第一个数据包的seq编号是一个随机数&#xff0c; 从第二个开始&#xff0c;seq编号就是【第一次的seq数据包大小】&#xff0c; 即接收方响应过来的期待数据包编号 ACK机制 接收方收到数据后&#xff0c;要给发送方回…

Html5前端基本知识整理与回顾下篇

今天我们继续结合发布的Html5基础知识点文档进行复习&#xff0c;希望对大家有所帮助。 目录 列表 无需列表 有序列表 自定义列表 样例 表格 基本属性 ​编辑 相关属性 Border Width Height ​编辑 表格标题 ​编辑 表格单元头 合并单元格 垂直单元格合并 水…

实践致知第12享:如何新建一个Word并设置格式

一、背景需求 小姑电话说&#xff1a;要新建一个Word文档&#xff0c;并将每段的首行设置空2格。 二、解决方案 1、在电脑桌面上空白地方&#xff0c;点击鼠标右键&#xff0c;在下拉的功能框中选择“DOC文档”或“DOCX文档”都可以&#xff0c;如下图所示。 之后&#xff0…

npm install失败,数据源过期

npm install时报错&#xff1a;“Unexpected token &#xff1c; in JSON at position 0 while parsing near ‘&#xff1c;!DOCTYPE html&#xff1e;” 执行Vue2项目安装时&#xff0c;出现报错了&#xff0c;显示ERROr: **npm ERR! Unexpected token < in JSON at posi…

58、基于径向基神经网络的曲线拟合(matlab)

1、基于径向基神经网络的曲线拟合简介及原理 1&#xff09;原理简介 基于径向基神经网络&#xff08;Radial Basis Function Neural Network, RBFNN&#xff09;的曲线拟合是一种常用的非线性拟合方法&#xff0c;通过在输入空间中使用径向基函数对数据进行处理&#xff0c;实…

cesium 雷达扫描

cesium 雷达扫描 (下面附有源码) 实现思路 1、通过改变圆型材质来实现效果, 2、用了模运算和步进函数(step)来创建一个重复的圆形图案 3、当纹理坐标st落在垂直或水平的中心线上时,该代码将改变透明度和颜色,以突出显示这些线 示例代码 <!DOCTYPE html> <ht…

完美解决windows开机时,系统提示此windows副本不是正版的正确解决方法,亲测有效!!!

完美解决windows开机时&#xff0c;系统提示此windows副本不是正版的正确解决方法&#xff0c;亲测有效&#xff01;&#xff01;&#xff01; 亲测有效 完美解决windows开机时&#xff0c;系统提示此windows副本不是正版的正确解决方法&#xff0c;亲测有效&#xff01;&#…

二分查找3

1. 有序数组中的单一元素&#xff08;540&#xff09; 题目描述&#xff1a; 算法原理&#xff1a; 二分查找解题关键就在于去找到数组的二段性&#xff0c;这里数组的二段性是从单个数字a开始出现然后分隔出来的&#xff0c;如果mid落入左半部分那么当mid为偶数时nums[mid1]…

来聊聊Redis持久化AOF管道通信的设计

写在文章开头 最近遇到很多烦心事&#xff0c;希望通过技术来得以放松&#xff0c;今天这篇文章笔者希望会通过源码的方式分析一下AOF如何通过Linux父子进程管道通信的方式保证进行AOF异步重写时还能实时接收用户处理的指令生成的AOF字符串&#xff0c;从而保证尽可能的可靠性…

window 安装 openssl

文章目录 前言window 安装 openssl1. 下载2. 安装3. 配置环境变量4. 测试 前言 如果您觉得有用的话&#xff0c;记得给博主点个赞&#xff0c;评论&#xff0c;收藏一键三连啊&#xff0c;写作不易啊^ _ ^。   而且听说点赞的人每天的运气都不会太差&#xff0c;实在白嫖的话…

LVS集群及其它的NAT模式

1.lvs集群作用&#xff1a;是linux的内核层面实现负载均衡的软件&#xff1b;将多个后端服务器组成一个高可用、高性能的服务器的集群&#xff0c;通过负载均衡的算法将客户端的请求分发到后端的服务器上&#xff0c;通过这种方式实现高可用和负载均衡。 2.集群和分布式&#…

Mattermost:一个强大的开源协作平台

Mattermost是一个强大的开源协作平台&#xff0c;基于云原生架构&#xff0c;为企业级用户提供安全、可扩展且自托管的消息传递解决方案。 一、平台特点 开源与定制性&#xff1a;Mattermost是一个开源项目&#xff0c;用户可以根据自身需求定制界面、添加功能或扩展其功能&am…

百川工作手机实现销售管理微信监控系统

在瞬息万变的商业战场中&#xff0c;每一分效率的提升都是企业制胜的关键。传统销售管理模式已难以满足现代企业对精准、高效、合规的迫切需求。今天&#xff0c;让我们一同探索如何利用工作手机这一创新工具&#xff0c;为您的销售团队装上智能翅膀&#xff0c;开启销售管理的…

计算云服务3

第三章 镜像服务 什么是镜像服务(IMS) 镜像服务(lmage ManagementService&#xff0c;IMS)提供镜像的生命周期管理能力。用户可以灵活地使用公共镜像、私有镜像或共享镜像申请弹性云服务器和裸金属服务器。同时&#xff0c;用户还能通过已有的云服务器或使用外部镜像文件创建…

【C++报错已解决】Invalid Use of ‘void’ Expression

&#x1f3ac; 鸽芷咕&#xff1a;个人主页 &#x1f525; 个人专栏: 《C干货基地》《粉丝福利》 ⛺️生活的理想&#xff0c;就是为了理想的生活! 文章目录 引言一、问题描述1.1 报错示例1.2 报错分析1.3 解决思路 二、解决方法2.1 方法一&#xff1a;调整函数返回类型方法二…

ArcGIS的智慧与情怀

初识ArcGIS 在这个信息化的时代&#xff0c;ArcGIS如同一位智者&#xff0c;静静地伫立在地理信息系统的巅峰。初识它时&#xff0c;我仿佛走进了一片未知的领域&#xff0c;心中充满了好奇与期待。ArcGIS&#xff0c;这款专业的地理信息系统软件&#xff0c;凭借其强大的功能…

【Mutilism NPN三极管驱动P-MOS】2022-4-2

缘由NPN三极管驱动P-MOS异常导通-硬件开发-CSDN问答 有电感性负载应该接反向吸收泻放二极管才能保证安全&#xff1b; 同时建议修改电路使得工作更安全可靠&#xff0c;取消下拉电阻R2&#xff0c;R3用小于100欧姆左右串联一个发光管&#xff0c;这样既可可靠工作也能观察IO输出…

Labview_Workers5.0 学习笔记

1.Local Request 个人理解该类型的请求针对自身的&#xff0c;由EHL或者MHL到该vi的MHL中。 使用快速放置快捷键"Ctrl9"创建方法如下&#xff1a; 创建后的API接口命名均为rql开头&#xff0c;并且在所选main.vi中的MHL创建对应的条件分支。 此时使用该API函数就…

activemq-CVE-2022-41678

Apache ActiveMQ Jolokia 后台远程代码执行漏洞 Apache ActiveMQ在5.16.5&#xff0c;5.17.3版本及以前&#xff0c;后台Jolokia存在一处任意文件写入导致的远程代码执行漏洞。 启动环境 admin/admin 方法一&#xff1a;利用poc 这个方法受到ActiveMQ版本的限制&#xff0c;因…