【C++】日志实现

       🔥🔥 欢迎来到小林的博客！！
      🛰️博客主页：✈️林 子
      🛰️博客专栏：✈️ C++之路
      🛰️社区 :✈️ 进步学堂
      🛰️欢迎关注：👍点赞🙌收藏✍️留言

前言

想必大家都知道日志这个东西，在实际开发中，日志是必不可少的。因为我们可以通过日志来直观的观察到程序的状态，也可以用日志对程序进行调试。而日志的实现其实并不困难，但它又是必不可少的东西，所以今天我们就来实现一个简单的日志函数。

日志的实现

首先我们要确定日志的显示效果，一般来说这样即可：

[日志等级] [发生的时间] [文件名] [行数] ：出错信息

1.确定日志等级

我们可以用宏定义来确定日志等级，这里我们分成四个日志等级。

0. DEBUG 调试 ， 一般用于输出调试信息

1. NORMAL 正常，一般用于输出正常的情况

2. WARING 警告，不建议的操作

3. ERROR 错误，结果不符合预期

4. FATAL 致命，程序崩溃

#define DEBUG 0
#define NORMAL 1
#define WARING 2
#define ERROR 3
#define FATAL 4

const char* LevelMap[]
{
    "DEBUG",
    "NORMAL",
    "WARING",
    "ERROR",
    "FATAL"
};

这样我们就可以根据日志等级值对应LevelMap数组的下标来打印错误。

2. 输出日志的时间

日志一般打印的是当时的时间，那么如何获取当时的时间呢？

time函数会返回一个time_t的值，而这个值是一个时间戳，我们可以利用localtime函数来对时间戳进行解析。最好会返回一个tm的结构体指针。

struct tm *localtime(const time_t *timep);

tm结构体的内容

struct tm {
    int tm_sec;         /* seconds */
    int tm_min;         /* minutes */
    int tm_hour;        /* hours */
    int tm_mday;        /* day of the month */
    int tm_mon;         /* month */
    int tm_year;        /* year */
    int tm_wday;        /* day of the week */
    int tm_yday;        /* day in the year */
    int tm_isdst;       /* daylight saving time */
};

其中我们只需要tm_year，tm_mon,tm_mday，tm_hour,tm_min,tm_sec 就可以分别表示年，月，日，时，分秒。 这里的年指的是从1900年到现在的年数，所以计算当前时间我们需要再加上1900，这里的月是从0开始的，也就是0-11。所以月数我们也要加上1。

#include <time.h>
void logMessage(int level,const char* fomat...)
{
    time_t stamp = time(nullptr); //获取当前时间戳
    struct tm* ltime = localtime(&stamp); //将时间戳转换为ltime的结构体
    int year = ltime->tm_year + 1900;
    int mon = ltime->tm_mon + 1; 
    int day = ltime->tm_mday; 
    int hour = ltime->tm_hour;
    int min = ltime->tm_min;
    int sec = ltime->tm_sec;
    printf("%d-%d-%d %d:%d:%d\n",year,mon,day,hour,min,sec);
}

3.文件名&行数

C语言有一个__FILE__的宏，可以直接获取文件名。

而行数也是一样的，有一个__LINE__的宏获取行数。

__FILE__ 获取文件名
__LINE__ 获取行数

4.提取格式

假如我想

char* str = "我今年";
int age = 18;
logMessage(DEBUG,“%s,%d”,str,18); 

这样调用函数，那么我们函数创建时的参数需要传一个level等级，还需要const char* fomat…一个自定义格式的可变参数。

那么我们需要按格式提取，我们先创建一个va_list指针，va_list是一个指向函数参数的指针。然后用到va_start函数，它负责初始化va_list，并提取初始化列表的值，va_start需要传入第二个参数，第二个参数是一般是初始化列表前面的那个参数，因为可以通过这个参数定位到初始化列表的第一个值。然后用vsnprintf函数把格数按字符串的方式提取到缓冲区。最后va_end结束。

具体四件套用法：

#include <stdarg.h>
void _logMessage(int level,int line,const char* filename,const char* format...)
{
    char logbuff[1024] = {0} ; //存放内容的缓冲区
    va_list args;  //指向参数的指针
    va_start(args,format); //通过format找到初始化列表
    vsnprintf(logbuff,sizeof logbuff,format,args);  //把foamt所有的参数写入到logbuff中
    va_end(args);  //关闭args
}

完整代码

最后的fprintf可以指定往打开的文件里写，而stdout对应的文件是标准输出，所以会打印到显示器。而因为行数和文件名是需要传参给logMessage的，因为未来这个函数一定是在外部调用。如果在函数内部使用__LINE__或者__FILE__那么行数和文件名都只和logMessage对应，而不是和外部调用的函数对应。

#pragma once 
#include <iostream>
#include <string>
#include <time.h>
#include <stdarg.h>

#define DEBUG 0
#define NORMAL 1
#define WARING 2
#define ERROR 3
#define FATAL 4

const char* LevelMap[]
{
    "DEBUG",
    "NORMAL",
    "WARING",
    "ERROR",
    "FATAL"
};

#define logMessage(level,format,...) _logMessage(level,__LINE__,__FILE__,format,##__VA_ARGS__) 

void _logMessage(int level,int line,const char* filename,const char* format...)
{
    char stdbuff[1024] = {0}; //提取前半部分的缓冲区
    time_t stamp = time(nullptr); //获取当前时间戳
    struct tm* ltime = localtime(&stamp); //将时间戳转换为ltime的结构体
    int year = ltime->tm_year + 1900;
    int mon = ltime->tm_mon + 1; 
    int day = ltime->tm_mday; 
    int hour = ltime->tm_hour;
    int min = ltime->tm_min;
    int sec = ltime->tm_sec;
    snprintf(stdbuff,sizeof stdbuff,"[%s][%d-%d-%d %d:%d:%d][%s][%d]",LevelMap[level],year,mon,day,hour,min,sec,filename,line);

    char argsbuff[1024] = {0}; //提取用户自定义消息的缓冲区
    va_list args;
    va_start(args,format); 
    vsnprintf(argsbuff,sizeof argsbuff,format,args); 
    va_end(args);
    fprintf(stdout,"%s : %s\n",stdbuff,argsbuff); //stdout往显示器上打印，也可以往文件中写入
}

当然，如果你想屏蔽掉某些信息，或者只打印某些信息，你可以这样在函数开头这样子做：

if(level != DEBUG) return; //只打印调试信息
if(level < ERROR ) return; //只打印错误和致命信息
......

我们设置为只打印错误和致命消息，分别打印每种日志等级测试。

我们最终发现只打印错误和致命日志级别的信息