# C++日志系统设计

**Repository Path**: ss103838/c-log-system-design

## Basic Information

- **Project Name**: C++日志系统设计
- **Description**:  特点：

​	功能简单：代码短小，仅一百多行代码

​	使用方便：debug、info、warn、error、fatal、宏函数直接引入即可

 需求：

1、日志存储：文本文件

2、日志内容：时间、级别、文件、行号、内容

3、日志级别：debug<info<warn<error<fatal

4、日志翻滚：设置日志的大小

 使用说明:

- ​	该日志系统设置了五
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/ss103838/c-log-system-design
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-11-08
- **Last Updated**: 2022-12-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# c++日志系统设计与实现

#### 特点：

​	功能简单：代码短小，仅一百多行代码

​	使用方便：debug、info、warn、error、fatal、宏函数直接引入即可

#### 需求：

1、日志存储：文本文件

2、日志内容：时间、级别、文件、行号、内容

3、日志级别：debug<info<warn<error<fatal

4、日志翻滚：设置日志的大小

#### 使用说明:

- ​	该日志系统设置了五个宏函数debug、info、warn、error、fatal、这五个宏函数的具体实现，走工具类的log()函数实现
- ​	作用：可以直接使用宏函数方便快捷的打日志在文本文件

**本工具类提供了6个对外访问的函数**

```
 static Logger* instance();      //对外使用单例的模式获取对象；
 void open(const string& filename);    // 打开哪个文件
 void max(int bytes);   // 最大写入字节
 void level(int level);   // 如果是fatal其他级别的则不写入
 void log(Level level, const char* file, int line, const char* format, ...);  //直接打log的实现，这个是终实现
 void close();  // 关闭文件
```

### 系统实现:

- 时间：这个系统要获取当前时间，并写入文件，获取当前时间的函数

```c++
cpp中加入: #include<time.h>
    
	time_t ticks = time(NULL);
	struct tm* ptm = localtime(&ticks);
	char timestamp[32];
	memset(timestamp, 0, sizeof(timestamp));
	strftime(timestamp, sizeof(timestamp), "%Y-%m-%d %H:%M:%S", ptm);
	std::cout<<timestamp<<std::endl;  //不要问为什么这样写，timestamp就是当前时间
```

- 格式: 输出格式

```
首先: 打日志格式: debug("name=%s age=%d","jack",18);

在屏幕以及文本记录格式:    2022-11-08 12:41:20 DEBUG D:\刷题\c++项目\Logger的Test\MainLogger.cpp:17name=jack age=18
```

首先要输出这样的格式:需要掌握 va_list 的用法，如下：

```c++
// 使用 va_list 的用法
void sum(const char* msg, ...)
{
	va_list vaList;   // 定义一个va_list类型的变量,va_list 代表后面省略号的具体参数

	va_start(vaList, msg); // 初始化vaList
	int first = va_arg(vaList, int); // va_arg 获取第一个参数
	char* second = va_arg(vaList, char*);
	int third = va_arg(vaList, int);
	va_end(vaList);  // 结束vaList，将vaList置NULL

	char str[256]{ 0 };
	va_start(vaList, msg);
	vsprintf(str, msg, vaList);
	va_end(vaList);
	printf("%s\n", str);
	return;
}
int main()
{
	// 输出 hello world 9 666 3
	sum("hello world %d %s %d", 9, "666", 3);

	system("pause");
	return EXIT_SUCCESS;
}
```

- 打开文件，并计算文件的大小，给成员属性m_len赋初值

```c++
void Logger::open(const string& filename)
{
	m_filename = filename;

	m_fout.open(filename.c_str(), ios::app);
	if (m_fout.fail())
	{
		throw std::logic_error("打开日志文件失败:" + filename);
	}
	m_fout.seekp(0, ios::end);
	m_len = m_fout.tellp();
}
```



- 打印日志的函数，和本项目的核心逻辑:

```c++
void Logger::log(Level level, const char* file, int line, const char* format, ...)
{
	if (m_level > level)
	{
		return;
	}

	if (m_fout.fail())
	{
		throw std::logic_error("打开日志文件失败:" + m_filename);
	}
	// 获取当前时间
	time_t ticks = time(NULL);
	struct tm* ptm = localtime(&ticks);
	char timestamp[32];
	memset(timestamp, 0, sizeof(timestamp));
	strftime(timestamp, sizeof(timestamp), "%Y-%m-%d %H:%M:%S", ptm);

	char sumprintf[256];
	int len = 0;
	const char* fmt = "%s %s %s:%d";
	len = snprintf(NULL, 0, fmt, timestamp, s_level[level], file, line);
	if (len > 0)
	{
		char* buffer=new char[len+1];

		snprintf(sumprintf, len + 1, fmt, timestamp, s_level[level], file, line);
		snprintf(buffer, len + 1, fmt, timestamp, s_level[level], file, line);
		buffer[len] = 0;

		//strcat(sumprintf, buffer);
		//std::cout << sumprintf << std::endl;

		m_fout << buffer;
		
		delete[] buffer;
		
		m_len += len;  
	}

	va_list arg_ptr;
	va_start(arg_ptr, format);
	len = vsnprintf(NULL, 0, format, arg_ptr);
	va_end(arg_ptr);
	if (len > 0)
	{
		char* content = new char[len + 1];
		va_start(arg_ptr, format);
		vsnprintf(content, len + 1, format, arg_ptr);
		va_end(arg_ptr);
		content[len] = 0;
        // 往文本里面写数据
		m_fout << content;
		strcat(sumprintf, content);
		delete[] content;
		m_len += len;
	}
	std::cout << sumprintf << std::endl;
	// 换行
	m_fout << "\n";
	m_fout.flush();

	if (m_max > 0 && m_len >= m_max)
	{
        // 日志回滚，重新打开新的文件，并重新命名
		rotate();
	}
}
```

- 日志回滚，重新打开新的文件，并重新命名

```c++
void Logger::rotate()
{
	close();
	time_t ticks = time(NULL);
	struct tm* ptm = localtime(&ticks);
	char timestamp[32];
	memset(timestamp, 0, sizeof(timestamp));
	strftime(timestamp, sizeof(timestamp), ".%Y-%m-%d_%H-%M-%S", ptm);
	string filename = m_filename + timestamp;
	if (rename(m_filename.c_str(), filename.c_str()) != 0)
	{
		throw std::logic_error("命名日志文件失败:" + string(strerror(errno)));
	}
	open(m_filename);
}
```

项目截图:

![image-20221112130639645](readme.assets/image-20221112130639645.png)



![image-20221112130808757](readme.assets/image-20221112130808757.png)