一、日志库的特点
该项目是基于C++实现的简单日志库系统,代码方面大约200多行,比较简单,封装的接口很容易看懂,使用起来也十分方便,通过定义的宏来实现打印输出到日志文件中。
二、日志库的需求
- 日志库的存储:文本文件。
- 日志存储的内容:时间、日志级别、文件名、行号、日志内容。
- 日志级别:debug<info<warn<erro<fatal。
- 日志翻滚:通过设置日志文件最大可以存储内容的字节,若文件存储超过当前最大字节数,则重新创建一个新的日志文件用来存储日志内容。
三、日志库的实现
该日志库使用了单例模式来创建日志库对象,从而调用接口,如下是单例模式的代码:
//创建Logger对象
Logger *Logger::getInstance()
{
if(m_instance==nullptr)
{
std::mutex mtx;
mtx.lock();
m_instance=new Logger();
mtx.unlock();
}
return m_instance;
}
日志打印的接口是该日志库的重要部分,如下是日志打印的代码:
/**
* @brief:打印日志
* @param:参数一:日志级别,参数二:打印日志的的文件名,参数三:打印日志所在的行号,参数四:打印格式,参数5:C++中的不定参数
*/
void Logger::log(Level level,const char *fileName,int line,const char *format,...)
{
//过滤低级别日志
if(levels>level)
{
return;
}
if (m_fout.fail())
{
throw std::logic_error("open file failed "+m_fileName);
}
//获取当前时间戳
auto timeTicks=time(nullptr);
//将当前时间戳转化为时间结构体
auto ptns=localtime(&timeTicks);
//存储格式化后的时间
char timeArray[32];
//初始化字符数组
memset(timeArray,0,sizeof(timeArray));
//格式化时间结构体
strftime(timeArray,sizeof(timeArray),"[%Y-%m-%d %H:%M:%S]",ptns);
//日志格式化的结果(日期 日志级别 日志打印位置:日志打印的行号位置)
const char *fmt="%s %s %s:%d ";
//获取格式化后的字符串长度
int size=snprintf(nullptr,0,fmt,timeArray,m_Level[level],fileName,line);
if(size>0)
{
char *buffer=new char[size+1];
memset(buffer,0,size+1);
snprintf(buffer,size+1,fmt,timeArray,m_Level[level],fileName,line);
std::cout<<buffer<<std::endl;
//将字符串写入日志中
m_fout<<buffer;
m_len+=size;
delete []buffer;
}
//获取写入日志内容
va_list arg_ptr;
va_start(arg_ptr,format);
size=vsnprintf(nullptr,0,format,arg_ptr);
va_end(arg_ptr);
if(size>0)
{
char *content=new char[size+1];
va_start(arg_ptr,format);
vsnprintf(content,size+1,format,arg_ptr);
va_end(arg_ptr);
std::cout<<content<<std::endl;
m_fout<<content;
m_len+=size;
delete []content;
}
m_fout<<"\n";
//刷新文件内容
m_fout.flush();
if(m_len>=m_max && m_max>0)
{
rotate();
}
//std::cout<<timeArray<<std::endl;
}
首先是通过C语言中的time()获取当前时间戳,然后再将其存放到时间结构体中,然后创建一个字符数组存放当前时间,最后将当前时间格式化存放到时间字符串的数组中。日志打印方面是通过snprintf和vsnprintf实现的,具体可看代码。
snprintf和vsprintf的区别是:snprintf发送格式化输出到指定数组。格式化用法与 printf一致,相当于把 printf输出的内容放入指定数组中。而vsnprintf使用不确定参数的方式封装,可直接输入数组和未知的参数。从而精简 sprintf需要先创建数组再传入参数的操作。
最后是实现宏打印的方式来写日志,因为直接调用log()方法很麻烦,如下是两者的对比:
//Log打印
Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,"hello Sakura");
//宏打印
debug("hello Sakura");
由此可看出宏打印的效率高,如下是宏打印的实现:
//定义debug打印,参数一是打印格式,参数二是不定参数
#define debug(format,...) \
Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,format,##__VA_ARGS__);
//定义info打印,参数一是打印格式,参数二是不定参数
#define info(format,...) \
Logger::getInstance()->log(Logger::INFO,__FILE__,__LINE__,format,##__VA_ARGS__);
//定义warn打印,参数一是打印格式,参数二是不定参数
#define warn(format,...) \
Logger::getInstance()->log(Logger::WARN,__FILE__,__LINE__,format,##__VA_ARGS__);
//定义erro打印,参数一是打印格式,参数二是不定参数
#define erro(format,...) \
Logger::getInstance()->log(Logger::ERRO,__FILE__,__LINE__,format,##__VA_ARGS__);
//定义fatal打印,参数一是打印格式,参数二是不定参数
#define fatal(format,...) \
Logger::getInstance()->log(Logger::FATAL,__FILE__,__LINE__,format,##__VA_ARGS__);
通过上面的代码可知,宏打印首先是通过定义一个宏的名称来实现,里面的参数是打印格式和不定参数,类似于C语言的printf和C++20的std::format格式化打印。然后是通过调用log()方法,向log()方法传入参数。
//__FILE__是指正在编译文件的文件名,__LINE__指正在编译文件的行号。
//fomat是指打印的格式,##__VA_ARGS__是指不定参数
。
四、日志库的完整代码
Logger.h如下:
#ifndef LOGGER_H
#define LOGGER_H
#include<string>
#include<fstream>
namespace Sakura
{
namespace Logger{
#define debug(format,...) \
Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,format,##__VA_ARGS__);
#define info(format,...) \
Logger::getInstance()->log(Logger::INFO,__FILE__,__LINE__,format,##__VA_ARGS__);
#define warn(format,...) \
Logger::getInstance()->log(Logger::WARN,__FILE__,__LINE__,format,##__VA_ARGS__);
#define erro(format,...) \
Logger::getInstance()->log(Logger::ERRO,__FILE__,__LINE__,format,##__VA_ARGS__);
#define fatal(format,...) \
Logger::getInstance()->log(Logger::FATAL,__FILE__,__LINE__,format,##__VA_ARGS__);
class Logger{
public:
//日志级别
enum Level
{
DEBUG=0,
INFO,
WARN,
ERRO,
FATAL,
LEVEL_COUNT //记录日志级别个数
};
//打开并创建日志文件
void open(const std::string &fileName);
//关闭文件
void close();
//创建Logger对象
static Logger *getInstance();
//打印日志
void log(Level level,const char *fileName,int line,const char *format,...);
//设置日志级别
void setLevel(Level level)
{
levels=level;
}
//设置日志文件最大字节长度
void setMax(int bytes)
{
m_max=bytes;
}
//日志翻滚
void rotate();
private:
Logger();
~Logger();
private:
//保存日志文件所在位置
std::string m_fileName;
//文件输出流对象
std::fstream m_fout;
//存放日志级别
static const char *m_Level[LEVEL_COUNT];
//单例对象
static Logger*m_instance;
//当前日志级别(用于过滤低级别日志内容)
Level levels;
//日志文件存放的最大字节数长度
int m_max;
//日志文件当前字节数长度
int m_len;
};
}
}
#endif //LOGGER_H
Logger.cpp如下:
#include"Logger.h"
#include<stdexcept>
#include<iostream>
#include<stdarg.h>
#include<string.h>
#include<time.h>
#include<mutex>
using namespace Sakura::Logger;
Logger * Logger::m_instance=nullptr;
const char * Logger::m_Level[LEVEL_COUNT]={
"DEBUG",
"INFO",
"WARN",
"ERRO",
"FATAL"
};
Logger::Logger() : m_len(0),m_max(0),levels(DEBUG)
{
}
Logger::~Logger()
{
close();
}
//打开并创建日志文件
void Logger::open(const std::string &fileName)
{
m_fileName=fileName;
m_fout.open(fileName,std::ios::app);
if(m_fout.fail())
{
throw std::logic_error("open file failed "+fileName);
}
//从日志文件开始读到最后
m_fout.seekp(0,std::ios::end);
//读取到当前文件内容所在位置
m_len=m_fout.tellp();
}
//关闭文件
void Logger::close()
{
m_fout.close();
}
//创建Logger对象
Logger *Logger::getInstance()
{
if(m_instance==nullptr)
{
std::mutex mtx;
mtx.lock();
m_instance=new Logger();
mtx.unlock();
}
return m_instance;
}
/**
* @brief:打印日志
* @param:参数一:日志级别,参数二:打印日志的的文件名,参数三:打印日志所在的行号,参数四:打印格式,参数5:C++中的不定参数
*/
void Logger::log(Level level,const char *fileName,int line,const char *format,...)
{
//过滤低级别日志
if(levels>level)
{
return;
}
if (m_fout.fail())
{
throw std::logic_error("open file failed "+m_fileName);
}
//获取当前时间戳
auto timeTicks=time(nullptr);
//将当前时间戳转化为时间结构体
auto ptns=localtime(&timeTicks);
//存储格式化后的时间
char timeArray[32];
//初始化字符数组
memset(timeArray,0,sizeof(timeArray));
//格式化时间结构体
strftime(timeArray,sizeof(timeArray),"[%Y-%m-%d %H:%M:%S]",ptns);
//日志格式化的结果(日期 日志级别 日志打印位置:日志打印的行号位置)
const char *fmt="%s %s %s:%d ";
//获取格式化后的字符串长度
int size=snprintf(nullptr,0,fmt,timeArray,m_Level[level],fileName,line);
if(size>0)
{
char *buffer=new char[size+1];
memset(buffer,0,size+1);
snprintf(buffer,size+1,fmt,timeArray,m_Level[level],fileName,line);
std::cout<<buffer<<std::endl;
//将字符串写入日志中
m_fout<<buffer;
m_len+=size;
delete []buffer;
}
//获取写入日志内容
va_list arg_ptr;
va_start(arg_ptr,format);
size=vsnprintf(nullptr,0,format,arg_ptr);
va_end(arg_ptr);
if(size>0)
{
char *content=new char[size+1];
va_start(arg_ptr,format);
vsnprintf(content,size+1,format,arg_ptr);
va_end(arg_ptr);
std::cout<<content<<std::endl;
m_fout<<content;
m_len+=size;
delete []content;
}
m_fout<<"\n";
//刷新文件内容
m_fout.flush();
if(m_len>=m_max && m_max>0)
{
rotate();
}
//std::cout<<timeArray<<std::endl;
}
//日志翻滚
void Logger::rotate()
{
close();
//获取当前时间戳
auto timeTicks=time(nullptr);
//将当前时间戳转化为时间结构体
auto ptns=localtime(&timeTicks);
//存储格式化后的时间
char timeArray[32];
//初始化字符数组
memset(timeArray,0,sizeof(timeArray));
//格式化时间结构体
strftime(timeArray,sizeof(timeArray),".%Y-%m-%d_%H-%M-%S",ptns);
std::string fileName=m_fileName+timeArray;
if(rename(m_fileName.c_str(),fileName.c_str())!=0)
{
return;
}
open(m_fileName);
}
main.cpp如下:
#include<iostream>
#include"Logger/Logger.h"
#include"Logger/Logger.cpp"
using namespace Sakura::Logger;
int main()
{
//std::cout<<"hello Sakura"<<std::endl;
Logger::getInstance()->open("./test.log");
Logger::getInstance()->setMax(1024);
//Logger::getInstance()->setLevel(Logger::INFO);
//Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,"hello Sakura");
//Logger::getInstance()->log(Logger::DEBUG,__FILE__,__LINE__,"name is %s,age is %d","旋涡鸣人",18);
debug("hello Sakura");
debug("name is %s,age is %d","旋涡鸣人",18);
info("info message");
warn("warn message");
erro("erro message");
fatal("fatal message");
return 0;
}
测试的结果:
日志文件内容: