行业知识
C++ Webserver从零开始:代码书写(十)——完成Locker类和Log类封装
前言
这���我们正式开始写代码的第一章,经历了前面那么多的内容,我们终于可以上手写代码了。前面那么多基础知识,如果大家都看了,理解了更好。如果说看的一知半解也不用担心,基础知识是学不完的,而且如果不加以使用,那么你学的基础知识就会非常快的忘掉。只有将学到东西拿来用,才能真正地掌握。
()但是基础知识又不能没有,不然写项目的过程中会非常痛苦,你会发现你基本每一行代码都不知道是什么意思,然后再去查回来再写,就非常容易掉进局部的细节里出不来,而无法纵观全局,领会项目的设计思想和代码结构。所以,如果到了这一章的小伙伴,你还完全不了解Webserver的话,我是十分建议你去把前面的内容稍微看一看。当然,如果你有足够的时间,那么我是十分推荐把游双学长的《Linux高性能服务器编程》通读一遍的,读过以后再来写代码就会轻松许多。
好了,话不多说,我们开始今天的内容。
()Locker类
写一个项目,很多同学不知道具体从哪开始写起。我目前的经验是,我会进入项目的main函数里,然后一层一层地看它的include的依赖关系,直到找到最里面的那一层,也就是最底层,然后从最底层开始,一个文件一个文件地写。这样的好处是,你整个书写代码地过程会非常清晰,你会知道每一行代码的实现原理。缺点是,你可能会陷入不知道自己在写什么的困境中,也不知道自己写的东西具体起到了一个什么作用。所以,我们可以在整个项目全部写完之后,再来一遍自顶向下的梳理。这样就即明白了每行代码的原理,也了解了整个项目的整体结构。
按照这样的思路,我们来实现一下Locker类,Locker类是最底层的工具类,用以保证其他代码的同步。
Locker类主要使用的API都是include里的,这部分的API都在
C++ Webserver从零开始:基础知识(八)——多线程编程-CSDN博客
RAII
RALL:"Resource Acquisition is Initialization",即”资源获取即初始化“
在构造函数中申请分配资源,在析构函数中释放资源。因为C++的语言机制,当一个对象创建时会调用构造函数,当对象超出作用域时会自动调用析构函数。所以在RAII指导下,我们应该用类来管理资源,将资源和对象的生命周期绑定
RAII核心思想是将资源或者状态与对象的生命周期绑定,通过C++的语言机制,实现资源和状态的安全管理,智能指针是RAII最好的例子
代码
/*author:Benxaomin *date:20240219 * */#ifndef LOCKER_H#define LOCKER_H#include#include#includeusing namespace std;class sem{public: sem() { if (sem_init(&m_sem, 0, 0) != 0) { throw exception(); } } sem(int val) { if (sem_init(&m_sem, 0, val) != 0) { throw exception(); } } ~sem() { sem_destroy(&m_sem); } bool wait() { return sem_wait(&m_sem) == 0; } bool post() { return sem_post(&m_sem) == 0; }private: sem_t m_sem;};class locker{public: locker() { if (pthread_mutex_init(&m_mutex, NULL) != 0) { throw exception(); } } ~locker() { pthread_mutex_destroy(&m_mutex); } bool lock() { return pthread_mutex_lock(&m_mutex) == 0; } bool unlock() { return pthread_mutex_unlock(&m_mutex) == 0; } /*获得互斥锁的指针*/ pthread_mutex_t *get() { return &m_mutex; }private: pthread_mutex_t m_mutex;};class cond{public: cond() { if (pthread_cond_init(&m_cond, NULL) != 0) { throw exception(); } } ~cond() { pthread_cond_destroy(&m_cond); } bool wait(pthread_mutex_t *m_mutex) { return pthread_cond_wait(&m_cond, m_mutex) == 0; } bool timewait(pthread_mutex_t *m_mutex, struct timespec *m_abstime) { return pthread_cond_timedwait(&m_cond, m_mutex, m_abstime) == 0; } bool signal() { return pthread_cond_signal(&m_cond) == 0; } bool broadcast() { return pthread_cond_broadcast(&m_cond) == 0; }private: pthread_cond_t m_cond;};#endif LOG类
顾名思义,LOG类就是项目的日志系统。所谓日志,即由服务器自动创建,并记录运行状态,错误信息,访问数据的文件。
日志的实现有两种,一种是同步日志,一种是异步日志;
同步日志:日志写入函数与工作线程串行执行,由于涉及I/O操作,同步日志会阻塞整个处理流程,服务器所能处理的并发能力将有所下降,尤其是在访问峰值时,写日志可能会成为系统的瓶颈
异步日志:将工作线程所写的日志内容先存入阻塞队列,写线程从阻塞队列中取出内容,写入日志
在异步日志中,每个工作线程当有日志需要处理时,将所需写的内容所在内存加入一个阻塞队列,然后就不管了。而日志系统会单独分配一个写线程,不断地从阻塞队列中获得任务并写入日志文件中。
从上面地日志工作流程描述中我们可以发现,这是一个典型的生产者-消费者模型。其中工作线程时生产,写线程是消费者。
那么,生产者-消费者模型的临界区(缓冲区)是什么呢?在我们日志系统中,这个临界区就是一个队列。 在本项目中,我们使用循环队列来实现。
循环队列代码
因为循环队列代码大部分重复且简单,就不分文件编写了
/*author:Benxaomindate:20240219*/#ifndef BLOCK_QUEUE_H#define BLOCK_QUEUE_H#include#include#include#include#include"../lock/locker.h"using namespace std;templateclass block_queue{public: /*初始化阻塞队列*/ block_queue(int max_size) { if (max_size = m_max_size) { m_mutex.unlock(); return true; } m_mutex.unlock(); return false; } /*判断队列是否为空*/ bool empty() { m_mutex.lock(); if (m_size == 0) { m_mutex.unlock(); return true; } m_mutex.unlock(); return false; } /*获得队首元素*/ bool front(T &value) { m_mutex.lock(); /*注意下面的if判断不能用empty,因为empty函数也有加锁操作,加两次锁会导致***锁*/ if (size == 0) { m_mutex.unlock(); return false; } //TODO:个人感觉这行逻辑出错,后面部分是原代码 value = m_array[m_front]; value = m_array[(m_front + 1) % m_max_size]; m_mutex.unlock(); return true; } /*获得队尾元素*/ bool back(T& value) { m_mutex.lock(); if (size == 0) { m_mutex.unlock(); return false; } value = m_array[m_back]; m_mutex.unlock(); return true; } int size() { int tmp = 0; m_mutex.lock(); tmp = m_size; m_mutex.unlock(); return tmp; } int max_size() { int tmp = 0; m_mutex.lock(); tmp = m_max_size; m_mutex.unlock(); return tmp; } /*往队列中添加元素前需要先将所有使用队列的线程先唤醒*/ /*阻塞队列封装了生产者消费者模型,调用push的是生产者,也就是工作线程*/ bool push(T& item) { m_mutex.lock(); if (m_size >= m_max_size) { cond.broadcast(); m_mutex.unlock(); return false; } m_back = (m_back + 1) % m_max_size; m_array[m_back] = item; m_size++; cond.broadcast(); m_mutex.unlock(); return true; } /*调用pop的是消费者,负责把生产者的内容写入文件*/ bool pop(T& item) { m_mutex.lock(); while (m_size = 1) { m_is_async = true;//异步写入 m_log_queue = new block_queue(max_queue_size);//创建阻塞队列 /*创建一个新线程,执行异步写入文件函数*/ pthread_t tid; pthread_create(&tid, NULL, flush_log_thread, NULL); } /*初始化各值*/ m_close_log = close_log; m_split_lines = split_lines; m_log_buf_size = log_buf_size; m_buf = new char[m_log_buf_size]; memset(m_buf, 'write_log()
', m_log_buf_size); /*创建strcut tm变量接收当下时间*/ time_t t = time(NULL); struct tm *sys_tm = localtime(&t); struct tm my_tm = *sys_tm; /*在filename里面查找'/',未找到返回 nullptr,找到返回最后一个的位置的指针*/ const char *p = strrchr(file_name, '/'); char log_full_name[256] = {0};//创建一个局部缓冲区对文件名命名 /*下面是命名规则代码:日志文件命名为:年_月_日_文件名*/ if (p == nullptr) { snprintf(log_full_name, 255, "%d_%02d_%02d_%s", my_tm.tm_year + 1900, my_tm.tm_mon + 1, my_tm.tm_mday, file_name); } else { strcpy(log_name, p + 1); strncpy(dir_name, file_name, p - file_name + 1); snprintf(log_full_name, 255, "%s%d_%02d_%02d_%s", dir_name, my_tm.tm_year + 1900, my_tm.tm_mon + 1, my_tm.tm_mday, log_name); } m_today = my_tm.tm_mday; m_fp = fopen(log_full_name, "a"); if (m_fp == nullptr) { return false; } return true;} Log分级:
- Warn,这种警告与调试时终端的warning类似,同样是调试代码时使用。
- Info,报告系统当前的状态,当前执行的流程或接收的信息等。
- Erro,输出系统的错误信息
Log分文件:
当新的一天时创建新文件
当原文件日志写满时创建新文件
public:void flush(void) { m_mutex.lock(); fflush(m_fp); m_mutex.unlock(); }void write_log(int level, const char *format, ...);//类外:#define LOG_DEBUG(format, ...) if(0 == m_close_log) {Log::get_instance()->write_log(0, format, ##__VA_ARGS__); Log::get_instance()->flush();}#define LOG_INFO(format, ...) if(0 == m_close_log) {Log::get_instance()->write_log(1, format, ##__VA_ARGS__); Log::get_instance()->flush();}#define LOG_WARN(format, ...) if(0 == m_close_log) {Log::get_instance()->write_log(2, format, ##__VA_ARGS__); Log::get_instance()->flush();}#define LOG_ERROR(format, ...) if(0 == m_close_log) {Log::get_instance()->write_log(3, format, ##__VA_ARGS__); Log::get_instance()->flush();}void Log::write_log(int level, const char* format, ...) { struct timeval now = {0,0}; gettimeofday(&now, NULL); time_t t = now.tv_sec; struct tm *sys_tm = localtime(&t); struct tm my_tm = *sys_tm; char s[16] = {0}; switch (level) { case 0: strcpy(s,"[debug]"); break; case 1: strcpy(s,"[info]"); break; case 2: strcpy(s,"[warn]"); break; case 3: strcpy(s,"[error]"); break; default: strcpy(s,"[info]"); break; } /*开始写入*/ m_mutex.lock(); m_count++; /*如果是新的一天了,或者日志行数到上限了,创建新日志*/ if (m_today != my_tm.tm_mday || m_count % m_split_lines == 0) { char new_log[256] = {0}; flush(); fclose(m_fp); char tail[16] = {0}; snprintf(tail, 16,"%d_%02d_%02d_", my_tm.tm_year + 1900, my_tm.tm_mon + 1, my_tm.tm_mday); if (m_today != my_tm.tm_mday) {//新的一天 snprintf(new_log, 255, "%s%s%s", dir_name, tail, log_name); m_today = my_tm.tm_mday; m_count = 0; } else {//日志写满了 snprintf(new_log, 255, "%s%s%s.%lld", dir_name, tail, log_name, m_count / m_split_lines); } m_fp = fopen(new_log, "a"); } m_mutex.unlock(); /*可变参数定义初始化,在vsprintf时使用,作用:输入具体的日志内容*/ va_list valst; va_start(valst, format); string log_str; m_mutex.lock(); /*写每一行的开头格式*/ int n = snprintf(m_buf, 48, "%d-%02d-%02d %02d:%02d:%02d.%06ld %s ", my_tm.tm_year + 1900, my_tm.tm_mon + 1, my_tm.tm_mday, my_tm.tm_hour, my_tm.tm_min, my_tm.tm_sec, now.tv_usec, s); int m = vsnprintf(m_buf + n, m_log_buf_size - n - 1, format, valst); /*加入换行和空格*/ m_buf[n + m] = '\n'; m_buf[n + m + 1] = ''; log_str = m_buf; m_mutex.unlock(); /*决定是异步写还是同步写*/ if (m_is_async && !m_log_queue->full()) { m_log_queue->push(log_str); } else { m_mutex.lock(); fputs(log_str.c_str(), m_fp); m_mutex.unlock(); } va_end(valst);}
write_log()代码
上一篇:内存卡下载教程,轻松搞定数据传输
下一篇:职称证怎么解除备案