架構設計 - 日志管理接口設計

在后端代碼中，日志無處不在，設計一套自己的日志管理代碼，給框架提供一套好用的日志接口將大大方便代碼的開發。

其中在日志管理代碼的編寫中，主要有以下難點：

 

1.數目不確定的入參函數編寫

2.日志權限控制

3.日志輸出形式。

 

接口設計：

1.提供三類日志打印形式：1）控制台打印信息，類似printf的接口封裝

　　　　　　　　　　　　2）函數追蹤接口，打印當前代碼的文件名，函數名及行，以及一些設定的輸出參數

　　　　　　　　　　　　3）日志打印函數，提供打印級別控制，且打印內容輸出到日志文件中

2.提供日志級別控制：1）在打印日志時提供當前日志級別，代碼依據級別進行控制打印

　　　　　　　　　　2）日志打印級別控制暫時使用配置文件，后續可以通過通信接口進行實時修改

 

下面附上代碼實現：DMLogManager.h

//=============================================================================
/* 
*  File: DMLogManager.h
*
*  Author: bing
*
*  Date: 2016-09-07
*
*  Version: v2.0
*
*  Github/Mail: https://github.com/binchen-china    <[e-mail]>
*
*  Note:
*/
//=============================================================================

#pragma once
#include "DMaker.h"

enum LOG_LEVEL
{
    DM_ERROR = 0x0001,
    DM_WARNING  = 0x0010,
    DM_INFO = 0x0100,
    DM_DEBUG = 0x1000
};

class DMLogManager
{
public:
    DMLogManager();
    
    ~DMLogManager();

    void print_log(const DM_CHAR* fmt, ...);
   
    void trace_log(string file, string func, DM_INT line, const DM_CHAR* fmt, ...);
          
    void write_log(DM_INT log_level, string file, string func, DM_INT line, const DM_CHAR* fmt, ...);
    
private:
    void init();

    void get_log_config();
    
    inline void open_log_file();
    
    inline void close_log_file();
    
    void set_log_level();

private:
    FILE* _log_file;
    string _log_name;
    string _log_level;
    DM_INT _log_mask;
};

typedef ACE_Singleton<DMLogManager, ACE_Thread_Mutex> DMLogMgr;

//console output without code info
#define DM_PRINT(LOG_FMT,args...) DMLogMgr::instance()->print_log(LOG_FMT,##args)
//console output with code info
#define DM_TRACE(LOG_FMT,args...) DMLogMgr::instance()->trace_log(__FILE__,__FUNCTION__,__LINE__,LOG_FMT,##args)
//write logs into log file
#define DM_LOG(LOG_LEVEL,LOG_FMT,args...) DMLogMgr::instance()->write_log(LOG_LEVEL,__FILE__,__FUNCTION__,__LINE__,LOG_FMT,##args)

 

DMLogManager.cpp

#include "DMLogManager.h"

DMLogManager::DMLogManager():_log_mask(0)
{
    init();
}

DMLogManager::~DMLogManager()
{
    
}

void DMLogManager::init()
{
    get_log_config(); 
    set_log_level();
}

void DMLogManager::get_log_config()
{
    _log_name = DMJsonCfg::instance()->GetItemString("service_info", "service_name");
    _log_level = DMJsonCfg::instance()->GetItemString("service_info", "log_level");
    _log_name.append(".log");
}

inline  void DMLogManager::open_log_file()
{
    _log_file = fopen(_log_name.c_str(), "a");
    if (nullptr == _log_file)
    {    
        return;
    }    
}

inline  void DMLogManager::close_log_file()
{
    fclose(_log_file);
}

void DMLogManager::set_log_level()
{
    if ("DEBUG" == _log_level)
    {
        _log_mask = 0x1111;
    }
    else if ("INFO" == _log_level)
    {
        _log_mask = 0x0111;
    }
    else if ("WARNING" == _log_level)
    {
        _log_mask = 0x0011;
    }
    else if ("ERROR" == _log_level)
    {
        _log_mask = 0x0001;
    }
}

void DMLogManager::print_log(const DM_CHAR* fmt, ...)
{
    va_list ap;
    va_start(ap, fmt);
               
    string log_info = fmt;     
    ACE_OS::vfprintf(stdout, fmt, ap);  

    va_end (ap);
}

void DMLogManager::trace_log(string file, string func, DM_INT line, const DM_CHAR* fmt, ...)
{
    va_list ap;
    va_start(ap, fmt);
               
    ACE_OS::printf("[DM_TRACE][%s][%s][%d]:",file.c_str(), func.c_str(), line);               
    string log_info = fmt;     
    ACE_OS::vfprintf(stdout, fmt, ap);  

    va_end (ap);
}

void DMLogManager::write_log(DM_INT log_level, string file, string func, DM_INT line, const DM_CHAR* fmt, ...)
{
    va_list ap;
    va_start(ap, fmt);
    
    open_log_file();
    
    switch (log_level)
    {
        case DM_DEBUG:
        {
            if (DM_DEBUG & _log_mask)
            {               
                ACE_OS::fprintf(_log_file, "[DM_DEBUG][%s][%s][%d]:",file.c_str(), func.c_str(), line);                 
                ACE_OS::vfprintf(_log_file, fmt, ap);  
            }            
            break;
        }
        case DM_INFO:
        {
            if (DM_INFO & _log_mask)
            {
                ACE_OS::fprintf(_log_file, "[DM_INFO][%s][%s][%d]:",file.c_str(), func.c_str(), line);                  
                ACE_OS::vfprintf(_log_file, fmt, ap);  
            }
            break;
        }
        case DM_WARNING:
        {
            if (DM_WARNING & _log_mask)
            {
                ACE_OS::fprintf(_log_file, "[DM_WARNING][%s][%s][%d]:",file.c_str(), func.c_str(), line);                 
                ACE_OS::vfprintf(_log_file, fmt, ap);  
            }
            break;
        }
        case DM_ERROR:
        {
            if (DM_ERROR & _log_mask)
            {
                ACE_OS::fprintf(_log_file, "[DM_ERROR][%s][%s][%d]:",file.c_str(), func.c_str(), line);                 
                ACE_OS::vfprintf(_log_file, fmt, ap);       
            }
            break;
        }
    }
    
    close_log_file();
    va_end (ap);
}

 

更多技術信息請關注github：https://github.com/binchen-china