c++实战篇(二)——基于自旋锁实现的日志服务模块

前言

日志模块一直是服务端开发比较重要的部分,而在实际应用中向日志中进行写入的操作往往不是单线/进程的，而在多进/线程中如何实现对共享资源的保护，就成了一个比较重要的问题,而在实际开发中我们常常会利用锁机制来实现对共享内存的保护，而今天我们所要介绍的就是基于自旋锁实现的日志系统模块。

自旋锁的实现以及选择自旋锁的原因

对于什么是自旋锁，博主在上一篇文章中已经有过介绍，这里就不做赘述了，如果大家有兴趣的话可以去看看我的那篇文章:
C++实战篇（一）------自旋锁的使用

今天由于需求，我对代码进行了重写，代码如下；

cpp 复制代码

class spinlock_mutex  //自旋鎖
{
private:
    atomic_flag flag;

    spinlock_mutex(const spinlock_mutex&) = delete;
    spinlock_mutex& operator=(const spinlock_mutex) = delete;
public:
    spinlock_mutex() 
    {
        flag.clear();
    }
    void lock()           // 加锁。
    {
        while (flag.test_and_set()) //判断是否可以获取到锁
            ;
    }
    void unlock()      // 解锁。
    {
        flag.clear();
    }
};

至于为什么我们在日志系统里面会选用自旋锁而不是使用互斥锁,主要我们可以分析一下，在日志模块中，什么是核心需要，是IO操作，而每一次的IO操作的时间其实很短，使用互斥锁需要对阻塞的线/进程频繁的唤醒与阻塞，造成资源的不必要浪费，所以这里我们选择采用自旋锁来加锁比较合适。

日志模块的实现

头文件部分(test.h)

cpp 复制代码

#include "_cmpublic.h"
#include "_public.h"
#include <thread>

using namespace std;
using namespace idc;

class spinlock_mutex  //自旋鎖
{
private:
    atomic_flag flag;

    spinlock_mutex(const spinlock_mutex&) = delete;
    spinlock_mutex& operator=(const spinlock_mutex) = delete;
public:
    spinlock_mutex() 
    {
        flag.clear();
    }
    void lock()           // 加锁。
    {
        while (flag.test_and_set())
            ;
    }
    void unlock()      // 解锁。
    {
        flag.clear();
    }
};

class clogfile
{
private:
    ofstream fout; //日志文件的操作类
    string m_filename; //日志文件名
    ios::openmode m_mode; //文件的打开方式
    int m_maxsize; // 单个日志文件的最大大小，超过该值就切换日志
    bool m_enbuff; //是否启用缓冲
    bool m_backup; //是否自动切换日志
    spinlock_mutex m_lock; //自旋锁

public:
    clogfile(int maxsize=100){m_maxsize=maxsize;}
    bool open(const string& filename,ios::openmode mode=ios::app,const bool enbuff=false,const bool back_up=true);
    template <typename ...Args>
    bool write(const char* fmt,Args... args)
    {
        if (!fout.is_open())
        {
            return false;
        }
        back_up(); //查看是否要进行换页操作
        m_lock.lock();
        fout<<ltime1()<<" "<<sformat(fmt,args...)<<endl; //输入时间以及日志内容
        m_lock.unlock();
        return fout.good();
    }

    template <typename T>
    clogfile& operator<<(const T& value)
    {
        m_lock.lock();
        fout<<value;
        m_lock.unlock();
        return *this;
    }

    void close(){fout.close();}
    ~clogfile(){close();}

private:
    bool back_up();
};

main函数及相关函数的实现

cpp 复制代码

#include "test.h"

using namespace std;
using namespace idc;

clogfile logfile;      // 创建日志对象。

void func()
{
    for (int ii=0;ii<50;ii++)
    {
        logfile.write("第%d个超女开始表演...",ii);     // 表演前，写一行日志，...表示正在表演中。
        logfile << "ok.\n";                                          // 表演完成后，写入ok。
    }
}

int main()
{
    thread t1(func);
    thread t2(func);

    // 打开日志文件。
    if (logfile.open("/tmp/log/demo42.log",ios::app,false)==false)
    {
        printf("logfile.open(/tmp/log/demo42.log) failed.\n");  return -1;
    }

    logfile.write("程序开始运行。\n");
    t1.join();
    t2.join();
    logfile.write("程序运行结束。\n");
}


bool clogfile::open(const string& filename,ios::openmode mode,const bool enbuff,const bool back_up)
{
    if (!fout.is_open())
    {
        fout.close();
    }
    m_filename=filename;
    m_mode=mode;
    m_backup=back_up;
    m_enbuff=enbuff;

    newdir(m_filename,true);
    fout.open(m_filename,m_mode);
    if(enbuff==false)
    {
        fout<<unitbuf;
    }
    return fout.is_open();
}

bool clogfile::back_up()
{
    if(m_backup==false)
    {
        return true;
    }
    if(!fout.is_open())
    {
        return false;
    }
    if(fout.tellp()>m_maxsize*1024*1024)
    {
        m_lock.lock();
        fout.close();
        string ffilename=m_filename+ltime1();
        rename(m_filename.c_str(),ffilename.c_str());
        fout.open(m_filename,m_mode);
        if(m_enbuff==false)
        {
            fout<<unitbuf;
        }
        m_lock.unlock();
    }
    return true;
}

makefile：

shell 复制代码

all: test

test: test.cpp 
	g++ -pthread -o test test.cpp _public.cpp -std=c++11

clean:
	rm -f test

补充：

这里的命名空间namespace idc以及_public.h和_public.cpp是博主自己封装的工具库，不便公开，这里只展示与上述代码相关的部分：

newdir函数

cpp 复制代码

 bool newdir(const string &pathfilename, const bool bisfilename)
    {
        if (pathfilename.empty())
        {
            return false;
        }
        int pos = 1;
        while (true)
        {
            int pos1 = pathfilename.find('/', pos);
            if (pos1 == string::npos)
            {
                break;
            }
            pos = pos1 + 1;
            string dir = pathfilename.substr(0, pos1);
            if (access(dir.c_str(), F_OK) == -1)
            {
                if (mkdir(dir.c_str(), 0777) == -1)
                {
                    return false;
                }
            }
        }
        if (bisfilename == false)
        {
            if (access(pathfilename.c_str(), 0) == -1)
            {
                if (mkdir(pathfilename.c_str(), 0755) == -1)
                {
                    return false;
                }
            }
        }
        return true;
    }
    bool renamefile(const string &oldfilename, const string &newfilename)
    {
        if (access(oldfilename.c_str(), 0) == -1)
            return false;
        if (newdir(newfilename, true) == false)
        {
            return false;
        }
        if (rename(oldfilename.c_str(), newfilename.c_str()) == -1)
        {
            return false;
        }
        return true;
    }

sformat函数，用于格式化输出

cpp 复制代码

template <typename... Args>
    string sformat(const char *fmt, Args... args)
    {
        string str;

        int len = snprintf(nullptr, 0, fmt, args...); // 得到格式化后字符串的长度。
        if (len < 0)
            return str; // 如果调用snprintf失败，返回-1。
        if (len == 0)
            return str; // 如果调用snprintf返回0，表示格式化输出的内容为空。;

        str.resize(len);                          // 为string分配内存。
        snprintf(&str[0], len + 1, fmt, args...); // linux平台第二个参数是len+1，windows平台是len。
        return str;
    }

输出结果:

text 复制代码

root@iZuf6ckztbjhtavfplgp0dZ:/tmp/log# cat demo42.log
2024-04-21 13:39:36 程序开始运行。

2024-04-21 13:39:36 第0个超女开始表演...
ok.
2024-04-21 13:39:36 第1个超女开始表演...
ok.
2024-04-21 13:39:36 第2个超女开始表演...
ok.
2024-04-21 13:39:36 第3个超女开始表演...
ok.
2024-04-21 13:39:36 第4个超女开始表演...
ok.
2024-04-21 13:39:36 第5个超女开始表演...
ok.
2024-04-21 13:39:36 第6个超女开始表演...
ok.
2024-04-21 13:39:36 第7个超女开始表演...
ok.
2024-04-21 13:39:36 第8个超女开始表演...
ok.
2024-04-21 13:39:36 第9个超女开始表演...
ok.
2024-04-21 13:39:36 第10个超女开始表演...
ok.
2024-04-21 13:39:36 第11个超女开始表演...
ok.
2024-04-21 13:39:36 第12个超女开始表演...
ok.
2024-04-21 13:39:36 第13个超女开始表演...
ok.
2024-04-21 13:39:36 第14个超女开始表演...
ok.
2024-04-21 13:39:36 第15个超女开始表演...
ok.
2024-04-21 13:39:36 第16个超女开始表演...
ok.
2024-04-21 13:39:36 第17个超女开始表演...
ok.
2024-04-21 13:39:36 第18个超女开始表演...
ok.
2024-04-21 13:39:36 第19个超女开始表演...
ok.
2024-04-21 13:39:36 第20个超女开始表演...
ok.
2024-04-21 13:39:36 第21个超女开始表演...
ok.
2024-04-21 13:39:36 第22个超女开始表演...
ok.
2024-04-21 13:39:36 第23个超女开始表演...
ok.
2024-04-21 13:39:36 第24个超女开始表演...
ok.
2024-04-21 13:39:36 第25个超女开始表演...
ok.
2024-04-21 13:39:36 第26个超女开始表演...
ok.
2024-04-21 13:39:36 第27个超女开始表演...
ok.
2024-04-21 13:39:36 第28个超女开始表演...
ok.
2024-04-21 13:39:36 第29个超女开始表演...
ok.
2024-04-21 13:39:36 第30个超女开始表演...
ok.
2024-04-21 13:39:36 第31个超女开始表演...
ok.
2024-04-21 13:39:36 第32个超女开始表演...
ok.
2024-04-21 13:39:36 第33个超女开始表演...
ok.
2024-04-21 13:39:36 第34个超女开始表演...
ok.
2024-04-21 13:39:36 第35个超女开始表演...
ok.
2024-04-21 13:39:36 第36个超女开始表演...
ok.
2024-04-21 13:39:36 第37个超女开始表演...
ok.
2024-04-21 13:39:36 第38个超女开始表演...
ok.
2024-04-21 13:39:36 第39个超女开始表演...
ok.
2024-04-21 13:39:36 第40个超女开始表演...
ok.
2024-04-21 13:39:36 第41个超女开始表演...
ok.
2024-04-21 13:39:36 第42个超女开始表演...
ok.
2024-04-21 13:39:36 第43个超女开始表演...
ok.
2024-04-21 13:39:36 第44个超女开始表演...
ok.
2024-04-21 13:39:36 第45个超女开始表演...
ok.
2024-04-21 13:39:36 第46个超女开始表演...
ok.
2024-04-21 13:39:36 第47个超女开始表演...
ok.
2024-04-21 13:39:36 第48个超女开始表演...
ok.
2024-04-21 13:39:36 第49个超女开始表演...
ok.
2024-04-21 13:39:46 程序运行结束。

root@iZuf6ckztbjhtavfplgp0dZ:/tmp/log# cat demo42.log
2024-04-21 13:39:36 程序开始运行。

2024-04-21 13:39:36 第0个超女开始表演...
ok.
2024-04-21 13:39:36 第1个超女开始表演...
ok.
2024-04-21 13:39:36 第2个超女开始表演...
ok.
2024-04-21 13:39:36 第3个超女开始表演...
ok.
2024-04-21 13:39:36 第4个超女开始表演...
ok.
2024-04-21 13:39:36 第5个超女开始表演...
ok.
2024-04-21 13:39:36 第6个超女开始表演...
ok.
2024-04-21 13:39:36 第7个超女开始表演...
ok.
2024-04-21 13:39:36 第8个超女开始表演...
ok.
2024-04-21 13:39:36 第9个超女开始表演...
ok.
2024-04-21 13:39:36 第10个超女开始表演...
ok.
2024-04-21 13:39:36 第11个超女开始表演...
ok.
2024-04-21 13:39:36 第12个超女开始表演...
ok.
2024-04-21 13:39:36 第13个超女开始表演...
ok.
2024-04-21 13:39:36 第14个超女开始表演...
ok.
2024-04-21 13:39:36 第15个超女开始表演...
ok.
2024-04-21 13:39:36 第16个超女开始表演...
ok.
2024-04-21 13:39:36 第17个超女开始表演...
ok.
2024-04-21 13:39:36 第18个超女开始表演...
ok.
2024-04-21 13:39:36 第19个超女开始表演...
ok.
2024-04-21 13:39:36 第20个超女开始表演...
ok.
2024-04-21 13:39:36 第21个超女开始表演...
ok.
2024-04-21 13:39:36 第22个超女开始表演...
ok.
2024-04-21 13:39:36 第23个超女开始表演...
ok.
2024-04-21 13:39:36 第24个超女开始表演...
ok.
2024-04-21 13:39:36 第25个超女开始表演...
ok.
2024-04-21 13:39:36 第26个超女开始表演...
ok.
2024-04-21 13:39:36 第27个超女开始表演...
ok.
2024-04-21 13:39:36 第28个超女开始表演...
ok.
2024-04-21 13:39:36 第29个超女开始表演...
ok.
2024-04-21 13:39:36 第30个超女开始表演...
ok.
2024-04-21 13:39:36 第31个超女开始表演...
ok.
2024-04-21 13:39:36 第32个超女开始表演...
ok.
2024-04-21 13:39:36 第33个超女开始表演...
ok.
2024-04-21 13:39:36 第34个超女开始表演...
ok.
2024-04-21 13:39:36 第35个超女开始表演...
ok.
2024-04-21 13:39:36 第36个超女开始表演...
ok.
2024-04-21 13:39:36 第37个超女开始表演...
ok.
2024-04-21 13:39:36 第38个超女开始表演...
ok.
2024-04-21 13:39:36 第39个超女开始表演...
ok.
2024-04-21 13:39:36 第40个超女开始表演...
ok.
2024-04-21 13:39:36 第41个超女开始表演...
ok.
2024-04-21 13:39:36 第42个超女开始表演...
ok.
2024-04-21 13:39:36 第43个超女开始表演...
ok.
2024-04-21 13:39:36 第44个超女开始表演...
ok.
2024-04-21 13:39:36 第45个超女开始表演...
ok.
2024-04-21 13:39:36 第46个超女开始表演...
ok.
2024-04-21 13:39:36 第47个超女开始表演...
ok.
2024-04-21 13:39:36 第48个超女开始表演...
ok.
2024-04-21 13:39:36 第49个超女开始表演...
ok.
2024-04-21 13:39:46 程序运行结束。

2024-04-21 13:46:40 程序开始运行。

2024-04-21 13:46:40 第0个超女开始表演...
ok.
2024-04-21 13:46:40 第1个超女开始表演...
ok.
2024-04-21 13:46:40 第2个超女开始表演...
ok.
2024-04-21 13:46:40 第3个超女开始表演...
ok.
2024-04-21 13:46:40 第4个超女开始表演...
ok.
2024-04-21 13:46:40 第5个超女开始表演...
ok.
2024-04-21 13:46:40 第6个超女开始表演...
ok.
2024-04-21 13:46:40 第7个超女开始表演...
ok.
2024-04-21 13:46:40 第8个超女开始表演...
ok.
2024-04-21 13:46:40 第9个超女开始表演...
ok.
2024-04-21 13:46:40 第10个超女开始表演...
ok.
2024-04-21 13:46:40 第11个超女开始表演...
ok.
2024-04-21 13:46:40 第12个超女开始表演...
ok.
2024-04-21 13:46:40 第13个超女开始表演...
ok.
2024-04-21 13:46:40 第14个超女开始表演...
ok.
2024-04-21 13:46:40 第15个超女开始表演...
ok.
2024-04-21 13:46:40 第16个超女开始表演...
ok.
2024-04-21 13:46:40 第17个超女开始表演...
ok.
2024-04-21 13:46:40 第18个超女开始表演...
ok.
2024-04-21 13:46:40 第19个超女开始表演...
ok.
2024-04-21 13:46:40 第20个超女开始表演...
ok.
2024-04-21 13:46:40 第21个超女开始表演...
ok.
2024-04-21 13:46:40 第22个超女开始表演...
ok.
2024-04-21 13:46:40 第23个超女开始表演...
ok.
2024-04-21 13:46:40 第24个超女开始表演...
ok.
2024-04-21 13:46:40 第25个超女开始表演...
ok.
2024-04-21 13:46:40 第26个超女开始表演...
ok.
2024-04-21 13:46:40 第27个超女开始表演...
ok.
2024-04-21 13:46:40 第28个超女开始表演...
ok.
2024-04-21 13:46:40 第29个超女开始表演...
ok.
2024-04-21 13:46:40 第30个超女开始表演...
ok.
2024-04-21 13:46:40 第31个超女开始表演...
ok.
2024-04-21 13:46:40 第32个超女开始表演...
ok.
2024-04-21 13:46:40 第33个超女开始表演...
ok.
2024-04-21 13:46:40 第34个超女开始表演...
ok.
2024-04-21 13:46:40 第35个超女开始表演...
ok.
2024-04-21 13:46:40 第36个超女开始表演...
ok.
2024-04-21 13:46:40 第37个超女开始表演...
ok.
2024-04-21 13:46:40 第38个超女开始表演...
ok.
2024-04-21 13:46:40 第39个超女开始表演...
ok.
2024-04-21 13:46:40 第40个超女开始表演...
ok.
2024-04-21 13:46:40 第41个超女开始表演...
ok.
2024-04-21 13:46:40 第42个超女开始表演...
ok.
2024-04-21 13:46:40 第43个超女开始表演...
ok.
2024-04-21 13:46:40 第44个超女开始表演...
ok.
2024-04-21 13:46:40 第45个超女开始表演...
ok.
2024-04-21 13:46:40 第46个超女开始表演...
ok.
2024-04-21 13:46:40 第47个超女开始表演...
ok.
2024-04-21 13:46:40 第48个超女开始表演...
ok.
2024-04-21 13:46:40 第49个超女开始表演...
ok.
2024-04-21 13:46:40 程序运行结束。

结语

今天的有关内容就到此为止啦，有问题的话欢迎在评论区评论，大家可以集思广益，如果你觉得博主的内容对你有帮助，欢迎三连一下和订阅专栏

如果博主文章里面有什么错误页欢迎斧正(毕竟博主页只是个小蒟蒻鸡)，好了，大家下篇文章见！