C语言中的日志机制：打造全面强大的日志系统

news2024/9/30 8:47:58

前言

在软件开发中，良好的日志记录机制对于调试、监控程序状态和维护系统的稳定性至关重要。本文将介绍如何在C语言中构建一个全面强大的日志系统，并提供一些示例代码。

1. 日志的基本概念

日志级别：用于分类日志信息的重要性，如 DEBUG, INFO, WARNING, ERROR, CRITICAL 等。
日志消息：包含日志级别、时间戳、文件名、行号、消息内容等。
日志输出：日志可以输出到控制台、文件或网络服务等。

2. 日志级别宏定义

定义日志级别的宏，便于管理和调整日志输出。

1#define LOG_DEBUG 1
2#define LOG_INFO 2
3#define LOG_WARNING 3
4#define LOG_ERROR 4
5#define LOG_CRITICAL 5
6
7#define LOG_LEVEL LOG_DEBUG // 设置日志级别
8
9#define LOG(level, ...) \
10    do { \
11        if (level >= LOG_LEVEL) { \
12            fprintf(stderr, "[%s] %s:%d: ", logLevelToString(level), __FILE__, __LINE__); \
13            fprintf(stderr, __VA_ARGS__); \
14            fprintf(stderr, "\n"); \
15        } \
16    } while (0)
17
18static const char* logLevelToString(int level) {
19    switch (level) {
20        case LOG_DEBUG: return "DEBUG";
21        case LOG_INFO: return "INFO";
22        case LOG_WARNING: return "WARNING";
23        case LOG_ERROR: return "ERROR";
24        case LOG_CRITICAL: return "CRITICAL";
25        default: return "UNKNOWN";
26    }
27}

解释：

LOG_LEVEL 定义了当前的日志级别。
LOG 宏用于输出日志，根据日志级别过滤日志输出。
logLevelToString 函数将日志级别转换为字符串。

3. 使用日志宏

使用定义好的日志宏来记录日志。

1#include <stdio.h>
2
3int main() {
4    LOG(LOG_DEBUG, "This is a debug message.");
5    LOG(LOG_INFO, "This is an info message.");
6    LOG(LOG_WARNING, "This is a warning message.");
7    LOG(LOG_ERROR, "This is an error message.");
8    LOG(LOG_CRITICAL, "This is a critical message.");
9
10    return 0;
11}

输出:

1[DEBUG] main.c:17: This is a debug message.
2[INFO] main.c:18: This is an info message.
3[WARNING] main.c:19: This is a warning message.
4[ERROR] main.c:20: This is an error message.
5[CRITICAL] main.c:21: This is a critical message.

解释：

使用 LOG 宏记录不同级别的日志。

4. 日志到文件

将日志输出到文件。

1#include <stdio.h>
2#include <stdarg.h>
3#include <string.h>
4
5#define MAX_LOG_SIZE 1024
6
7void logToFile(const char *level, const char *file, int line, const char *fmt, ...) {
8    FILE *logfile = fopen("app.log", "a"); // 打开日志文件
9    if (logfile == NULL) {
10        perror("Failed to open log file");
11        return;
12    }
13
14    va_list args;
15    va_start(args, fmt);
16    char logBuffer[MAX_LOG_SIZE];
17    vsnprintf(logBuffer, MAX_LOG_SIZE - 1, fmt, args);
18    va_end(args);
19
20    time_t now = time(NULL);
21    struct tm *timeinfo = localtime(&now);
22    char timestamp[20];
23    strftime(timestamp, sizeof(timestamp), "%Y-%m-%d %H:%M:%S", timeinfo);
24
25    fprintf(logfile, "[%s] %s %s:%d: %s\n", level, timestamp, file, line, logBuffer);
26    fclose(logfile);
27}
28
29#define LOG(level, ...) \
30    do { \
31        if (level >= LOG_LEVEL) { \
32            logToFile(logLevelToString(level), __FILE__, __LINE__, __VA_ARGS__); \
33        } \
34    } while (0)

解释：

logToFile 函数用于将日志写入文件。
使用 vsnprintf 和 va_list 处理可变参数列表。
添加时间戳到日志消息。

5. 日志的旋转

实现日志文件的自动旋转，以便管理日志文件的大小。

1#include <stdio.h>
2#include <string.h>
3#include <errno.h>
4
5void rotateLog() {
6    FILE *logfile = fopen("app.log", "r");
7    if (logfile == NULL) {
8        perror("Failed to open log file");
9        return;
10    }
11
12    struct stat fileStat;
13    if (fstat(fileno(logfile), &fileStat) == -1) {
14        perror("Failed to get file status");
15        fclose(logfile);
16        return;
17    }
18
19    if (fileStat.st_size > 1024 * 1024) { // 如果日志文件大于1MB
20        fclose(logfile);
21        if (rename("app.log", "app.log.old") == -1) {
22            perror("Failed to rename log file");
23        }
24    } else {
25        fclose(logfile);
26    }
27}
28
29int main() {
30    // ... 日志记录代码 ...
31
32    // 在每次记录日志前检查是否需要旋转日志文件
33    rotateLog();
34    LOG(LOG_INFO, "This is an info message.");
35
36    return 0;
37}

解释：

rotateLog 函数检查日志文件大小，如果超过阈值，则重命名旧的日志文件。
在记录日志前调用 rotateLog。

6. 日志配置

实现日志配置的读取和设置。

1#include <stdio.h>
2#include <string.h>
3#include <stdlib.h>
4
5typedef struct {
6    int level;
7    char *filename;
8} LogConfig;
9
10LogConfig loadConfig() {
11    LogConfig config = {LOG_DEBUG, "app.log"};
12
13    FILE *configFile = fopen("log.conf", "r");
14    if (configFile == NULL) {
15        perror("Failed to open config file");
16        return config;
17    }
18
19    char line[256];
20    while (fgets(line, sizeof(line), configFile) != NULL) {
21        if (strncmp(line, "level=", 6) == 0) {
22            char *levelStr = line + 6;
23            config.level = atoi(levelStr);
24        } else if (strncmp(line, "filename=", 9) == 0) {
25            char *filename = line + 9;
26            config.filename = strdup(filename);
27        }
28    }
29
30    fclose(configFile);
31
32    return config;
33}
34
35void setLogLevel(LogConfig config) {
36    LOG_LEVEL = config.level;
37    // 更改 logToFile 函数中的日志文件名
38}
39
40int main() {
41    LogConfig config = loadConfig();
42    setLogLevel(config);
43
44    // ... 日志记录代码 ...
45
46    return 0;
47}

解释：