C语言封装自己的日志函数

怼烎@ 2022-09-20 05:54 168阅读 0赞

来自：http://www.cpplive.com/html/871.html

用[C语言][C]的时候，您是否还在使用printf[函数][Link 1]来输出[日志][Link 2]呢？您是否考虑过将printf函数打印的内容存到文件中去呢？您是否想拥有一个可选择的既支持输出到屏幕又支持存储到文件中的日志函数呢？很高兴的告诉您，如果您愿意的话，欢迎使用本人编写的一个一套日志函数，该套函数由五部分组成，分别是[宏变量][Link 3]BUF\_SIZE、结构体log\_st、log\_init函数、log\_debug函数和log\_checksize函数。其中宏变量BUF\_SIZE用来限制每次输出的日志的最大长度；结构体用来存储用户需求，包括文件路径、文件描述符号、单个文件最大大小、输出方式标志、文件命名标志等；log\_init函数用来完成用户需求录入、文件创建等功能，在mian函数的开始调用一次即可；log\_debug函数的功能跟printf很类似，是在printf基础上进行的扩充，实现将日志输出到屏幕或者写入到文件，在需要打印日志的地方调用该函数；log\_checksize函数用来检测日志文件大小是否超过最大大小限制，它需要您定时或者定点调用它，如果一直不调用，则日志文件将不受指定的最大大小限制。

**一、定义宏变量BUF\_SIZE**

[view plain][] [copy to clipboard][view plain] [print][view plain] [?][view plain]

1.  \#define BUF\_SIZE 1024

**二、定义log\_st结构体**

[view plain][] [copy to clipboard][view plain] [print][view plain] [?][view plain]

1.  **typedef** **struct** \_log\_st log\_st;  
2.  **struct** \_log\_st  
3.  \{  
4.      **char** path\[128\];  
5.      **int** fd;  
6.      **int** size;  
7.      **int** level;  
8.      **int** num;  
9.  \};

**三、定义log\_init函数**  
参数说明：path——您要存储的文件路径；size——单个文件的最大大小，如果超过该大小则新建新的文件用来存储；level——日志输出方式，建议在上层限制其值的范围为0到3，0表示日志既不输出到屏幕也不创建文件和保存到文件，1表示日志保存到文件但不输出到屏幕，2表示日志既输出到屏幕也保存到文件，3表示日志只输出到文件而不创建文件和存入文件；num——日志文件命名方式，非0表示以(int)time(NULL)作为文件名来保存文件，文件数量随着日志量的递增而递增；0表示以“.new”和“.bak”为文件名来保存文件，文件数量不超过两个，随着日志量的递增，旧的日志文件将被新的覆盖，更直观的说就是说.new”和“.bak”文件只保存最近的日志。

[view plain][] [copy to clipboard][view plain] [print][view plain] [?][view plain]

1.  log\_st \*log\_init(**char** \*path, **int** size, **int** level, **int** num)  
2.  \{  
3.      **char** new\_path\[128\] = \{0\};  
4.      **if** (NULL == path || 0 == level) **return** NULL;  
5.      log\_st \*log = (log\_st \*)malloc(**sizeof**(log\_st));  
6.      memset(log, 0, **sizeof**(log\_st));  
7.      **if** (level != 3)  
8.      \{  
9.          //the num use to control file naming  
10.         log->num = num;  
11.         **if**(num)  
12.             snprintf(new\_path, 128, "%s%d", path, (**int**)time(NULL));  
13.         **else**  
14.             snprintf(new\_path, 128, "%s.new", path);  
15.         **if**(-1 == (log->fd = open(new\_path, O\_RDWR|O\_APPEND|O\_CREAT|O\_SYNC, S\_IRUSR|S\_IWUSR|S\_IROTH)))  
16.         \{  
17.             free(log);  
18.             log = NULL;  
19.             **return** NULL;  
20.         \}  
21.     \}  
22.     strncpy(log->path, path, 128);  
23.     log->size = (size > 0 ? size:0);  
24.     log->level = (level > 0 ? level:0);  
25.     **return** log;  
26. \}

**四、定义log\_debug函数**

[view plain][] [copy to clipboard][view plain] [print][view plain] [?][view plain]

1.  **void** log\_debug(log\_st \*log, **const** **char** \*msg, ...)  
2.  \{  
3.      **va\_list** ap;  
4.      **time\_t** now;  
5.      **char** \*pos;  
6.      **char** \_n = '\\n';  
7.      **char** message\[BUF\_SIZE\] = \{0\};  
8.      **int** nMessageLen = 0;  
9.      **int** sz;  
10.     **if**(NULL == log || 0 == log->level) **return**;  
11.     now = time(NULL);  
12.     pos = ctime(&now);  
13.     sz = strlen(pos);  
14.     pos\[sz-1\]='\]';  
15.     snprintf(message, BUF\_SIZE, "\[%s ", pos);  
16.     **for** (pos = message; \*pos; pos++);  
17.     sz = pos - message;  
18.     va\_start(ap, msg);  
19.     nMessageLen = vsnprintf(pos, BUF\_SIZE - sz, msg, ap);  
20.     va\_end(ap);  
21.     **if** (nMessageLen <= 0) **return**;  
22.     **if** (3 == log->level)  
23.     \{  
24.         printf("%s\\n", message);  
25.         **return**;  
26.     \}  
27.     **if** (2 == log->level)  
28.         printf("%s\\n", message);  
29.     write(log->fd, message, strlen(message));  
30.     write(log->fd, &\_n, 1);  
31.     fsync(log->fd);  
32. \}

**五、定义log\_checksize函数**

[view plain][] [copy to clipboard][view plain] [print][view plain] [?][view plain]

1.  **void** log\_checksize(log\_st \*log)  
2.  \{  
3.      **struct** stat stat\_buf;  
4.      **char** new\_path\[128\] = \{0\};  
5.      **char** bak\_path\[128\] = \{0\};  
6.      **if**(NULL == log || 3 == log->level || '\\0' == log->path\[0\]) **return**;  
7.      memset(&stat\_buf, 0, **sizeof**(**struct** stat));  
8.      fstat(log->fd, &stat\_buf);  
9.      **if**(stat\_buf.st\_size > log->size)  
10.     \{  
11.         close(log->fd);  
12.         **if**(log->num)  
13.             snprintf(new\_path, 128, "%s%d", log->path, (**int**)time(NULL));  
14.         **else**  
15.         \{  
16.             snprintf(bak\_path, 128, "%s.bak", log->path);  
17.             snprintf(new\_path, 128, "%s.new", log->path);  
18.             remove(bak\_path); //delete the file \*.bak first  
19.             rename(new\_path, bak\_path); //change the name of the file \*.new to \*.bak  
20.         \}  
21.         //create a new file  
22.         log->fd = open(new\_path, O\_RDWR|O\_APPEND|O\_CREAT|O\_SYNC, S\_IRUSR|S\_IWUSR|S\_IROTH);  
23.     \}  
24. \}

[C]: http://www.cpplive.com/html/tag/c-language
[Link 1]: http://www.cpplive.com/html/tag/function
[Link 2]: http://www.cpplive.com/html/tag/log
[Link 3]: http://www.cpplive.com/html/tag/macro-variables
[view plain]: http://www.cpplive.com/html/871.html#