Linux--日志的模拟实现

一，引言

通过自己去实现一个日志来理解一些封装好的日志的实现原理。对于日志的实现主题上分为三大部分，首先是刷新工作 ，日志可以向显示屏刷新 或者向指定的文件刷新 ，其次是锁的概念，在多线程 中，日志是向显示屏或者文件，这里的文件或者显示屏都是公共资源 。需要对公共资源加锁。最后是日志的输出格式，日志需要以指定的格式进行打印输出。

二，锁的封装

在Linux环境下，可以通过封装原生系统接口来实现面向对象的编程范式。来提高代码的可维护性和复用性，首先第一步，实现锁的创建，上锁，解锁，销毁。如下：

cpp 复制代码

class Mutex
    {
    public:
        Mutex()
        {
            pthread_mutex_init(&_mutex, nullptr);
        }
        void Lock()
        {
            int n = pthread_mutex_lock(&_mutex);
            (void)n;
        }
        void Unlock()
        {
            int n = pthread_mutex_unlock(&_mutex);
            (void)n;
        }
        ~Mutex()
        {
            pthread_mutex_destroy(&_mutex);
        }
        pthread_mutex_t *Get()
        {
            return &_mutex;
        }
    private:
        pthread_mutex_t _mutex;
    };

之后对锁进一步封装，实现当对象创建表示上锁，对象销毁表示解锁。如下：

cpp 复制代码

 class LockGuard
    {
    public:
        LockGuard(Mutex &mutex):_mutex(mutex)
        {
            _mutex.Lock();
        }
        ~LockGuard()
        {
            _mutex.Unlock();
        }
    private:
        Mutex &_mutex;
    };

三，日志刷新机制

日志的刷新机制主要包括两个方面。向显示屏刷新 或者向指定文件刷新 ，也就是向显示屏写入；或者向指定文件进行写入。可以通过策略模式--也就是子类继承父类的方式，通过对父类实现虚函数，子类对具体的函数进行实现，来实现对显示屏或者指定文件的切换。向显示屏写入如下：

cpp 复制代码

class LogStrategy
    {
    public:
        ~LogStrategy() = default;
        virtual void SyncLog(const std::string &message) = 0;
    };

    // 显示器打印日志的策略 : 子类
    class ConsoleLogStrategy : public LogStrategy
    {
    public:
        ConsoleLogStrategy()
        {
        }
        void SyncLog(const std::string &message) override
        {
            LockGuard lockguard(_mutex);
            std::cout << message << gsep;
        }
        ~ConsoleLogStrategy()
        {
        }

    private:
        Mutex _mutex;
    };

向指定文件写入：

首先利用缺省参数，定义指定路径以及日志文件名称：引入C++17 中的文件操作，首先判断指定路径的目录是否存在，若不存在进行新建。其次对路径进行拼接：文件路径+文件名。最后以追加方式打开进行写入。具体代码如下：

cpp 复制代码

const std::string defaultpath = "./log";
    const std::string defaultfile = "my.log";
    class FileLogStrategy : public LogStrategy
    {
    public:
        FileLogStrategy(const std::string &path = defaultpath, const std::string &file = defaultfile)
            : _path(path),
              _file(file)
        {
            LockGuard lockguard(_mutex);
            if (std::filesystem::exists(_path))
            {
                return;
            }
            try
            {
                std::filesystem::create_directories(_path);
            }
            catch (const std::filesystem::filesystem_error &e)
            {
                std::cerr << e.what() << '\n';
            }
        }
        void SyncLog(const std::string &message) override
        {
            LockGuard lockguard(_mutex);

            std::string filename = _path + (_path.back() == '/' ? "" : "/") + _file; // "./log/" + "my.log"
            std::ofstream out(filename, std::ios::app);                              // 追加写入的 方式打开
            if (!out.is_open())
            {
                return;
            }
            out << message << gsep;
            out.close();
        }
        ~FileLogStrategy()
        {
        }

    private:
        std::string _path; // 日志文件所在路径
        std::string _file; // 日志文件本身
        Mutex _mutex;
    };

四，形成日志

首先确定刷新模式 ，是选择向显示屏刷新还是向指定文件，在进行刷新。之后创建内部类 ，这个类进行一条日志的构造。框架如下：

cpp 复制代码

class Logger
{
public:
    Logger()
    {
        EnableConsoleLogStrategy();
    }
    void EnableFileLogStrategy()
    {
        _fflush_strategy = std::make_unique<FileLogStrategy>();
    }
    void EnableConsoleLogStrategy()
    {
        _fflush_strategy = std::make_unique<ConsoleLogStrategy>();
    }

    class LogMessage
    {
    public:
        LogMessage(LogLevel& level, std::string& src_name, int line_number, Logger& logger)
            : _curr_time(GetTimeStamp()),
            _level(level),
            _pid(getpid()),
            _src_name(src_name),
            _line_number(line_number),
            _logger(logger)
        {
            // 日志的左边部分，合并起来
            std::stringstream ss;
            ss << "[" << _curr_time << "] "
                << "[" << Level2Str(_level) << "] "
                << "[" << _pid << "] "
                << "[" << _src_name << "] "
                << "[" << _line_number << "] "
                << "- ";
            _loginfo = ss.str();
        }


        ~LogMessage()
        {
            if (_logger._fflush_strategy)
            {
                _logger._fflush_strategy->SyncLog(_loginfo);
            }
        }

    private:
        std::string _curr_time;
        LogLevel _level;
        pid_t _pid;
        std::string _src_name;
        int _line_number;
        std::string _loginfo; // 合并之后，一条完整的信息
        Logger& _logger;
    };
    // 这里故意写成返回临时对象
    LogMessage operator()(LogLevel level, std::string name, int line)
    {
        return LogMessage(level, name, line, *this);
    }
    ~Logger()
    {
    }

private:
    std::unique_ptr<LogStrategy> _fflush_strategy;
};

解析图如下：

首先创建Logger logger的全局对象，通过logger.EnableFileLogStrategy() 。来改变日志的写入方式。之后logger()通过运算符重载 ，调用LogMessage对象，形成一条日志信息。operator()返回 LogMessage的临时对象 。最终通过**<<运算符重载**实现日志数据的可变写入。最后通过宏处理来减少参数输入。代码如下：

cpp 复制代码

#define LOG(level) logger(level, __FILE__, __LINE__)
#define Enable_Console_Log_Strategy() logger.EnableConsoleLogStrategy()
#define Enable_File_Log_Strategy() logger.EnableFileLogStrategy()