youmetme/logging
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases 2 Wiki Activity

refactor: 优化日志系统，支持多日志器

Browse Source
This commit is contained in:
你遇了我
2025-09-15 13:35:16 +08:00
parent 8ac539eb79
commit 9fce78a59e
5 changed files with 237 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
include/logging.h
View File

@@ -3,6 +3,7 @@
#include <stdarg.h> #include <stdarg.h>
#include <stdbool.h> #include <stdbool.h>
#include <stddef.h>
#include "logging/logging-core.h" #include "logging/logging-core.h"
#include "logging/logging-filter.h" #include "logging/logging-filter.h"
@@ -12,51 +13,77 @@
extern "C" { extern "C" {
#endif #endif
#define log_fatal(format, ...) \ // 默认日志器宏
_log_fatal(__FILE__, __LINE__, format, ##__VA_ARGS__) #define Log_fatal(format, ...) \
#define log_error(format, ...) \ _log_fatal(NULL, __FILE__, __LINE__, format, ##__VA_ARGS__)
_log_error(__FILE__, __LINE__, format, ##__VA_ARGS__) #define Log_error(format, ...) \
#define log_warning(format, ...) \ _log_error(NULL, __FILE__, __LINE__, format, ##__VA_ARGS__)
_log_warning(__FILE__, __LINE__, format, ##__VA_ARGS__) #define Log_warning(format, ...) \
#define log_info(format, ...) \ _log_warning(NULL, __FILE__, __LINE__, format, ##__VA_ARGS__)
_log_info(__FILE__, __LINE__, format, ##__VA_ARGS__) #define Log_info(format, ...) \
#define log_debug(format, ...) \ _log_info(NULL, __FILE__, __LINE__, format, ##__VA_ARGS__)
_log_debug(__FILE__, __LINE__, format, ##__VA_ARGS__) #define Log_debug(format, ...) \
_log_debug(NULL, __FILE__, __LINE__, format, ##__VA_ARGS__)
// 日志器宏
#define log_fatal(logger, format, ...) \
_log_fatal(logger, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define log_error(logger, format, ...) \
_log_error(logger, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define log_warning(logger, format, ...) \
_log_warning(logger, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define log_info(logger, format, ...) \
_log_info(logger, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define log_debug(logger, format, ...) \
_log_debug(logger, __FILE__, __LINE__, format, ##__VA_ARGS__)
typedef struct Logger { typedef struct Logger {
log_level level; log_level level;
log_Handler *handler; log_Handler *handler;
log_filter *filter; log_filter *filter;
const char *name; const char *name;
bool (*addHandler)(log_Handler *handler);
bool (*addFilter)(log_filter *filter);
} Logger; } Logger;
void _log_fatal(const char *file, int line, const char *format, ...); bool addHandler(Logger *logger, log_Handler *handler);
void _log_error(const char *file, int line, const char *format, ...); bool addFilter(Logger *logger, log_filter *filter);
void _log_warning(const char *file, int line, const char *format, ...);
void _log_info(const char *file, int line, const char *format, ...); void _log_fatal(
void _log_debug(const char *file, int line, const char *format, ...); Logger *logger, const char *file, int line, const char *format, ...);
void _log_error(
Logger *logger, const char *file, int line, const char *format, ...);
void _log_warning(
Logger *logger, const char *file, int line, const char *format, ...);
void _log_info(
Logger *logger, const char *file, int line, const char *format, ...);
void _log_debug(
Logger *logger, const char *file, int line, const char *format, ...);
/** /**
* @brief * @brief 初始化默认日志对象
创建默认日志对象,日志对象为单例模式，后续可通过getDefaultLogger方法获取， * @param name 日志名称
重复调用该方法不会创建新的日志对象，只会返回默认日志对象，并且会修改默认日志对象的名称和等级 * @param level 日志等级
* @param name 日志名称 */
* @param level 日志等级 void initDefaultLogger(const char *name, log_level level);
* @return Logger* 日志对象指针
*/
Logger *newDefaultLogger(const char *name, log_level level);
/** /**
* @brief 获取默认日志对象 * @brief 获取默认日志对象
* @return 默认日志对象
*/ */
Logger *getDefaultLogger(void); Logger *getDefaultLogger(void);
Logger *getLogger(const char *name, log_level level);
/** /**
* @brief 销毁日志对象,该方法会销毁默认日志对象 * @brief 销毁日志对象,该方法会销毁默认日志对象
*/ */
log_status destroyDefaultLogger(void); void destroyDefaultLogger(void);
/**
* @brief 销毁日志对象
* @param logger 日志对象
* @return void
*/
void destroyLogger(Logger *logger);
#ifdef __cplusplus #ifdef __cplusplus
} }

225
src/logging.c
View File

@@ -24,17 +24,17 @@ static Logger *G_LOGGER = NULL; // 全局日志对象，唯一实例
* @brief 为日志添加一个handler * @brief 为日志添加一个handler
* @param handler 处理器对象 * @param handler 处理器对象
*/ */
static bool addHandler(log_Handler *handler) { bool addHandler(Logger *logger, log_Handler *handler) {
if (G_LOGGER == NULL || handler == NULL) { if (logger == NULL || handler == NULL) {
return false; return false;
} }
if (G_LOGGER->handler == NULL) { if (logger->handler == NULL) {
G_LOGGER->handler = handler; logger->handler = handler;
return true; return true;
} }
G_LOGGER->handler->_free(G_LOGGER->handler); logger->handler->_free(logger->handler);
G_LOGGER->handler = handler; logger->handler = handler;
return true; return true;
} }
@@ -42,21 +42,17 @@ static bool addHandler(log_Handler *handler) {
* @brief 为日志添加一个filter * @brief 为日志添加一个filter
* @param filter 过滤器对象 * @param filter 过滤器对象
*/ */
/** bool addFilter(Logger *logger, log_filter *filter) {
* @brief 为日志添加一个filter if (logger == NULL || filter == NULL) {
* @param filter 过滤器对象
*/
static bool addFilter(log_filter *filter) {
if (G_LOGGER == NULL || filter == NULL) {
return false; return false;
} }
if (G_LOGGER->filter == NULL) { if (logger->filter == NULL) {
G_LOGGER->filter = filter; logger->filter = filter;
G_LOGGER->filter->next = NULL; logger->filter->next = NULL;
return true; return true;
} }
log_filter *it = G_LOGGER->filter; log_filter *it = logger->filter;
while (it->next != NULL) { while (it->next != NULL) {
it = it->next; it = it->next;
} }
@@ -80,18 +76,26 @@ static bool addFilter(log_filter *filter) {
* @param color 应用的颜色 * @param color 应用的颜色
* @param message 日志内容 * @param message 日志内容
*/ */
static void output_to_handler(log_Handler *handler, static void output_to_handler(Logger *logger,
char *level, char *level,
const char *color, const char *color,
const char *message) { const char *message) {
Logger *_logger = NULL;
if (logger != NULL) {
_logger = logger;
} else {
_logger = G_LOGGER;
}
char timeStr[20]; char timeStr[20];
getTimeStr(timeStr); getTimeStr(timeStr);
char logStr[LOG_BUFFER_SIZE * 2]; char logStr[LOG_BUFFER_SIZE * 2];
if (handler->apply_color) { if (_logger->handler->apply_color) {
snprintf(logStr, snprintf(logStr,
LOG_BUFFER_SIZE * 2, LOG_BUFFER_SIZE * 2,
"[%s]: %s %s%s%s %s\n", "[%s]: %s %s%s%s %s\n",
G_LOGGER->name, _logger->name,
timeStr, timeStr,
color, color,
level, level,
@@ -101,13 +105,13 @@ static void output_to_handler(log_Handler *handler,
snprintf(logStr, snprintf(logStr,
LOG_BUFFER_SIZE * 2, LOG_BUFFER_SIZE * 2,
"[%s]: %s %s %s\n", "[%s]: %s %s %s\n",
G_LOGGER->name, _logger->name,
timeStr, timeStr,
level, level,
message); message);
} }
handler->output(handler, logStr); _logger->handler->output(_logger->handler, logStr);
} }
/** /**
@@ -118,34 +122,49 @@ static void output_to_handler(log_Handler *handler,
* @param ... 格式化参数列表 * @param ... 格式化参数列表
* @return * @return
*/ */
static void log_cope(log_level level_e, static void
char *level, log_cope(Logger *logger, char *level, const char *color, const char *message) {
const char *color, Logger *_logger = NULL;
const char *message) {
if (G_LOGGER == NULL) { if (logger != NULL) {
_logger = logger;
} else {
_logger = G_LOGGER;
}
if (_logger == NULL) {
return; return;
} }
if (G_LOGGER->handler == NULL) { if (_logger->handler == NULL) {
return; return;
} }
log_filter *it = G_LOGGER->filter; log_filter *it = _logger->filter;
log_Handler *handler = G_LOGGER->handler; log_Handler *handler = _logger->handler;
while (it != NULL) { while (it != NULL) {
if (it->_dispose(it, level_e, message)) { if (it->_dispose(it, _logger->level, message)) {
output_to_handler(it->handler, level, color, message); output_to_handler(_logger, level, color, message);
if (it->jump_out) { if (it->jump_out) {
return; return;
} }
} }
it = it->next; it = it->next;
} }
output_to_handler(handler, level, color, message); output_to_handler(_logger, level, color, message);
} }
void _log_fatal(const char *file, int line, const char *message, ...) { void _log_fatal(
if (G_LOGGER->level >= LOG_ERROR) { Logger *logger, const char *file, int line, const char *message, ...) {
Logger *_logger = NULL;
if (logger != NULL) {
_logger = logger;
} else {
_logger = G_LOGGER;
}
if (_logger->level >= LOG_ERROR) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
char finalLogStr[LOG_BUFFER_SIZE * 2]; char finalLogStr[LOG_BUFFER_SIZE * 2];
va_list args; va_list args;
@@ -154,12 +173,21 @@ void _log_fatal(const char *file, int line, const char *message, ...) {
va_end(args); va_end(args);
snprintf( snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr); finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_FATAL, "Fatal", RED_B, finalLogStr); log_cope(_logger, "Fatal", RED_B, finalLogStr);
} }
} }
void _log_error(const char *file, int line, const char *message, ...) { void _log_error(
if (G_LOGGER->level >= LOG_ERROR) { Logger *logger, const char *file, int line, const char *message, ...) {
Logger *_logger = NULL;
if (logger != NULL) {
_logger = logger;
} else {
_logger = G_LOGGER;
}
if (_logger->level >= LOG_ERROR) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
char finalLogStr[LOG_BUFFER_SIZE * 2]; char finalLogStr[LOG_BUFFER_SIZE * 2];
va_list args; va_list args;
@@ -168,12 +196,21 @@ void _log_error(const char *file, int line, const char *message, ...) {
va_end(args); va_end(args);
snprintf( snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr); finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_ERROR, "Error", RED, finalLogStr); log_cope(_logger, "Error", RED, finalLogStr);
} }
} }
void _log_warning(const char *file, int line, const char *message, ...) { void _log_warning(
if (G_LOGGER->level >= LOG_WARNING) { Logger *logger, const char *file, int line, const char *message, ...) {
Logger *_logger = NULL;
if (logger != NULL) {
_logger = logger;
} else {
_logger = G_LOGGER;
}
if (_logger->level >= LOG_WARNING) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
char finalLogStr[LOG_BUFFER_SIZE * 2]; char finalLogStr[LOG_BUFFER_SIZE * 2];
va_list args; va_list args;
@@ -182,12 +219,21 @@ void _log_warning(const char *file, int line, const char *message, ...) {
va_end(args); va_end(args);
snprintf( snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr); finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_WARNING, "Warning", YELLOW, finalLogStr); log_cope(_logger, "Warning", YELLOW, finalLogStr);
} }
} }
void _log_info(const char *file, int line, const char *message, ...) { void _log_info(
if (G_LOGGER->level >= LOG_INFO) { Logger *logger, const char *file, int line, const char *message, ...) {
Logger *_logger = NULL;
if (logger != NULL) {
_logger = logger;
} else {
_logger = G_LOGGER;
}
if (_logger->level >= LOG_INFO) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
char finalLogStr[LOG_BUFFER_SIZE * 2]; char finalLogStr[LOG_BUFFER_SIZE * 2];
va_list args; va_list args;
@@ -196,12 +242,21 @@ void _log_info(const char *file, int line, const char *message, ...) {
va_end(args); va_end(args);
snprintf( snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr); finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_INFO, "Info", GREEN, finalLogStr); log_cope(_logger, "Info", GREEN, finalLogStr);
} }
} }
void _log_debug(const char *file, int line, const char *message, ...) { void _log_debug(
if (G_LOGGER->level >= LOG_DEBUG) { Logger *logger, const char *file, int line, const char *message, ...) {
Logger *_logger = NULL;
if (logger != NULL) {
_logger = logger;
} else {
_logger = G_LOGGER;
}
if (_logger->level >= LOG_DEBUG) {
char logStr[LOG_BUFFER_SIZE]; char logStr[LOG_BUFFER_SIZE];
char finalLogStr[LOG_BUFFER_SIZE * 2]; char finalLogStr[LOG_BUFFER_SIZE * 2];
va_list args; va_list args;
@@ -210,35 +265,59 @@ void _log_debug(const char *file, int line, const char *message, ...) {
va_end(args); va_end(args);
snprintf( snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr); finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_DEBUG, "Debug", CYAN, finalLogStr); log_cope(_logger, "Debug", CYAN, finalLogStr);
} }
} }
Logger *newDefaultLogger(const char *name, log_level level) { /**
* @brief 初始化默认日志器
* @param name 日志器名称
* @param level 日志等级
* @return 日志器对象
*/
void initDefaultLogger(const char *name, log_level level) {
if (G_LOGGER != NULL) { if (G_LOGGER != NULL) {
G_LOGGER->name = name; G_LOGGER->name = name;
G_LOGGER->level = level; G_LOGGER->level = level;
return G_LOGGER;
} }
Logger *logger = (Logger *)malloc(sizeof(Logger)); Logger *logger = (Logger *)malloc(sizeof(Logger));
logger->addHandler = addHandler; logger->level = level;
logger->addFilter = addFilter; logger->handler = loggingHandlerConsole();
logger->name = name;
logger->filter = NULL;
logger->level = level; G_LOGGER = logger;
logger->handler = loggingHandlerConsole(); }
logger->name = name;
logger->filter = NULL;
G_LOGGER = logger; Logger *getDefaultLogger(void) { return G_LOGGER; }
return G_LOGGER;
/**
* @brief 获取日志器对象
* @param name 日志器名称
* @param level 日志等级
* @return 日志器对象
*/
Logger *getLogger(const char *name, log_level level) {
if (name == NULL) {
return NULL;
}
Logger *logger = (Logger *)malloc(sizeof(Logger));
logger->level = level;
logger->handler = loggingHandlerConsole();
logger->name = name;
logger->filter = NULL;
return logger;
} }
/** /**
* @brief 销毁日志对象 * @brief 销毁日志对象
*/ */
log_status destroyDefaultLogger(void) { void destroyDefaultLogger(void) {
if (G_LOGGER != NULL) { if (G_LOGGER != NULL) {
if (G_LOGGER->handler != NULL) { if (G_LOGGER->handler != NULL) {
G_LOGGER->handler->_free(G_LOGGER->handler); G_LOGGER->handler->_free(G_LOGGER->handler);
@@ -257,12 +336,24 @@ log_status destroyDefaultLogger(void) {
free(G_LOGGER); free(G_LOGGER);
G_LOGGER = NULL; G_LOGGER = NULL;
} }
return L_OK;
} }
Logger *getDefaultLogger(void) { void destroyLogger(Logger *logger) {
if (G_LOGGER == NULL) { if (logger != NULL) {
return NULL; if (logger->handler != NULL) {
logger->handler->_free(logger->handler);
}
if (logger->filter != NULL) {
log_filter *it = logger->filter;
log_filter *next = NULL;
while (it != NULL) {
next = it->next;
it->_free(it);
it = next;
}
}
free(logger);
} }
return G_LOGGER;
} }

26
tests/test-filter.c
View File

@@ -6,13 +6,13 @@
#include <time.h> #include <time.h>
int main() { int main() {
Logger *logger = newDefaultLogger(__FILE__, LOG_DEBUG); initDefaultLogger("test-filter", LOG_DEBUG);
log_info("This is an info message"); Log_info("This is an info message");
log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");
log_debug("This is a debug message"); Log_debug("This is a debug message");
log_warning("This is a warning message%s", "123"); Log_warning("This is a warning message%s", "123");
char *test1[] = {"This", NULL}; char *test1[] = {"This", NULL};
@@ -22,7 +22,7 @@ int main() {
loggingHandlerFile("test_interceptor", 1024 * 1024), loggingHandlerFile("test_interceptor", 1024 * 1024),
false); false);
logger->addFilter(tint); addFilter(getDefaultLogger(), tint);
char *test2[] = {"123", NULL}; char *test2[] = {"123", NULL};
@@ -32,17 +32,17 @@ int main() {
loggingHandlerFile("test_interceptor1", 1024 * 1024), loggingHandlerFile("test_interceptor1", 1024 * 1024),
true); true);
logger->addFilter(tint1); addFilter(getDefaultLogger(), tint1);
printf("\n"); printf("\n");
printf("filter added\n"); printf("filter added\n");
printf("\n"); printf("\n");
log_info("This is an info message"); Log_info("This is an info message");
log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");
log_debug("This is a debug message"); Log_debug("This is a debug message");
log_warning("This is a warning message%s", "123"); Log_warning("This is a warning message%s", "123");
destroyDefaultLogger(); destroyDefaultLogger();
return 0; return 0;

14
tests/test-log-file.c
View File

@@ -2,15 +2,15 @@
#include "logging/logging-handler.h" #include "logging/logging-handler.h"
int main() { int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG); initDefaultLogger("testLogger", LOG_DEBUG);
log_Handler *hander = loggingHandlerFile("test_log", 1024 * 1024 * 10); log_Handler *hander = loggingHandlerFile("test_log", 1024 * 1024 * 10);
logger->addHandler(hander); addHandler(getDefaultLogger(), hander);
log_info("This is an info message"); Log_info("This is an info message");
log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");
log_debug("This is a debug message"); Log_debug("This is a debug message");
log_warning("This is a warning message%s", "123"); Log_warning("This is a warning message%s", "123");
destroyDefaultLogger(); destroyDefaultLogger();
return 0; return 0;

12
tests/test-simple.c
View File

@@ -1,13 +1,13 @@
#include "logging.h" #include "logging.h"
int main() { int main() {
Logger *logger = newDefaultLogger(__FILE__, LOG_DEBUG); initDefaultLogger("simple", LOG_DEBUG);
log_info("This is an info message"); Log_info("This is an info message");
log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");
log_debug("This is a debug message"); Log_debug("This is a debug message");
log_warning("This is a warning message%s", "123"); Log_warning("This is a warning message%s", "123");
destroyDefaultLogger(); destroyDefaultLogger();
return 0; return 0;