C语言中日志模块的使用

最新推荐文章于 2024-06-27 13:51:33 发布
最新推荐文章于 2024-06-27 13:51:33 发布
阅读量6.8k 收藏 67
点赞数 9
分类专栏： C语言学习 文章标签： C语言日志模块
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fangye945a/article/details/85695764
版权

       在产品研发的过程中，经常需要借助打印信息来帮助调试和后期维护。所以拥有一个完善的日志模块是至关重要的。

如下是从经手的项目中整理出来的日志模块及使用示例，以备后续项目开发时使用。

log.c

#include <stdio.h>
#include <stdlib.h>
#include <sys/time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <string.h>
#include <time.h>
#include <ctype.h>
#include <pthread.h>
#include "log.h"

/*存储日志的文件名*/

static unsigned char g_ucLogFileName[MAX_LOG_FILE_NUM][STR_COMM_SIZE] = {{0}};

/*指明是g_ucLogFileName中的哪个文件*/
static unsigned char g_ucLogFileNo = 0;

/*输出日志位置标记,0-输出到终端,1-输出到日志文件*/
unsigned long g_ulPrintLogPlaceFlag = 0;
/*是否打印调试日志标记,0-不打印调试日志,1-打印调试日志*/
unsigned long g_ulPrintDebugLogFlag = 0;

/*日志文件大小*/
static unsigned long g_ulLogFileSize = 0;

/*日志文件句柄*/
static FILE* pFile = NULL;

/*日志存储互斥锁*/
static pthread_mutex_t g_stSaveLogMutexLock;

/*日志模块初始化标记*/
static unsigned long g_ulLogInitFlag = 0;


void LOG_SetPrintLogPlaceFlag(unsigned long flag)
{
	g_ulPrintLogPlaceFlag = flag;
}

void LOG_SetPrintDebugLogFlag(unsigned long flag)
{
	g_ulPrintDebugLogFlag = flag;
}


/*****************************************************************
** 函数名: get_file_size
** 输　入: char *path
** 输　出:
** 功能描述:获取指令文件大小
** 返回值: long
****************************************************************/
static long get_file_size(const char *path)
{
	long filesize = -1;
	struct stat statbuff;
	
	if(stat(path, &statbuff) < 0){
	    return filesize;
	}
	else{
	    filesize = statbuff.st_size;
	}
	return filesize;
}

/*****************************************************************
** 函数名: unsigned long LOG_PrintLogTime
** 输　入:  unsigned long ulBufLen 存储时间的空间长度
** 输　出:unsigned char *ucTime  存储时间
** 功能描述:日志输出
** 返回值:unsigned long
****************************************************************/
unsigned long LOG_PrintLogTime(unsigned char *ucTime, unsigned long ulBufLen)
{
    struct tm* pstTmSec;
    struct timeval stTmMsec;
	
	if(NULL == ucTime)
	{
		return -1;
	}
	gettimeofday(&stTmMsec, NULL);
	pstTmSec = localtime(&stTmMsec.tv_sec);
	snprintf((char *)ucTime, ulBufLen - 1, "%04d-%02d-%02d %02d:%02d:%02d %03ldms",
            pstTmSec->tm_year + 1900, pstTmSec->tm_mon + 1, pstTmSec->tm_mday, pstTmSec->tm_hour, 
            pstTmSec->tm_min, pstTmSec->tm_sec, stTmMsec.tv_usec / 1000);
	
	return 0;
}

/*****************************************************************
** 函数名: 	unsigned char *LOG_LogTypeToStr
** 输　入:  	unsigned char ucType  日志类型
			unsigned long ulBufLen 存储日志类型字符串空间的长度
** 输　出:unsigned char *pucTypeString 根据日志类型将其转换成相应的字符串
** 功能描述:根据日志类型转换成相应的字符串
** 返回值:unsigned long
****************************************************************/
unsigned long LOG_LogTypeToStr(unsigned char ucType, unsigned char *pucTypeString, unsigned long ulBufLen)
{
	if(NULL == pucTypeString)
	{
		return -1;
	}
	/*防止发生越界*/
	ulBufLen -= 1;

	switch(ucType)
	{
		case LOG_DEBUG:
		{
			strncpy((char *)pucTypeString, "DEBUG", ulBufLen);
			break;
		}
		case LOG_ERROR:
		{
			strncpy((char *)pucTypeString, "ERROR", ulBufLen);
			break;
		}
		case LOG_WARNING:
		{
			strncpy((char *)pucTypeString, "WARNING", ulBufLen);
			break;
		}
		case LOG_ACTION:
		{
			strncpy((char *)pucTypeString, "ACTION", ulBufLen);
			break;
		}
		case LOG_SYSTEM:
		{
			strncpy((char *)pucTypeString, "SYSTEM", ulBufLen);
			break;
		}
		default:
		{
			strncpy((char *)pucTypeString, "UNKNOWN", ulBufLen);
			break;
		}
	}
	return 0;
}

/*****************************************************************
** 函数名: unsigned long LOG_OpenLogFile
** 输　入:  void
** 输　出:void
** 功能描述:打开日志文件
** 返回值:unsigned long
****************************************************************/
unsigned long LOG_OpenLogFile(void)
{
	char *path = (char*)g_ucLogFileName[g_ucLogFileNo];
	char *flag = NULL;
	int len = 0;
	
	/*判断文件是否已经打开*/
	if(NULL != pFile)
	{
		LOG_PRINT("[ACTION] file opened!");
		return 0;
	}
	/*判断文件名是否有定义*/
	if(NULL == path)
	{
		LOG_PRINT("[ERROR] file name is NULL.");
		return -1;
	}
	
	/*判断文件是否存在*/
	if (!access(path, 0))
	{
		/*获取文件大小*/
		if (0 > (len = get_file_size(path)))
		{
			LOG_PRINT("[ERROR] get file size failed!");
			return -1;
		}
	}
	flag = (len > 0 && len < g_ulLogFileSize) ? "a" : "w";
	
	/*打开文件*/
	pFile = fopen(path, flag);
	if(NULL == pFile)
	{
		LOG_PRINT("[ERROR] open file failed!");
		return -1;
	}
	LOG_PRINT("[DEBUG] open file name = %s", path);
	return 0;
}

/*****************************************************************
** 函数名: LOG_PrintLog
** 输　入:  unsigned char *ucLogInfo  需要打印或者存储的日志信息
			unsigned char ucType 日志类型
** 输　出:void
** 功能描述:日志输出
** 返回值:unsigned long
****************************************************************/
unsigned long LOG_PrintLog(unsigned char ucType, unsigned char *pucLogInfo)
{
	unsigned long ulResult = 0;
	unsigned long ulFileLen = 0;
	unsigned char ucTime[STR_COMM_SIZE] = {0};
	unsigned char ucLogTypeStr[STR_COMM_SIZE] = {0};
	unsigned char ucLogInfo[STR_MAX_SIZE] = {0};
	
	if(NULL == pucLogInfo)
	{
		return -1;
	}
	
	/*将日志类型转换成字符串*/
	ulResult = LOG_LogTypeToStr(ucType, ucLogTypeStr, sizeof(ucLogTypeStr));
	/*获取生成日志的时间*/
	ulResult += LOG_PrintLogTime(ucTime, sizeof(ucTime));
	if(0 != ulResult)
	{
		return -1;
	}
	snprintf((char *)ucLogInfo, sizeof(ucLogInfo) - 1, "[%s] [%s] %s", ucTime, ucLogTypeStr, pucLogInfo);
	/*判断是否打印调试日志*/
	if(PRINT_LOG_TO_TERM == g_ulPrintLogPlaceFlag)
	{
		printf("%s", ucLogInfo);
		return 0;
	}
	/*加锁保护文件操作*/
	pthread_mutex_lock(&g_stSaveLogMutexLock);
	/*打开日志文件*/
	(void)LOG_OpenLogFile();
	if(NULL != pFile)
	{
		fputs((char *)ucLogInfo, pFile);
		ulFileLen = ftell(pFile);
		LOG_PRINT("file len = %ld", ulFileLen);
		if(ulFileLen >= g_ulLogFileSize)
		{
			fclose(pFile);
			pFile = NULL;
			g_ucLogFileNo = (g_ucLogFileNo + 1) % MAX_LOG_FILE_NUM;
		}
	}
	pthread_mutex_unlock(&g_stSaveLogMutexLock);
	return 0;
}

/*****************************************************************
** 函数名: LOG_Init
** 输　入:  const unsigned char* ucLogFileName  用来保存日志的文件名
			unsigned long ulFileSize 存储日志的文件大小
** 输　出:void
** 功能描述:日志打印初始化
** 返回值:unsigned long
****************************************************************/
unsigned long LOG_Init(const unsigned char* ucLogFileName, unsigned long ulFileSize)
{
	unsigned int i = 0;
	/*判断参数的合法性*/
	if((NULL == ucLogFileName) || !(ulFileSize > 0))
	{
		return -1;
	}
	/*判断是否将日志输出到日志文件*/
	if((PRINT_LOG_TO_FILE != g_ulPrintLogPlaceFlag) || (0 != g_ulLogInitFlag))
	{
		printf("g_ulPrintLogPlaceFlag = %ld g_ulLogInitFlag = %ld\n",g_ulPrintLogPlaceFlag,g_ulLogInitFlag);
		LOG_PRINT("print log to termination!!");
		return 0;
	}
	
	/*记录日志模块已经被初始化(防止改模块被重复初始化)*/
	g_ulLogInitFlag = 1;
	
	/*生成存储日志的文件名*/
	for(i = 0; i < NUMBER(g_ucLogFileName); i++)
	{
		snprintf((char *)g_ucLogFileName[i], sizeof(g_ucLogFileName[i]) - 1, "%s_%02d", ucLogFileName, i);
		LOG_PRINT("Log File: %s", g_ucLogFileName[i]);
		printf("Log File: %s\n", g_ucLogFileName[i]);
	}
	/*设置日志文件大小*/
	g_ulLogFileSize = ulFileSize;
	pthread_mutex_init(&g_stSaveLogMutexLock, NULL);

	return 0;
}

/*****************************************************************
** 函数名: LOG_Destroy
** 输　入:  void
** 输　出:void
** 功能描述:日志打印资源释放
** 返回值:unsigned long
****************************************************************/
void LOG_Destroy(void)
{
	if(pFile != NULL)
	{
		fclose(pFile);
		pFile = NULL;
	}
	pthread_mutex_destroy(&g_stSaveLogMutexLock);
	return;
}

log.h

#ifndef _LOG_H_
#define _LOG_H_
#include <string.h>

/*通用字符串存储大小定义*/
#define STR_COMM_SIZE 128
#define STR_MAX_SIZE 1024

#define MAX_LOG_FILE_NUM		  (3)

#define NUMBER(type) sizeof(type)/sizeof(type[0])

#define __FILENAME__ (strrchr(__FILE__, '/') ? (strrchr(__FILE__, '/') + 1) : __FILE__)

/*日志类型*/
enum
{
    LOG_DEBUG = 0,/*调试日志*/
    LOG_ERROR,/*错误日志*/
    LOG_WARNING,/*告警日志*/
    LOG_ACTION,/*运行日志*/
    LOG_SYSTEM,/*系统日志*/
    BUTTOM
};

/*将日志输出到终端*/
#define PRINT_LOG_TO_TERM (0)
/*将日志输出到文件中*/
#define PRINT_LOG_TO_FILE (1)

/*调试日志宏定义*/
#define DEBUG_PRINT 0
#define LOG_PRINT(fmt, ...) do{\
	if(DEBUG_PRINT)\
	{\
		printf(fmt"  [line:%d] [%s]\n", ##__VA_ARGS__, __LINE__, __FUNCTION__);\
	}\
}while(0);

/*错误日志打印(在日志打印模块还未启动时使用)*/
#define LOG_ERR(fmt, ...) do{\
	printf("[ERROR]  "fmt"  [line:%d] [%s]\n", ##__VA_ARGS__, __LINE__, __FUNCTION__);\
}while(0);



/*存储日志标记. 0-不存储日志, 1-存储日志*/
extern unsigned long g_ulPrintLogPlaceFlag;

/*是否打印调试日志标记,0-不打印调试日志,1-打印调试日志*/
extern unsigned long g_ulPrintDebugLogFlag;

unsigned long LOG_PrintLog(unsigned char ucType, unsigned char *pucLogInfo);


/*日志打印宏定义*/
#define LOG_INFO(type, fmt, ...) do{\
	if(PRINT_LOG_TO_TERM == g_ulPrintLogPlaceFlag) \
	{ \
		if((0 == g_ulPrintDebugLogFlag) && (LOG_DEBUG == type)) \
		{\
			break;\
		}\
    	unsigned char ucLogInfo[STR_MAX_SIZE] = {0}; \
		snprintf((char *)ucLogInfo, sizeof(ucLogInfo) - 1, fmt"  [%s] [line:%d] [%s]\n", ##__VA_ARGS__, __FILENAME__, __LINE__, __FUNCTION__); \
		LOG_PrintLog(type, ucLogInfo); \
	} \
	else \
	{ \
		unsigned char ucLogInfo[STR_MAX_SIZE] = {0}; \
		snprintf((char *)ucLogInfo, sizeof(ucLogInfo) - 1, fmt"  [%s] [line:%d] [%s]\n", ##__VA_ARGS__, __FILENAME__, __LINE__, __FUNCTION__); \
		LOG_PrintLog(type, ucLogInfo); \
	} \
}while(0)


/*是否打印调试日志标记,0-不打印调试日志,1-打印调试日志*/
extern void LOG_SetPrintDebugLogFlag(unsigned long flag);
/*存储日志标记. 0-不存储日志, 1-存储日志*/
extern void LOG_SetPrintLogPlaceFlag(unsigned long flag);

extern unsigned long LOG_Init(const unsigned char* ucLogFileName, unsigned long ulFileSize);
extern void LOG_Destroy(void);

#endif //_LOG_H_

main.c

#include <stdio.h>
#include "log.h"

int test_func1()
{
	LOG_INFO(LOG_DEBUG, "%s", "hello world!!"); 
	return 0;
}

int main(int argc, char *argv[])
{
	LOG_SetPrintDebugLogFlag(1);//打印调试信息
	//LOG_SetPrintLogPlaceFlag(1);//保存打印信息到文件
	LOG_Init("info", 8000);
	
	LOG_INFO(LOG_DEBUG, "%s", "Init log!!");
	
	test_func1();
	
	LOG_INFO(LOG_DEBUG, "%s", "Destroy log!!");
	LOG_Destroy();
}

执行结果：

       由执行结果可以看出一条打印信息包含了时间、日志类型、内容、文件名、行号、函数名等信息，这样就能够方便快速的定位问题，其使用方法也与printf函数类似，简单方便。

       其次该日志模块还支持将日志存至文件，可以自行定义文件的大小及个数，日志循环覆盖。

fangye945a
关注
专栏目录
一个简单用C语言实现的日志函数
程序点滴
05-05 6399
一个简单用C语言实现的日志函数名称：zLog 功能：实现对程序中函数，变量及自定义消息的记录功能。此函数仅为单线程调用，没有添加同步控制。若要在多线程中调用，可以修改日志函数或自己在程序中添加同步条件。需要的文件：time.h,timeb.h,stdio.h主要函数：       void WriteLog(int Priority,const char* Fmt,
C语言日志模块.zip
06-13
在IT领域，C语言日志模块是一个至关重要的组件，它用于记录程序运行过程中的信息、错误和调试数据。日志模块对于软件开发、维护和故障排查具有不可忽视的价值。下面我们将详细探讨C语言日志模块的设计、实现以及其在...
日志模块的C语言实现
系统运维
09-27 1040
一，模块接口 模块接口比较简单，因为主要只有写日志的操作。 创建日志模块变量 log_t log_new(log_type_t type,const char *file, const char *facility);log_type_t用于控制日志的类型，可以标识为系统日志，文件以及标准输出，是一个枚举类型，定义如下：typedef enum { log_STDOUT, ...
C语言log库----log.c
最新发布
m0_62599305的博客
06-27 1144
在软件开发中，日志记录是一项至关重要的任务。它可以帮助我们跟踪程序的运行情况，发现并解决问题。在C语言中，我们有许多日志库可以选择，但是log.c无疑是其中的佼佼者。这是一个强大而灵活的日志库，它提供了一种简单、高效的方式来记录和管理日志。本文将对log.c进行简要的介绍和总结。log.c是一个用于记录应用程序运行日志的 C 语言库。它的主要功能是提供一个简单、高效的方式来跟踪和记录应用程序的活动，这对于开发者来说是非常有用的。总的来说，log.c是一个非常出色的C语言日志库。
日志系统模块基础、C语言实现一个日志模块、zlog日志模块基础_c日志记录
2401_84931693的博客
05-13 939
该系统需要在类Unix系统下使用。下面我演示一下在我的Ubuntu云服务器上的使用方法。可以看到这个日志系统还是很小巧易用的，适合与在有文件系统的类Unix系统中。
日志系统模块基础、C语言实现一个日志模块、zlog日志模块基础_c日志记录(1)
2401_84931568的博客
05-13 994
LOG;}LOGSET;LOG loging;code=1;code=3;code=4;code=0;code=2;/**日志设置信息* */=0){}else{/**获取日期* *//*
C日志-函数
qq_41729472的博客
08-21 569
c语言函数篇
基于C语言功能模块备用：配置文件读取 /debug日志记录 等
03-26
确保在读取过程中使用适当的错误检查机制，以确保程序的健壮性。 其次，让我们转向debug日志记录。在软件开发过程中，日志记录是调试和追踪问题的关键工具。在C语言中，我们可以自定义日志记录函数，它接收消息和...
C语言功能模块备用：配置文件读取 /debug日志记录 ...等等
04-08
在C语言编程中，配置文件读取和调试日志记录是两个重要的功能模块，它们在软件开发中扮演着不可或缺的角色。下面将详细讲解这两个知识点。 ### 配置文件读取 配置文件通常用来存储应用程序的参数、设置或环境变量...
C语言程序日志打印和日志文件
01-07
首先，"C语言程序日志打印"是指在C程序中实现记录和显示运行信息的功能。这通常涉及到以下几个关键部分： 1. **日志级别**：为了方便管理和筛选，日志通常被分为多个级别，如DEBUG、INFO、WARNING、ERROR和FATAL。...
日志文件源代码（C语言）
05-10
C语言中的日志管理通常涉及读取、写入、搜索和分析这些日志文件。 在Linux下，C语言可以通过标准库函数如`fprintf`、`fopen`、`fclose`等来处理文件操作。`yllog.c`很可能是实现日志功能的主要源代码文件，它可能...
C语言日志管理系统
01-16
支持指定日志鸣，日志级别，日志路径，日志大小，最大备份数目自配置，目前支持ERROR 和普通级别，要其他级别可以自己添加，很方便.
用C语言实现高效日志
05-28
1.写入日志信息的参数化，类似fprint，printf功能 2.定时保存日志信息到硬盘，默认参数为3000毫秒 3.日志信息达到一定容量后自动保存到硬盘（目前设置为1M） 4.该动态库实现了高效性 5.可动态调整日志等级 6.可动态设置定时时间 7.日志分为3个文件，debug.log保存调试日志信息，normal.log保存普通日志信息，error.log保存错误日志信息 8.日志安全性：日志文件达到一定容量后（目前设置为100M）会把原日志文件备份为.bak后缀的日志文件， 并重新生成新的日志文件,如果已经存在.bak后缀的日志文件会被覆盖 9.设置日志等级为__CLOSE_LOGS时，将关闭日志写入功能
用C语言实现高效日志功能（含源码）
11-03
1.写入日志信息的参数化，类似fprint，printf功能 2.定时保存日志信息到硬盘，默认参数为3000毫秒 3.日志信息达到一定容量后自动保存到硬盘4.该动态库实现了高效性
C语言写日志代码
12-03
纯C语言写日志代码，需要自己稍微修改一下才能用，包括检查日志文件的大小。
Clog——基于C语言的日志系统设计
Skynet的博客
11-13 2814
基于linux C设计的一款日志系统，支持多进程日志输出，支持多种日志输出方式
c语言的日志库
逐梦如风-毕康
10-29 3246
最近重新温习下c语言，在linux环境下写些小功能。做一个小项目项目的目标如下1 输出时间和日期,任意指定的字符串,记录文件名，行数 2 支持输出各种级别的数据 3 默认输出数据到终端 4 支持输出日志到文件 对于初次写c项目的人来说的难度。1 各种标准库 2 理解这种模式，手动的分配内存，释放内存 涉及到的…的替代方式 __VA_ARGS__ 变长数据的读取 va_start(arg
C语言编写的一个简单通用的日志框架----支持日志等级，日志颜色，打印到文件等设置
凡人叶枫的博客
09-27 964
日常工作中常常需要输出日志进行调试，本文提供了一个C语言编写的日志框架。可以输出日志到文件或者是终端，支持日志等级设置，不同日志等级可以设置不同的颜色，另外还可以设置进程名、模块名、函数名等的输出，能够打印毫秒级时间，能够限制文件大小，使用方便，架构小巧灵活。本架构多线程的支持有待验证，每次日志调用都会使用写入，性能有待验证，另外，写满切换文件没有实现。 SimpleLog.h /****************************************************************
8051单片机C语言编程模块详解
同时，文档中提到的"修改日志"部分对于跟踪程序的改进和错误修正也至关重要。 掌握8051单片机的编程模块是迈入嵌入式系统设计的第一步，它不仅帮助理解硬件和软件的交互，也是许多高级嵌入式技术的基础。通过不断的...
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值