31_写个日志还导库啊真没必要
WIN32 日志实现
预热知识
业务开发中，对于一些异常情况往往需要日志记录。记录日志这件事本身就是把内容写入文件，实现并不复杂。结合本人实际工作需要，并结合所学知识，进一步扩展了，实现了日志常用功能，目的是使用简便快捷, 直接包含头文件和源文件即可使用。
功能:
- 1.可设置日志文件存放路径以及文件名前缀
- 2.可设置单个日志文件最大容量, 到限后自动转储到下一个日志文件
- 3.可设置日志自动保存, 按照时间间隔或日志缓存条目数量
- 4.可设置最多保存的日志文件数量, 超限会自动删除最旧的日志文件
- 5.可设置管道模式, 在管道模式下可使用另一个进程来处理日志转存,管道模式下，共享临界资源如何约束（上锁），如果在启用管道模式（在主线程中开启一个线程，由线程创建管道进程）还是有很多可以学习到的地方的。
使用示例
调用: CLogUtils::LOG_INFO(_T("%d %s"), 1024, _T("FlameCyclone"));
日志文件输出内容: 2023-10-25 16:44:57.379 INFO [29288:32416] [E:\gitee\c-log-utils\CLogUtils\CLogUtils\main.cpp:20] [wmain] 1024 FlameCyclone
在封装一个日志库之前，我们需要对WINDOW 的一些API有一点点的了解和学习。
通过 GetModuleFileName() 可以得到获取exe（dll）可执行文件的绝对路径。函数原型如下所示：
DWORD WINAPI GetModuleFileName(
_In_opt_ HMODULE hModule, //应用程序或DLL实例句柄,NULL则为获取当前程序可执行文件路径名
_Out_ LPTSTR lpFilename, //接收路径的字符串缓冲区
_In_ DWORD nSize //接收路径的字符缓冲区的大小
);
通过CreateDirectory() 可以创建一个新的目录。函数原型如下：
BOOL CreateDirectory(
LPCTSTR lpPathName,
LPSECURITY_ATTRIBUTES lpSecurityAttributes
);
参数：
- lpPathName：长指针，指向一个空结束的字符串，该字符串指定要创建的目录的路径。有一个默认的字符串大小限制为MAX_PATH字符的路径。此限制是关系到这个函数是如何解析路径。字符串的长度不超过MAX_PATH。
- lpSecurityAttributes：忽略，一般设置为NULL。
- 返回值： 非零表示成功，零表示失败。若想获得更多的错误信息，调用
GetLastError()函数。
注意，这个函数不是递归的。它可以在一个路径中创建唯一的最终目录。也就是说，如果父目录或中间目录不存在，该函数将失败并显示错误消息ERROR_PATH_NOT_FOUND。
通常来说，我们也可以先判断该目录是否已经存在，例如。业务上，我们通常用递归的方式，来创建级联子目录。
if (!::PathIsDirectory(str))
{
::CreateDirectory(str, NULL);
}
在说GetLocalTime() 函数之前，我们先认识了解下WINDOWS系统中的系统时间，可以调用GetSystemTime()函数获取系统的当前日期和时间，返回的系统时间以协调世界时(Coordinated Universal Time，UTC)表示∶
VoID WINAPl GetSystemTime(_Out_LPSYSTEMTIME lpSystemTime);
// SYSTEMTIME结构
- 参数lpSystemTime是一个指向SYSTEMTIME结构的指针，在这个结构中返回系统的当前日期和时间。SYSTEMTIME结构在 minwinbase.h头文件中定义如下∶
typedef struct _SYSTEMTIME
{
WORD wYear; //年，范围1601～30827
WORD wMonth;//月，范围1～12
WORD wDayOfWeek;//星期，范围0～6
WORD wDay;//日，范围1～31
WORD wHour;//时，范围0～23
WORD wMinute;//分，范围0～59
WORD wSecond; //秒，范围0～59
WORD wMilliseconds; //毫秒，范围0～999
}SYSTEMTIME，*PSYSTEMTIME，*LPSYSTEMTIME;
协调世界时又称世界统一时间、世界标准时间、国际协调时间，是最主要的世界时间标准。其以原子时秒长为基础，在时刻上尽量接近于格林尼治标准时间。如果本地时间比UTC时间快，例如新加坡、马来西亚、澳大利亚西部的时间比UTC快8h，就会写作UTC+8，俗称东8区 相反，如果本地时间比UTC时间慢，例如夏威夷的时间比UTC时间慢10小时，就会写作UTC-10，俗称西10区。
GetLocalTime()函数也可以获取系统的当前日期和时间，该函数会根据计算机的时区计算当地时间。对于中国大陆来说，该函数获取的时间比GetSystemTime()函数获取的时间快8小时
GetSystemTime()和GetLocalTime()函数所获取到的时间值的准确性完全取决于用户是否设置了正确的时区以及是否在本机上设置正确的时间，打开控制面板→日期和时间，可以更改日期时间和时区。
两个函数的区别不言而喻，假设SYSTEMTIME结构初始化为"2020年10月1号星期四中午12点":
sYSTEMTIME st =
{
2020，//年，范围1601～30827
10，//月，范围1～12
3,//星期，范围0～6
1,//日，范围1～31
12,//时，范围0～23
0，//分，范围0～59
0，//秒，范围0～59
0 //毫秒，范围0～999
};
调用SetSystemTime(&st); 桌面右下角时间显示为2020年10月1号星期四20点
调用SetLocalTime(&st); 桌面右下角时间显示为2020年10月1号星期四12点
注意∶调用SetSystemTime(&st)，本机显示的始终是本地时间，因此是（中午12点＋8小时）等于20点。
看一下时间单位 s(秒)、ms(毫秒)、us (微秒)、ns(纳秒)，ps（皮秒)的关系∶1s = 1000 ms，1 ms = 1000 us,1 us = 1000 ns，1 ns = 1000 ps。还有更小的时间单位，不过一般用不到。
经过笔者的描述，相信你对WINDOW系统中的时间一定有了更多深入的认识了。
通常我们生成日志文件，都是用时间戳，转为日期字符串作为日志文件名的，那么我们需要知道怎么获取当前系统的时间戳呢？WIN32 给我们提供了GetSystemTimeAsFileTime() 通过这个函数，我们获取当前系统时间的FILETIME结构体。然后，通过将FILETIME结构体的dwLowDateTime和dwHighDateTime字段合并为一个64位整数，得到一个表示时间的大整数。最后，将这个大整数减去116444736000000000（这是1601年1月1日到1970年1月1日的时间差），再除以10000（将单位从100纳秒转换为毫秒），就得到了ntp时间戳(13位时间戳，精确到毫秒)。 如果需要10位时间戳，则不再是除以10000了，而是除以10000000。 如果你听得雨里雾里，这里请忽略文字，直接看代码。
int64_t GetCurrentTimestamp()
{
int64_t timeStamp = 0;
(void)::GetSystemTimeAsFileTime((FILETIME*)&timeStamp); //方式1，int64_t强转
return (timeStamp - 116444736000000000) / 10000;
}
int _tmain() {
FILETIME ft;
GetSystemTimeAsFileTime(&ft);
ULARGE_INTEGER uli;
uli.LowPart = ft.dwLowDateTime;
uli.HighPart = ft.dwHighDateTime; //方式2，合并成64位整数，推荐！
std::cout << "当前系统的时间戳: " << (uli.QuadPart - 116444736000000000) /10000 << std::endl;
std::cout << "当前时间戳 " << GetCurrentTimestamp() << std::endl;
return 0;
}
这里笔者再次说明几个重点
- ntp时间戳，从1970年1月1日开始，业务开发都是用的这个时间开始的时间戳。
- Win32API 得到的系统时间戳，从1601年1月1日（UTC）开始。所以下面不得不做减法。
- 100纳秒 要转为 毫秒 需要除以
10000转为秒 需要除以10000000是这么来的！
还有，知道一个ntp时间戳之后，如何转为日期字符串呢？
WIN32中，函数FileTimeToLocalTime()用来将文件时间格式转换为本地文件时间：
1 BOOL WINAPI FileTimeToLocalFileTime
(
__in const FILETIME* lpFileTime,//文件时间
__out LPFILETIME lpLocalFileTime//本地文件时间
);
进而，可以通过函数FileTimeToSystemTime()用来将文件时间格式转换为标准系统时间格式：
BOOL WINAPI FileTimeToSystemTime
(
__in const FILETIME *lpFileTime, //本地文件时间
__out LPSYSTEMTIME lpSystemTime //系统时间
);
最终会得到如下这样的一个封装把时间戳转为日期字符串。
_tstring CLogUtils::TimestampToString(int64_t timestamp, const _tstring& strFormat)
{
TCHAR szBuf[MAX_PATH] = { 0 };
SYSTEMTIME st = { 0 };
FILETIME ftFile = { 0 };
FILETIME ftLocal = { 0 };
//ntp时间戳 转为 100纳秒的单位 再加上 1601年1月1日到1970年1月1日的时间差 就得到了UTC时间戳了，也就是WIN32中认定的时间戳
timestamp = timestamp * 10000 + 116444736000000000;
ftFile.dwLowDateTime = timestamp & 0xFFFFFFFF;
ftFile.dwHighDateTime = timestamp >> 32; //这里的运算时MSDN推荐的。
//文件格式时间转为本地文件时间
::FileTimeToLocalFileTime(&ftFile, &ftLocal);
//本地文件时间转为系统时间
::FileTimeToSystemTime(&ftLocal, &st);
//格式化为所需
::StringCchPrintf(
szBuf,
_countof(szBuf),
strFormat.c_str(),
st.wYear, st.wMonth, st.wDay, st.wHour, st.wMinute, st.wSecond, st.wMilliseconds
);
return szBuf;
}
内存的管理，人家Win32内部也有自己的一套规则， 业务开发中，我们通常需要，在堆中分配和释放内存块。
HeapAlloc()函数用于从堆中分配一块内存
LPVOID WINAPI HeapAlloc(
_ln_ HANDLE hHeap,//堆的句柄，从中分配内存，由HeapCreate或GetProcessHeap函数返回
_ln_ DWORD dwFlags,//堆分配选项
_ln_SIZE_T dwBytes //要分配的内存块大小，以字节为单位
);
- dwFlags参数指定堆分配选项，可以是下表所示的一个或多个值。
| 常量宏 | 含义 |
|---|---|
| HEAP ZERO_MEMORY | 将分配的内存块初始化为0，即清零操作，在默认情况下，从堆中分配(HeapAlloc)或重新分配(HeapReAlloc）内存块失败会返回NULL，指定该标志后，如果分配失败则会抛出一个异常以通知应用程序有错误发生。 |
| HEAP_GENERATE_EXCEPTIONS | 如果希望堆中所有内存分配(HeapAlloc)或重新分配(HeapReAlloc)函数失败时都抛出一个异常，则应该在调用HeapCreate函数创建堆时为flOptions参数指定该标志。如果调用HeapCreate函数时指定了HEAP_GENERATE_EXCEPTIONS标志，则以后在该堆中的所有内存分配(HeapAlloc或重新分配(HeapReAlloc) 函数失败时都会抛出一个异常。如果调用HeapCreate函数时未指定HEAP_GENERATE_EXCEPTIONS标志，则可以在这里使用该标志单独指定对本次分配操作失败抛出一个异常 |
| HEAP_NO_SERIALIZE | HEAP_NO_SERIALIZE如果当初调用HeapCreate函数时指定了HEAP_NO_SERIALIZE标志，则后续在该堆中的所有内存分配或释放操作都不进行独占检测。如果当初调用HeapCreate函数时没有指定HEAP_NO_SERIALIZE标志，则可以在这里使用该标志单独指定不对本次分配操作进行独占检测。在进程的默认堆中分配内存时，绝对不要使用这个标志，否则可能会破坏数据，因为进程中的其他线程可能会在同一时刻访问堆 |
如果函数执行成功，则返回值是指向已分配内存块的指针。如果函数执行失败并且没有指定
HEAP_GENERATE_EXCEPTIONS标志，则返回值为NULL。如果函数执行失败并且已经指定
HEAP GENERATE EXCEPTIONS标志，则该函数可能会生成表所表示的异常
| 异常代码宏 | 含义 |
|---|---|
| STATUS_NO_MEMORY | 由于缺少可用内存或堆损坏导致分配操作失败 |
| STATUS_ACCESS_VIOLATION | 由于堆损坏或不正确的函数参数导致分配操作失败 |
当从堆中分配内存时，系统会执行以下操作步骤。
- (1）遍历历已分配内存的链表和闲置内存的链表。
- (2）找到一块足够大的闲置内存块。
- (3）将刚刚找到的闲置内存块标记为已分配，并分配一块新的内存。
- (4）将新分配的内存块添加到已分配内存的链表中。
例如下面的代码，创建一个不限制最大大小的私有堆,然后从堆中分配1024字节的内存∶
LPVOID lp = NULL;
hHeap = HeapCreate(0,0，O);
lp = HeapAlloc(hHeap,HEAP_ZERO_MEMORY,1024);//分配1024字节的内存
有时候程序可能需要调整已分配内存块的大小，程序一开始可能分配一块大于实际需要的内存块，在把需要的数据都放到这块内存中以后再减小内存块的大小;也可能一开始分配的内存块太小，不满足实际需要，这时需要增大内存块的大小。如果需要调整内存块的大小可以调用HeapReAlloc()函数∶
LPVOID WINAPI HeapReAlloc
(
_ln_ HANDLE hHeap,//堆的句柄，从中重新分配内存
_In_DWORD dwFlags,//堆分配选项
_ln_ LPVOID lpMem,//要调整大小的内存块指针
_In_ SIZE_T dwBytes//要调整到的大小，以字节为单位
);
dwFlags参数指定堆分配选项，可以是下表所示的一个或多个值。
| 宏常量 | 含义 |
|---|---|
| HEAP_ ZERO_MEMORY | 如果重新分配的内存块比原来的大，则超出原始大小的部分将初始化为0，但是内存块中原始大小的内容不受影响;如果重新分配的内存块比原来小，则该标志不起作用 |
| HEAP_REALLOC_IN_PLACE_ONLY | 在增大内存块时，HeapReAlloc函数可能会在堆内部移动内存块，如果在原内存块地址处无法找到一块连续的满足新分配大小的内存空间，则函数会在其他位置寻找一块足够大的闲置内存空间并把原内存块的内容复制过来，然后函数将返回一个新地址，很明显新地址与原地址不同﹔如果HeapReAlloc函数能够在不移动内存块的前提下使它增大，则函数将返回原内存块的地址。指定HEAP_REALLOC_IN_PLACE_ONLY标志是用来告诉 HeapReAlloc函数不要移动内存块，如果能够在不移动内存块的前提下使它增大，或者要把内存块减小，则HeapReAlloc函数会返回原内存块的地址﹔如果指定了该标志并且无法在不移动内存块的情况下调整内存块的大小，则函数调用将失败。无论哪种情况,原始内存块部分的内容始终保持不变 |
| HEAP_GENERATE_EXCEPTIONS | 参见HeapAlloc函数的说明 |
| HEAP_NO_SERIALIZE | 参见HeapAlloc函数的说明 |
HeapReAlloc函数的返回值情况与HeapAlloc函数相同。如果函数执行成功，则返回值是指向新内存块的指针。如果指定了HEAP_REALLOC_IN_PLACE_ONLY标志，则新内存块的指针必定与原来的相同，否则它既有可能与原来的指针相同也有可能不同。
比如说，下面图片中的代码。
这段代码调用HeapAlloc函数分配内存块返回的地址为
0x038905A8，接着程序向这块内存中写入字符串，然后调用HeapReAlloc函数增大内存块为8KB，函数返回一个新的内
存块地址Ox038909B0，从内存1窗口可以看到，原内存块的内容复制到了新内存块中。
HeapFree函数用于释放HeapAlloc或HeapReAlloc函数从堆中分配的内存块∶
BOOL WINAPl HeapFree(
_ln_HANDLE hHeap,//要释放其内存块的堆的句柄
_ln_ DwORD dwFlags,//堆释放选项，可以设置为0或HEAP_NO_SERIALIZE
_in_LPVOID lpMem //要释放的内存块的指针
);
一般来说，我们在业务中，通常这样进行内存的分配和释放。
//分配缓冲
lpBuf = (LPTSTR)::HeapAlloc(::GetProcessHeap(), HEAP_ZERO_MEMORY, dwCchCount * sizeof(TCHAR));
//释放缓冲
if (nullptr != lpBuf)
{
::HeapFree(::GetProcessHeap(), 0, lpBuf);
lpBuf = nullptr;
}
为了满足我们写日志的需求，我们还需要一个存日志文件的目录，存在一种情况是说，用你库的开发给的全路径不是一个目录路径是一个文件路径，亦或这个路径不存在等这些问题要判断后，分情况考虑来进行处理。
WIN32 提供了GetFileAttributesEx() 函数，我们可以给定一个文件路径，可以查到文件的属性，来判断是目录还是文件，还可以判断该全路径表示的文件是不是存在的。
BOOL GetFileAttributesEx
(
LPCSTR lpFileName, //文件名
GET_FILEEX_INFO_LEVELS fInfoLevelld, //需要设置成GetFileExInfoStandard参数
LPVOID lpFileInfomation //将LPVOID的地址赋值给LP WIN32_FILE_ATTRIBUTE_DATA参数
);
参数说明：
- 第一个参数：传入文件名即可，如果是Unicode编译环境下（即宽字节），再加一个L即可。
- 第二个参数：当传入GetFileExInfoStandard后，第三个参数就可以传 LPWIN32_FILE_ATTRIBUTE_DATA结构体对象
- 获取为第一个文件名的文件属性信息
bool CLogUtils::IsDirectory(const _tstring& strPath)
{
//文件表示的路径不存在
WIN32_FILE_ATTRIBUTE_DATA attr = { 0 };
if (!::GetFileAttributesEx(strPath.c_str(), GetFileExInfoStandard, &attr))
{
return false;
}
//是一个目录
return attr.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
}
还可以做到查文件的大小。
unsigned long long CLogUtils::GetFileSize(const _tstring& strPath)
{
unsigned long long ullSize = 0;
WIN32_FILE_ATTRIBUTE_DATA attr = { 0 };
if (!::GetFileAttributesEx(strPath.c_str(), GetFileExInfoStandard, &attr))
{
return 0;
}
ullSize = (unsigned long long)attr.nFileSizeHigh << 32 | attr.nFileSizeLow;
return ullSize;
}
通常我们使用可变参数，配合格式化字符串。这样日志的内容可以使用%s %d 来注入。使用指向参数列表的指针写入格式化的输出，很方便。
int vsnprintf_s(
char *buffer,
size_t sizeOfBuffer,
size_t count,
const char *format,
va_list argptr
);
函数的参数：
- 第一个参数是目标字符串的指针
- 第二个参数是目标字符串的最大长度
- 第三个参数，指定字符串截断行为，比如
_TRUNCATE - 第四个参数是格式化字符串
- 第五个参数，用于替换格式化字符串中占位符的值
然后，va_start()函数的用途是在可变参数函数中初始化一个va_list类型的变量，以便访问函数参数列表中的参数。
void va_start(
va_list arg_ptr,
prev_param
); // (ANSI C89 and later)
函数参数：
- 第一个参数是一个va_list类型的变量，用于存储参数列表中的参数
- 第二个参数是可变参数列表中的最后一个已知参数。
一般业务上来说，这么写，就可以得到替换之后值的字符串了。
_tstring CLogUtils::Format(LPCTSTR pstrFormat, ...)
{
_tstring strResult;
va_list args;
va_start(args, pstrFormat);
if (-1 != _vsntprintf_s(lpBuf, dwCchCount, _TRUNCATE, pstrFormat, args))
{
strResult = lpBuf;
break;
}
va_end(args);
return strResult;
}
其他的一些细节，提供读者自行学习，笔者不再累述。
日志实现
- CLogUtils.h
#pragma once
#include - CLogUtils.cpp
#include "CLogUtils.h"
#include - Main.cpp
#include