C++实现日志文件输出

万嘉福朱砂饰品有限公司

日志输出是每个软件都需要的模块，日志对于软件运行情况的跟踪，后期问题的排查，以及软件稳定性的提高有着举足轻重的作用。C++的日志开源库也有不少，像log4cplus算是比较有名的一个。一般的小型项目来说自己写一个日志库还是非常有必要的。日志库一般包含时间，代码行数的输出，日志文件管理(如一天一个日志)，日志类型等级(TRACE，DEBUG,INFO,WARN,ERROR,FATAL)，日志自动清理等等内容。
#pragma once
#include <string>
#include <thread>
#include <queue>
#include <mutex>
#include <vector>

#define LOGFOLDER "LOG_FILE"
#define LOGFILE_FREX "Log_"
#define LOGINS logtxt::GetMgr()

typedef enum
{
        LV_TRACE = 0x0000,        // 跟踪类型
        LV_DEBUG = 0x0001,        // 调试类型
        LV_INFO = 0x0002,        // 信息类型
        LV_WARN = 0x0003,        // 警告类型
        LV_ERROR = 0x0004,        // 错误类型
        LV_FATAL = 0x0005        // 致命类型
}LEVEL_E;

#define LOGOUT_TRACE(format,...) LOGINS->WriteLog(__FILE__,__LINE__,LV_TRACE,format,## __VA_ARGS__)
#define LOGOUT_DEBUG(format,...) LOGINS->WriteLog(__FILE__,__LINE__,LV_DEBUG,format,## __VA_ARGS__)
#define LOGOUT_INFO(format,...)  LOGINS->WriteLog(__FILE__,__LINE__,LV_INFO, format,## __VA_ARGS__)
#define LOGOUT_WARN(format,...)  LOGINS->WriteLog(__FILE__,__LINE__,LV_WARN, format,## __VA_ARGS__)
#define LOGOUT_ERROR(format,...) LOGINS->WriteLog(__FILE__,__LINE__,LV_ERROR,format,## __VA_ARGS__)
#define LOGOUT_FATAL(format,...) LOGINS->WriteLog(__FILE__,__LINE__,LV_FATAL,format,## __VA_ARGS__)

typedef std::function<void(std::string)> CallBack_Fun;

class logtxt
{
public:
        static logtxt* GetMgr();

        /**
        * @brief 简单概述
        * @brief 设置日志输出目录
        */
        void SetFolder(std::string path);

        /**
        * @brief 简单概述
        * @brief 设置日志保留的天数
        */
        void SetDateNum(int m) { m_idate = m; }

        /**
        * @brief 简单概述
        * @brief 检查文件夹是否存在，不存在则创建
        */
        void CreateFolder(std::string path);

        /**
        * @brief 简单概述
        * @brief 日志文件是否存在，不存在则创建
        */
        bool IsFileExis(std::string path);

        /**
        * @brief 简单概述
        * @brief 清理老的日志文件
        */
        void ClearOldLogFile();

        /**
        * @brief 简单概述
        * @brief 增加输出内容
        */
        void WriteLog(const char *p_lpFile, const  unsigned  long  lLine,const short type, const char* msg,...);

        /**
        * @brief 简单概述
        * @brief 设置回调函数
        */
        void SetBakFun(CallBack_Fun p) { m_pFun = p; }

private:
        logtxt();
        ~logtxt();

        bool WriteMsg(std::string msg);

        /**
        * @brief 简单概述
        * @brief 获取当前日志文件名
        */
        std::string GetTodayFileName(std::string folder);

        /**
        * @brief 简单概述
        * @brief 获取以前的日期文件
        */
        std::string GetClearFile(int);

        bool                        m_run;
        int                                m_idate;
        unsigned int        m_lasttime;
        CallBack_Fun        m_pFun;

        std::mutex                m_Mutex;
        std::string                m_FileName;
        std::string                m_FolderName;
        std::string                m_LogType[6];
};

#define _CRT_SECURE_NO_WARNINGS

#include "logtxt.h"
#include <fstream>
#include <iostream>
#include <stdio.h>
#include <io.h>
#include <direct.h>
#include <stdarg.h>

std::string GeneralCurTime(std::string format)
{
        time_t timep; time(&timep); char tmp[20];
        strftime(tmp, sizeof(tmp), format.c_str(), localtime(&timep));
        return tmp;
}

logtxt* logtxt::GetMgr()
{
        static logtxt s;
        return &s;
}

logtxt::~logtxt()
{
}

logtxt::logtxt()
{
        m_run = true;
        m_lasttime = 0;
        m_idate = 10;
        m_LogType[LV_TRACE] = "[TRACE]";
        m_LogType[LV_DEBUG] = "[DEBUG]";
        m_LogType[LV_INFO]  = "[INFO]";
        m_LogType[LV_WARN]  = "[WARN]";
        m_LogType[LV_ERROR] = "[ERROR]";
        m_LogType[LV_FATAL] = "[FATAL]";
        m_pFun = NULL;
}

/**
* @brief 简单概述
* @brief 设置日志输出目录
*/
void logtxt::SetFolder(std::string path)
{
        if(path.empty())
                path = LOGFOLDER;
        path.append("/");
        m_FolderName = path;
        CreateFolder(m_FolderName);
        IsFileExis(m_FolderName);
        ClearOldLogFile();
}

std::vector<std::string> SplitStr(std::string str, std::string pattern)
{
        std::string::size_type pos;
        std::vector<std::string> result;
        //扩展字符串以方便操作
        str += pattern;
        int size = str.size();
        for (int i = 0; i < size; i++)
        {
                pos = str.find(pattern, i);
                if (pos < size)
                {
                        std::string s = str.substr(i, pos - i);
                        result.push_back(s);
                        i = pos + pattern.size() - 1;
                }
        }
        return result;
}

/**
* @brief 简单概述
* @brief 检查文件夹是否存在，不存在则创建
*/
void logtxt::CreateFolder(std::string path)
{
        if (_access(path.c_str(), 0) == 0)
                return;

        std::vector<std::string> _vec = SplitStr(path, "/");
        std::string temp_path;
        for (auto itr = _vec.begin(); itr != _vec.end(); itr++)
        {
                temp_path.append(*itr).append("/");
                if (_access(temp_path.c_str(), 0) != 0)
                {
                        _mkdir(temp_path.c_str());
                }
        }
}

/**
* @brief 简单概述
* @brief 日志文件是否存在，不存在则创建
*/
bool logtxt::IsFileExis(std::string path)
{
        m_FileName = GetTodayFileName(path);
        if (_access(m_FileName.c_str(), 0) != 0)
        {
                std::fstream out;
                out.open(m_FileName.c_str(), std::ios_base::app);
                out.close();
                return false;
        }
        return true;
}

/**
* @brief 简单概述
* @brief 获取当前日志文件名
*/
std::string logtxt::GetTodayFileName(std::string folder)
{
        folder.append(LOGFILE_FREX).append(GeneralCurTime("%Y-%m-%d")).append(".LOG");
        return folder;
}

/**
* @brief 简单概述
* @brief 增加输出内容
*/
void logtxt::WriteLog(const char *p_lpFile, const  unsigned  long  lLine, const short type, const char * msg,...)
{
        m_Mutex.lock();
        IsFileExis(m_FolderName);
        char _time[30];
        snprintf(_time, sizeof(_time), " [%s] ", GeneralCurTime("%Y-%m-%d %H:%M:%S").c_str());
        std::string message = _time;
        std::string file = p_lpFile;
        int idx = file.find_last_of("\\") + 1;
        message.append(file.substr(idx, file.size()-idx));
        char line[10];
        snprintf(line,sizeof(line)," (%d) ", lLine);
        message.append(line);
        message.append(m_LogType[type]);
        message.append(":");

        va_list   vlist;
        va_start(vlist, msg);
        char buffer[1024 * 20] = {'\0'};
        vsnprintf(buffer, sizeof(buffer), msg, vlist);
        va_end(vlist);

        message.append(buffer);
        std::cout << message << std::endl;
        this->WriteMsg(message);

        if (m_pFun != NULL && (type == LV_ERROR || type == LV_FATAL || type == LV_DEBUG))
                m_pFun(message);

        time_t _tm;
        time(&_tm);
        localtime(&_tm);
        unsigned int tm = _tm - m_lasttime;

        // 6个小时检查一下是否需要清理文件.
        if (_tm - m_lasttime > 21600/*6*60*60*/)
        {
                if (m_lasttime <= 0)
                        m_lasttime = _tm;
                else
                {
                        ClearOldLogFile();
                        m_lasttime = _tm;
                        this->WriteMsg("--------------------------------clear old log file.");
                }
        }
        m_Mutex.unlock();
}

bool logtxt::WriteMsg(std::string msg)
{
        std::ofstream out;
        out.open(m_FileName, std::ios::app);
        if (out)
        {
                out << msg << std::endl;
                out.close();
                return true;
        }
        else
        {
                out.close();
                return false;
        }
}

/**
* @brief 简单概述
* @brief 获取以前的日期文件
*/
std::string logtxt::GetClearFile(int m)
{
        char _time[12];
        time_t tt;time(&tt);
        tt -= m * 86400/*24 * 60 * 60*/;
        struct tm *_tm;
        _tm = localtime(&tt);
        strftime(_time, 64, "%Y-%m-%d", _tm);
        std::string s = LOGFILE_FREX + std::string(_time) + ".LOG";
        return s;
}

/**
* @brief 简单概述
* @brief 清理老的日志文件
*/
void logtxt::ClearOldLogFile()
{
        _finddata_t file_info;
        std::string current_path = m_FolderName + "*.LOG";
        long long handle = _findfirst(current_path.c_str(), &file_info);
        if (-1 != handle)
        {
                std::string datetime = GetClearFile(m_idate);
                std::vector<std::string> vec_path;
                do
                {
                        if (file_info.attrib != _A_SUBDIR)
                        {
                                std::string filename = file_info.name;
                                if (filename < datetime)
                                {
                                        // 记录删除的文件路径
                                        std::string abspath = m_FolderName + filename;
                                        vec_path.push_back(abspath);
                                }
                        }
                } while (!_findnext(handle, &file_info));                                                                  
                _findclose(handle);
                for (auto itr = vec_path.begin(); itr != vec_path.end(); itr++)
                {
                        std::string path = *itr;
                        if (remove(path.c_str()) != 0)
                        {
                                LOGOUT_ERROR("delete log file fail.file path:%s.", itr->c_str());
                        }
                }
        }
}

山中物多

支持你哈...................................