T31开发笔记:简单的Log日记输出
若该文为原创文章，转载请注明原文出处。
在项目开发过程中，调试很常使用到log日记输出，一个好的输出框架有助于分析问题和定位问题。
这里测试了两种方式：
一、使用宏定义控制日记输出
二、保存成文件日记输出
第一种方式在单片机上很常用到，也适用于嵌入式；第二种方式只能在嵌入式。
一、使用宏定义控制日记输出
宏定义调试开关的好处
1. 提高开发效率：在开发阶段，可以通过打开调试信息输出（即保持#if 1），快速定位问题、理解程序运行流程。这有助于开发者更快地发现并修复逻辑错误或不符合预期的行为。
2. 优化发布版本：当程序进入测试或最终发布阶段时，可以通过关闭调试信息输出（修改为#if 0），去除所有DBUG_PRINTF相关的代码执行，这样做不仅可以减少代码体积，还能提高程序的运行效率，因为不必要的IO操作（打印到控制台）被省略了。
3. 灵活性与可维护性：这种通过宏定义控制日志输出的方式，提供了一种灵活的机制来调整程序的调试级别。不需要修改代码中的每一个打印语句，只需简单修改宏定义即可全局控制日志的开关，便于维护和版本管理。
4. 减少副作用：调试信息的输出，尤其是大量或频繁的打印，可能会引入额外的性能开销，甚至影响程序的正常行为（比如延时、竞态条件）。通过这种方式控制输出，可以在不影响程序逻辑的前提下，进行性能测试或在资源受限环境下运行。
测试代码：
#include <stdio.h>
// 定义日志级别
#define LOG_LEVEL_DEBUG 1
#define LOG_LEVEL_INFO 2
#define LOG_LEVEL_WARN 3
#define LOG_LEVEL_ERROR 4
// 设置当前日志级别，默认为INFO级别
#define CURRENT_LOG_LEVEL LOG_LEVEL_INFO
// 宏定义日志输出函数
#if CURRENT_LOG_LEVEL >= LOG_LEVEL_DEBUG
#define DEBUG_PRINTF(...) printf("DEBUG: " __VA_ARGS__)
#else
#define DEBUG_PRINTF(...)
#endif
#if CURRENT_LOG_LEVEL >= LOG_LEVEL_INFO
#define INFO_PRINTF(...) printf("INFO: " __VA_ARGS__)
#else
#define INFO_PRINTF(...)
#endif
#if CURRENT_LOG_LEVEL >= LOG_LEVEL_WARN
#define WARN_PRINTF(...) printf("WARN: " __VA_ARGS__)
#else
#define WARN_PRINTF(...)
#endif
#if CURRENT_LOG_LEVEL >= LOG_LEVEL_ERROR
#define ERROR_PRINTF(...) printf("ERROR: " __VA_ARGS__)
#else
#define ERROR_PRINTF(...)
#endif
int main() {
DEBUG_PRINTF("This is a debug message.\n"); // 只有当CURRENT_LOG_LEVEL >= LOG_LEVEL_DEBUG时才会打印
INFO_PRINTF("This is an info message.\n"); // 始终打印，因为默认级别为INFO
WARN_PRINTF("This is a warning message.\n"); // 如果级别设置得当，则会打印
ERROR_PRINTF("This is an error message.\n"); // 重要，总是打印
return 0;
}
代码使用宏定义来控制不同级别的日志输出，包括调试(debug)、信息(info)、警告(warning)和错误(error)级别。通过修改CURRENT_LOG_LEVEL的值，可以轻松地全局控制哪些级别的日志会被打印出来。
二、保存成文件日记输出
这种方式只能在嵌入式下运行。
直接上源码：
log.h
/**
* Copyright (c) 2020 rxi
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MIT license. See `log.c` for details.
*/
#ifndef LOG_H
#define LOG_H
#include <stdio.h>
#include <stdarg.h>
#include <stdbool.h>
#include <time.h>
#define LOG_VERSION "0.1.0"
typedef struct {
va_list ap;
const char *fmt;
const char *file;
struct tm *time;
void *udata;
int line;
int level;
} log_Event;
typedef void (*log_LogFn)(log_Event *ev);
typedef void (*log_LockFn)(bool lock, void *udata);
enum { LOG_TRACE, LOG_DEBUG, LOG_INFO, LOG_WARN, LOG_ERROR, LOG_FATAL };
#define log_trace(...) log_log(LOG_TRACE, __FILE__, __LINE__, __VA_ARGS__)
#define log_debug(...) log_log(LOG_DEBUG, __FILE__, __LINE__, __VA_ARGS__)
#define log_info(...) log_log(LOG_INFO, __FILE__, __LINE__, __VA_ARGS__)
#define log_warn(...) log_log(LOG_WARN, __FILE__, __LINE__, __VA_ARGS__)
#define log_error(...) log_log(LOG_ERROR, __FILE__, __LINE__, __VA_ARGS__)
#define log_fatal(...) log_log(LOG_FATAL, __FILE__, __LINE__, __VA_ARGS__)
const char* log_level_string(int level);
void log_set_lock(log_LockFn fn, void *udata);
void log_set_level(int level);
void log_set_quiet(bool enable);
int log_add_callback(log_LogFn fn, void *udata, int level);
int log_add_fp(FILE *fp, int level);
void log_log(int level, const char *file, int line, const char *fmt, ...);
#endiflog.c
/*
* Copyright (c) 2020 rxi
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#include "log.h"
#define MAX_CALLBACKS 32
typedef struct {
log_LogFn fn;
void *udata;
int level;
} Callback;
static struct {
void *udata;
log_LockFn lock;
int level;
bool quiet;
Callback callbacks[MAX_CALLBACKS];
} L;
static const char *level_strings[] = {
"TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
};
#ifdef LOG_USE_COLOR
static const char *level_colors[] = {
"\x1b[94m", "\x1b[36m", "\x1b[32m", "\x1b[33m", "\x1b[31m", "\x1b[35m"
};
#endif
static void stdout_callback(log_Event *ev) {
char buf[16];
buf[strftime(buf, sizeof(buf), "%H:%M:%S", ev->time)] = '\0';
#ifdef LOG_USE_COLOR
fprintf(
ev->udata, "%s %s%-5s\x1b[0m \x1b[90m%s:%d:\x1b[0m ",
buf, level_colors[ev->level], level_strings[ev->level],
ev->file, ev->line);
#else
fprintf(
ev->udata, "%s %-5s %s:%d: ",
buf, level_strings[ev->level], ev->file, ev->line);
#endif
vfprintf(ev->udata, ev->fmt, ev->ap);
fprintf(ev->udata, "\n");
fflush(ev->udata);
}
static void file_callback(log_Event *ev) {
char buf[64];
buf[strftime(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S", ev->time)] = '\0';
fprintf(
ev->udata, "%s %-5s %s:%d: ",
buf, level_strings[ev->level], ev->file, ev->line);
vfprintf(ev->udata, ev->fmt, ev->ap);
fprintf(ev->udata, "\n");
fflush(ev->udata);
}
static void lock(void) {
if (L.lock) { L.lock(true, L.udata); }
}
static void unlock(void) {
if (L.lock) { L.lock(false, L.udata); }
}
const char* log_level_string(int level) {
return level_strings[level];
}
void log_set_lock(log_LockFn fn, void *udata) {
L.lock = fn;
L.udata = udata;
}
void log_set_level(int level) {
L.level = level;
}
void log_set_quiet(bool enable) {
L.quiet = enable;
}
int log_add_callback(log_LogFn fn, void *udata, int level) {
for (int i = 0; i < MAX_CALLBACKS; i++) {
if (!L.callbacks[i].fn) {
L.callbacks[i] = (Callback) { fn, udata, level };
return 0;
}
}
return -1;
}
int log_add_fp(FILE *fp, int level) {
return log_add_callback(file_callback, fp, level);
}
static void init_event(log_Event *ev, void *udata) {
if (!ev->time) {
time_t t = time(NULL);
ev->time = localtime(&t);
}
ev->udata = udata;
}
void log_log(int level, const char *file, int line, const char *fmt, ...) {
log_Event ev = {
.fmt = fmt,
.file = file,
.line = line,
.level = level,
};
lock();
if (!L.quiet && level >= L.level) {
init_event(&ev, stderr);
va_start(ev.ap, fmt);
stdout_callback(&ev);
va_end(ev.ap);
}
for (int i = 0; i < MAX_CALLBACKS && L.callbacks[i].fn; i++) {
Callback *cb = &L.callbacks[i];
if (level >= cb->level) {
init_event(&ev, cb->udata);
va_start(ev.ap, fmt);
cb->fn(&ev);
va_end(ev.ap);
}
}
unlock();
}主函数示例
在 main 函数中，调用了 log 函数记录不同级别的日志信息。
注意事项
1. 确保文件权限允许写入。
2. 在生产环境中，通常会在日志记录函数中添加错误处理逻辑，以确保日志记录的健壮性。
3. 如果日志文件很大，可以考虑定期归档或分割日志文件。
4. 在实际应用中，可以使用更复杂的日志框架或库来增强日志记录的功能，例如设置日志级别过滤、日志滚动等。
如有侵权，或需要完整代码，请及时联系博主。
原文地址：https://blog.csdn.net/weixin_38807927/article/details/143489770
免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！