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(...)
#endifint main() {DEBUG_PRINTF("This is a debug message.\n"); // 只有当CURRENT_LOG_LEVEL >= LOG_LEVEL_DEBUG时才会打印INFO_PRINTF("This is an info message.\n");  // 始终打印,因为默认级别为INFOWARN_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, ...);#endif

log.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 32typedef 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"
};
#endifstatic void stdout_callback(log_Event *ev) {char buf[16];buf[strftime(buf, sizeof(buf), "%H:%M:%S", ev->time)] = '\0';
#ifdef LOG_USE_COLORfprintf(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);
#elsefprintf(ev->udata, "%s %-5s %s:%d: ",buf, level_strings[ev->level], ev->file, ev->line);
#endifvfprintf(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. 在实际应用中,可以使用更复杂的日志框架或库来增强日志记录的功能,例如设置日志级别过滤、日志滚动等。

如有侵权,或需要完整代码,请及时联系博主。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.xdnf.cn/news/2128.html

如若内容造成侵权/违法违规/事实不符,请联系一条长河网进行投诉反馈,一经查实,立即删除!

相关文章

默认路由:实现内网所有网段流量走一条默认路由访问外网

默认路由 Tip&#xff1a;默认路由一般指出口网关设备的出口路由。实现所有网段流量都走一条路由。 实验模拟&#xff1a;公司内部pc 通过出口网关 访问运营商内部 baidu服务 isp网关配置&#xff1a; <Huawei>sy Enter system view, return user view with CtrlZ. …

蘑菇书(EasyRL)学习笔记(2)

1、序列决策 1.1、智能体和环境 如下图所示&#xff0c;序列决策过程是智能体与环境之间的交互&#xff0c;智能体通过动作影响环境&#xff0c;环境则返回观测和奖励。智能体的目标是从这些反馈中学习出能最大化长期奖励的策略&#xff0c;这一过程通过不断试错和调整实现强化…

【C语言刷力扣】28.找出字符串中第一个匹配项的下标

题目&#xff1a; 解题思路&#xff1a; 暴力算法 int strStr(char* haystack, char* needle) {int n strlen(haystack), m strlen(needle);for (int i 0; i m < n; i) {bool res true;for (int j 0; j < m; j) {if (haystack[ji] ! needle[j]) {res false;break…

电脑没有下载声卡驱动怎么办?电脑声卡驱动安装方法

在日常使用电脑的过程中&#xff0c;我们可能会遇到电脑没有声音的问题&#xff0c;这往往与声卡驱动缺失或损坏有关。声卡驱动是连接电脑硬件&#xff08;声卡&#xff09;与操作系统之间的桥梁&#xff0c;确保音频信号能够正常输入输出。那么&#xff0c;当电脑没有声卡驱动…

favicon是什么文件?如何制作网站ico图标?

一般我们做网站的话&#xff0c;都会制作一个独特的ico图标&#xff0c;命名为favicon.ico。这个ico图标一般会出现在浏览器网页标题前面。如下图红色箭头所示&#xff1a; 部分博客导航大全也会用到所收录网站的ico图标。比如boke123导航新收录的网站就不再使用网站首页缩略图…

路由策略与路由控制

1. 路由控制概述 2. 路由控制工具 2.1 路由匹配工具 访问控制列表&#xff08;Access Control List, ACL&#xff09;是一个匹配工具。 由若干条 permit / deny 组成的ACL规则组成。 ACL 匹配原则&#xff1a; 一旦命中即停止匹配 ACL在做路由匹配时&#xff0c;更多是匹配…

天生倔强脸的白纸新人,徐畅演艺生涯初舞台获得肯定!

国内首档“微短剧综艺”创新真人秀《开播&#xff01;短剧季》已播出四期&#xff0c;节目集结20余位青年演员竞演角逐&#xff0c;进行经典IP的“二度创作”&#xff0c;最终实现短剧IP孵化。在最新一期正片中&#xff0c;新人演员徐畅凭借一段《离婚律师》的试镜表演&#xf…

Spring Boot解决 406 错误之返回对象缺少Getter/Setter方法引发的问题

目录 前言1. 问题背景2. 问题分析2.1 检查返回对象 3. 解决方案3.1 确保Controller返回Result类型3.2 测试接口响应 4. 原理探讨5. 常见问题排查与优化建议结语 前言 在Spring Boot开发中&#xff0c;接口请求返回数据是系统交互的重要环节&#xff0c;尤其在开发RESTful风格的…

第二十八天|贪心算法|122.买卖股票的最佳时机II,55. 跳跃游戏,45.跳跃游戏II,1005.K次取反后最大化的数组和

目录 122.买卖股票的最佳时机II 方法1&#xff1a;贪心算法&#xff08;简单&#xff09; 方法2&#xff1a;动态规划 55. 跳跃游戏 45.跳跃游戏II 方法1 方法2&#xff08;简洁版&#xff09; 1005.K次取反后最大化的数组和 按照绝对值大小从大到小排序一次 两次排序…

PureMVC在Unity中的使用(含下载链接)

前言 Pure MVC是在基于模型、视图和控制器MVC模式建立的一个轻量级的应用框架&#xff0c;这种开源框架是免费的&#xff0c;它最初是执行的ActionScript 3语言使用的Adobe Flex、Flash和AIR&#xff0c;已经移植到几乎所有主要的发展平台&#xff0c;支持两个版本框架&#xf…

Python CGI编程-cookie的设置、检索

设置检索 其他&#xff1a; 1. http.cookies和http.cookiejar区别&#xff1a; http.cookies主要用于创建和操作单个cookie对象&#xff0c;适用于需要精细控制单个cookie属性的场景。http.cookiejar则用于管理多个cookie&#xff0c;适用于需要自动处理多个请求和响应中的coo…

算法实现 - 快速排序(Quick Sort) - 理解版

文章目录 算法介绍算法分析核心思想三个版本运行过程挖坑法Hoare 原版前后指针法 算法稳定性和复杂度稳定性时间复杂度平均情况O(nlogn)最差情况O( n 2 n^2 n2) 空间复杂度 算法介绍 快速排序是一种高效的排序算法&#xff0c;由英国计算机科学家C. A. R. Hoare在1960年提出&a…

探索Python新境界:Buzhug库的神秘面纱

文章目录 探索Python新境界&#xff1a;Buzhug库的神秘面纱第一部分&#xff1a;背景介绍第二部分&#xff1a;Buzhug库是什么&#xff1f;第三部分&#xff1a;如何安装Buzhug库&#xff1f;第四部分&#xff1a;Buzhug库函数使用方法第五部分&#xff1a;Buzhug库使用场景第六…

Samtec 技术大咖说 | PCB VS 电缆背板?

【摘要/前言】 选择背板设计需要对特定的网络拓扑结构和应用进行权衡。在某些情况下&#xff0c;对PCB与电缆背板的评估不是 "非此即彼"&#xff0c;而是一种组合方式。 Samtec的工程师Andrew Josephson、Brandon Gore和Jonathan Sprigler进行了一次讨论&#xff0c…

一文解析axios源码

写了几年项目&#xff0c;也用了几年的axios&#xff0c;但是一直也不是很了解其中的原理&#xff0c;为啥他能请求前拦截&#xff0c;也为啥他能响应后拦截&#xff0c;正好有空&#xff0c;所以对他的源码进行分析&#xff0c;从github把他的源码拉下来进行分析: 从package.…

Linux权限问题(账号切换,权限,粘滞位)

1.什么是权限&#xff1f; 在Linux下有两种用户&#xff0c;分别是超级用户&#xff08;root&#xff09;和普通用户。超级用户可以在Linux下做任何事情&#xff0c;几乎不受限制&#xff0c;而普通用户一般只能在自己的工作目录下&#xff08;/home/xxx&#xff09;工作&#…

暴雨高频交易服务器,解决金融行业痛点

随着计算机技术、大数据、人工智能和通信技术的飞速发展&#xff0c;金融市场的交易方式迎来了革命性变化。交易决策和执行过程自动化、智能化&#xff0c;极大提高了交易效率和速度&#xff0c;推动了金融行业的整体创新和发展。 在技术的不断进步和全球金融市场的数字化转型…

三、Kafka集群

一、Kafka集群的概念 1、目的 高并发、高可用、动态扩展。 主备数据架构、双活节点、灾备数据中心。 如果是服务的地理范围过大也可以使不同的集群节点服务不同的区域&#xff0c;降低网络延迟。 2、Kafka集群的基本概念 1&#xff09;复制&#xff08;镜像&#xff09; kaf…

基于 Transformer 的语言模型

基于 Transformer 的语言模型 Transformer 是一类基于注意力机制&#xff08;Attention&#xff09;的模块化构建的神经网络结构。给定一个序列&#xff0c;Transformer 将一定数量的历史状态和当前状态同时输入&#xff0c;然后进行加权相加。对历史状态和当前状态进行“通盘…

大数据之文件服务器方案

大数据文件服务器方案 一&#xff0c;文件服务器常用框架 二&#xff0c;文件服务器常用框架的实现技术 文件服务器常用框架 文件服务器是一种专门用于存储、管理和共享文件的服务器&#xff0c;其常用框架的实现技术涉及多个方面&#xff0c;以下是一些主要的实现技术及其详…