歡迎來到Linux教程網
設為首頁 加入收藏
Linux教程網
Linux教程網
Linux教程網
您现在的位置： Linux教程網 >> UnixLinux >  >> Linux編程 >> Linux編程

C語言實現簡單的分級別寫日志程序

  1. /************************************************************************/  
  2. /* 
  3.   * 文件名稱：write_log.cpp 
  4.   * 摘    要：此文件實現了普通WINDOWS程序中的日志功能 
  5.   *           主要有以下特點： 
  6.   *           1. 根據日期創建日志文件目錄，每天的日志分別存放在不同的日志目錄中； 
  7.   *           2. 日志內容分三種類型，根據不同需要，寫不同的日志類型的日志文件， 
  8.   *              方便通過日志定位、分析問題； 
  9.   *           3. 函數經過比較好的封裝，便於復用； 
  10.   *           待改進點： 
  11.   *           1. 為了方便，日志內容打印時使用了time函數，其精確度較低； 
  12.   *           2. 可將這些函數封裝為一個日志類，或者動態庫，使其更通用； 
  13.   *           3. 沒有考慮跨平台情景，目前只使用於WINDOWS下 
  14.   *           4. 日志文件內容還可進一步改進，比如打印出當前文件名與行號，使用日志功能 
  15.   *              更加實用； 
  16.   * 
  17.   * 當前版本：1.0 
  18.   * 作    者：duanyongxing  
  19.   * 完成日期：2009年10月11日 
  20. */                                                                       
  21. /************************************************************************/  
  22. #ifndef __WRITELOG_H__   
  23. #define __WRITELOG_H__   
  24. #include "stdafx.h"   
  25. #include <time.h>   
  26. #include <memory.h>   
  27. #include <stdio.h>   
  28. #include <stdlib.h>    
  29. #include <stdarg.h>   
  30. #include <windows.h>   
  31. #define _LOG_WRITE_STATE_ 1            /* 條件編譯開關，1：寫日志，0：不寫日志 */   
  32. #define LOG_SUCCESS (0)   
  33. #define LOG_FAILED  (-1)   
  34. #define LOG_BOOL_TRUE (1)   
  35. #define LOG_BOOL_FALSE (0)   
  36. #define DWORD_NULL  (0xFFFFFFFF)   
  37. #define MAX_LOGTEXT_LEN (2048)         /* 每行日志的最大長度*/   
  38. #define MAX_FILE_PATH (255)            /* 日志文件路徑的最大長度*/   
  39. #define MAX_LOG_FILE_SIZE (512 * 1024) /* 日志文件內容的最大長度*/   
  40. #define MAX_LOG_FILE_NAME_LEN (256)    /* 日志文件名的最大長度*/   
  41.   
  42. #define LOG_TYPE_INFO    0             /* 日志類型: 信息類型*/   
  43. #define LOG_TYPE_ERROR   1             /* 日志類型: 錯誤類型*/   
  44. #define LOG_TYPE_SYSTEM  2             /* 日志類型: 系統類型*/   
  45. #define TEST_CASE_MAX_FILE_LEN (1024)   /* 測試函數中文件內容最大長度*/   
  46. const char g_LogRootPath[] = "C://My_APPLOG"; /*日志文件根路徑，由用戶指定*/  
  47. #pragma pack(push, 1)   
  48. typedef struct tagLOG_DATA             /* 日志內容結構體*/  
  49. {  
  50.  char             strDate[11];   /* 日期:格式為如:2009-10-11*/  
  51.  char             strTime[9];    /* 時間:格式為如:16:10:57*/  
  52.  unsigned int  iType;         /* 日志類型:3種:INFO(0)/ERROR(1)/SYSTEM(2)*/  
  53.  char             strText[MAX_LOGTEXT_LEN]; /*日志內容*/  
  54. }LOG_DATA, *LPLOG_DATA;  
  55. #pragma pack(pop)   
  56.   
  57. int Create_LogDir(const char *pStrPath);  
  58. int Create_LogFile(const char *pStrFile, int iPos);  
  59. int IsFileExist(const char *pStrFile);  
  60. int GetLogPath(char *pStrPath);  
  61. DWORD GetFileLenth(const char *pFile);  
  62. int Write_Log_Text(LPLOG_DATA lpLogData);  
  63. void Write_Log(unsigned int uiLogType, char *pstrFmt, ...);  
  64. void TestLogCase_One();  
  65.   
  66. int main(int argc, char* argv[])  
  67. {  
  68.     Write_Log(LOG_TYPE_SYSTEM, "Program begin.");  
  69.  TestLogCase_One();  
  70.  Write_Log(LOG_TYPE_SYSTEM, "Program end.");  
  71.  return 0;  
  72. }  
  73. /********************************************************************* 
  74. * 函數名稱:void TestLogCase_One() 
  75. * 說明:簡單的測試函數，讀文件 
  76. * 調用者：main 
  77. * 輸入參數: 
  78. * 無 
  79. * 輸出參數： 
  80. * 無 
  81. * 返回值: 
  82. * void  --  
  83. * 作者: duanyongxing 
  84. * 時間 : 2009-10-11 
  85. *********************************************************************/  
  86. void TestLogCase_One()  
  87. {  
  88.     FILE *pFile = NULL;  
  89.  char *pFieldContent = NULL;  
  90.  char szFileName[] = "test_case.txt";  
  91.  pFieldContent = (char *)malloc(TEST_CASE_MAX_FILE_LEN);  
  92.  if(NULL == pFieldContent)  
  93.  {  
  94.   Write_Log(LOG_TYPE_ERROR, "malloc memory failed,program exit!");  
  95.   return;  
  96.  }  
  97.  memset(pFieldContent, 0, TEST_CASE_MAX_FILE_LEN);  
  98.  Write_Log(LOG_TYPE_INFO, "malloc memory for pFiled successful,memory size is: %ld",  
  99.   TEST_CASE_MAX_FILE_LEN);  
  100.  pFile = fopen(szFileName, "r");  
  101.  if(NULL == pFile)  
  102.  {  
  103.   fprintf(stderr, "open file failed.");  
  104.         Write_Log(LOG_TYPE_ERROR, "Open file %s failed. program exit!", szFileName);  
  105.   return;  
  106.  }  
  107.     Write_Log(LOG_TYPE_INFO, "Open file %s successful.", szFileName);  
  108.  fread(pFieldContent, 1, TEST_CASE_MAX_FILE_LEN, pFile);  
  109.     pFieldContent[TEST_CASE_MAX_FILE_LEN -1] = '/0';  
  110.    
  111.  fclose(pFile);  
  112.       
  113.  printf("The file %s content is: /n%s/n", szFileName,  pFieldContent);  
  114.  Write_Log(LOG_TYPE_INFO, "The file %s content is: /n%s/n", szFileName,  pFieldContent);  
  115. }  
  116. /********************************************************************* 
  117. * 函數名稱:void Write_Log(unsigned int uiLogType, char *pstrFmt, ...) 
  118. * 說明:日志寫函數，支持變長參數 
  119. * 調用者：任何需要寫日志的地方 
  120. * 輸入參數: 
  121. * unsigned iType --  日志類別 
  122. * char *pstrFmt  --  日志內容 
  123. * ...            --  變長參數 
  124. * 輸出參數： 
  125. * 無 
  126. * 返回值: 
  127. * void  --  
  128. * 作者: duanyongxing 
  129. * 時間 : 2009-10-11 
  130. *********************************************************************/  
  131. void Write_Log(unsigned int uiLogType, char *pstrFmt, ...)  
  132. {  
  133.    #if _LOG_WRITE_STATE_   /* 寫日志與否的編譯開關*/   
  134.    LOG_DATA data;  
  135.    time_t curTime;  
  136.    struct tm *mt;  
  137.    va_list v1;  
  138.    memset(&data, 0, sizeof(LOG_DATA));  
  139.    va_start(v1, pstrFmt);  
  140.    _vsnprintf(data.strText, MAX_LOGTEXT_LEN, pstrFmt, v1);  
  141.    va_end(v1);  
  142.    data.iType = uiLogType;  
  143.    curTime = time(NULL);  
  144.    mt = localtime(&curTime);  
  145.    strftime(data.strDate, sizeof(data.strDate), "%Y-%m-%d", mt);  
  146.    strftime(data.strTime, sizeof(data.strTime), "%H:%M:%S", mt);  
  147.    Write_Log_Text(&data);  
  148.    #endif _LOG_WRITE_STATE_   
  149. }  
  150. /********************************************************************* 
  151. * 函數名稱:int  GetLogPath(char *pStrPath) 
  152. * 說明:獲取日志文件路徑 
  153. * 調用者：Write_Log_Text 
  154. * 輸入參數: 
  155. * 無 
  156. * 輸出參數： 
  157. * char *pStrPath 
  158. * 返回值: 
  159. * int  -- LOG_FAILED:  失敗 
  160. *      -- LOG_SUCCESS: 成功 
  161. * 作者: duanyongxing 
  162. * 時間 : 2009-10-11 
  163. *********************************************************************/  
  164. int  GetLogPath(char *pStrPath)  
  165. {  
  166.  if(NULL == pStrPath)  
  167.  {  
  168.   return LOG_FAILED;  
  169.  }  
  170.     int iRet = 0;  
  171.  time_t curTime = time(NULL);  
  172.  struct tm *mt = localtime(&curTime);  
  173.     /* 根據日期組成文件夾名稱*/  
  174.  sprintf(pStrPath, "%s//%d%02d%02d", g_LogRootPath, mt->tm_year + 1900,  
  175.       mt->tm_mon + 1, mt->tm_mday);  
  176.     iRet = Create_LogDir(pStrPath);  
  177.  return iRet;  
  178. }  
  179. /********************************************************************* 
  180. * 函數名稱:int GetLogFileName(int iLogType, const char *pStrPath, char *pStrName) 
  181. * 說明:獲取日志文件名 
  182. * 調用者：Write_Log_Text 
  183. * 輸入參數: 
  184. * int iLogType         -- 日志類型 3種:INFO(0)/ERROR(1)/SYSTEM(2) 
  185. * const char *pStrPath -- 日志路徑 由GetLogPath得到 
  186. * 輸出參數： 
  187. * char *pStrName       -- 日志文件名 
  188. * 返回值: 
  189. * int  -- LOG_FAILED:  失敗 
  190. *      -- LOG_SUCCESS: 成功 
  191. * 作者: duanyongxing 
  192. * 時間 : 2009-10-11 
  193. *********************************************************************/  
  194. int GetLogFileName(int iLogType, const char *pStrPath, char *pStrName)  
  195. {  
  196.  if(NULL == pStrPath)  
  197.  {  
  198.   return LOG_FAILED;  
  199.  }  
  200.  char szLogName[MAX_FILE_PATH];  
  201.  FILE *pFile = NULL;  
  202.  memset(szLogName, 0, MAX_FILE_PATH);  
  203.  switch (iLogType)  
  204.  {  
  205.    case LOG_TYPE_INFO:  
  206.     sprintf(szLogName, "%s//app_info", pStrPath);  
  207.     break;  
  208.    case LOG_TYPE_ERROR:  
  209.     sprintf(szLogName, "%s//app_error", pStrPath);  
  210.     break;  
  211.    case LOG_TYPE_SYSTEM:  
  212.     sprintf(szLogName, "%s//app_system", pStrPath);  
  213.     break;  
  214.       default:  
  215.     return LOG_FAILED;  
  216.     break;  
  217.  }  
  218.  strcat(szLogName, ".log");  
  219.  if(IsFileExist(szLogName))  
  220.  {  
  221.   /* 如果文件長度大於指定的最大長度，重新創建一文件，覆蓋原文件*/  
  222.         if((int)GetFileLenth(szLogName) + 256 >= MAX_LOG_FILE_SIZE)  
  223.   {  
  224.    Create_LogFile(szLogName, 0);  
  225.   }  
  226.  }  
  227.  else  
  228.  {  
  229.   Create_LogFile(szLogName, 0);  
  230.  }  
  231.       
  232.  sprintf(pStrName, "%s", szLogName);  
  233.  return LOG_SUCCESS;  
  234. }  
  235. /********************************************************************* 
  236. * 函數名稱:int Create_LogDir(const char *pStrPath) 
  237. * 說明:創建日志存放路徑 
  238. * 調用者：GetLogPath 
  239. * 輸入參數: 
  240. * const char *pStrPath --用戶指定的根路徑 
  241. * 輸出參數： 
  242. * 無 
  243. * 返回值: 
  244. * int  -- LOG_FAILED:  失敗 
  245. *      -- LOG_SUCCESS: 成功 
  246. * 作者: duanyongxing 
  247. * 時間 : 2009-10-11 
  248. *********************************************************************/  
  249. int Create_LogDir(const char *pStrPath)  
  250. {  
  251.  if(NULL == pStrPath)  
  252.  {  
  253.   return LOG_FAILED;  
  254.  }  
  255.  int iRet = 0;  
  256.  char szSub[MAX_FILE_PATH];  
  257.  char *pSub = NULL;  
  258.  int iIndex = 0;  
  259.  int iLen = 0;  
  260.  int bFind = 0;  
  261.  memset(szSub, 0, sizeof(MAX_FILE_PATH));  
  262.       
  263.  /* 逐層創建目錄*/  
  264.  while(1)  
  265.  {  
  266.   pSub = strchr(pStrPath + iLen, '//');  
  267.   if(NULL == pSub)  
  268.   {  
  269.    if(iLen == 0)  
  270.    {  
  271.     return LOG_FAILED;  
  272.    }  
  273.    iRet = CreateDirectory(pStrPath, NULL);  
  274.    if(0 == iRet)  
  275.    {  
  276.     iRet = GetLastError();  
  277.     if(ERROR_ALREADY_EXISTS == iRet)  
  278.     {  
  279.      return LOG_SUCCESS;  
  280.     }  
  281.     return LOG_FAILED;  
  282.    }  
  283.    return LOG_SUCCESS;  
  284.   }  
  285.   else  
  286.   {  
  287.    if (!bFind)  
  288.    {  
  289.     bFind = 1;  
  290.    }  
  291.    else  
  292.    {  
  293.     memset(szSub, 0, sizeof(szSub));  
  294.     strncpy(szSub, pStrPath, pSub - pStrPath);  
  295.     CreateDirectory(szSub, NULL);  
  296.    }  
  297.    iLen = pSub - pStrPath + 1;  
  298.   }  
  299.  }  
  300.  return LOG_SUCCESS;  
  301. }  
  302. /********************************************************************* 
  303. * 函數名稱:int Create_LogFile(const char *pStrFile, int iPos) 
  304. * 說明:創建日志文件 
  305. * 調用者：GetLogFileName 
  306. * 輸入參數: 
  307. * const char *pStrFile --文件名 
  308. * int iPos             --文件指針位置 
  309. * 輸出參數： 
  310. * 無 
  311. * 返回值: 
  312. * int  -- LOG_FAILED:  失敗 
  313. *      -- LOG_SUCCESS: 成功 
  314. * 作者: duanyongxing 
  315. * 時間 : 2009-10-11 
  316. *********************************************************************/  
  317. int Create_LogFile(const char *pStrFile, int iPos)  
  318. {  
  319.  HANDLE hd = 0;  
  320.  int iRet = 0;  
  321.  if(NULL == pStrFile)  
  322.  {  
  323.   return LOG_FAILED;  
  324.  }  
  325.  hd = CreateFile(pStrFile,   
  326.               GENERIC_READ | GENERIC_WRITE,  
  327.      0,  
  328.      NULL,  
  329.      CREATE_ALWAYS,  
  330.      FILE_ATTRIBUTE_NORMAL,  
  331.      NULL  
  332.      );  
  333.  if(INVALID_HANDLE_VALUE == hd)  
  334.  {  
  335.   return LOG_FAILED;  
  336.  }  
  337.     if(DWORD_NULL == SetFilePointer(hd, iPos, NULL, FILE_BEGIN))  
  338.  {  
  339.   return LOG_FAILED;  
  340.  }  
  341.  iRet = SetEndOfFile(hd);  
  342.  CloseHandle(hd);  
  343.  return iRet;  
  344. }  
  345. /********************************************************************* 
  346. * 函數名稱:int IsFileExist(const char *pStrFile) 
  347. * 說明:判斷指定的文件是否存在 
  348. * 調用者：GetLogFileName 
  349. * 輸入參數: 
  350. * const char *pStrFile --文件名 
  351. * 輸出參數： 
  352. * 無 
  353. * 返回值: 
  354. * int  -- LOG_BOOL_FALSE:  不存在 
  355. *      -- LOG_BOOL_TRUE: 存在 
  356. * 作者: duanyongxing 
  357. * 時間 : 2009-10-11 
  358. *********************************************************************/  
  359. int IsFileExist(const char *pStrFile)  
  360. {  
  361.  int iLen = 0;  
  362.  WIN32_FIND_DATA finddata;  
  363.  memset(&finddata, 0, sizeof(WIN32_FIND_DATA));  
  364.  HANDLE hd = FindFirstFile(pStrFile, &finddata);  
  365.  if(INVALID_HANDLE_VALUE == hd)  
  366.  {  
  367.   DWORD dwRet = GetLastError();  
  368.   if(ERROR_FILE_NOT_FOUND == dwRet || ERROR_PATH_NOT_FOUND == dwRet)  
  369.   {  
  370.    return LOG_BOOL_FALSE;  
  371.   }  
  372.  }  
  373.  FindClose(hd);  
  374.  return LOG_BOOL_TRUE;  
  375. }  
  376. /********************************************************************* 
  377. * 函數名稱:DWORD GetFileLenth(const char *pFile) 
  378. * 說明:判斷指定的文件大小 
  379. * 調用者：GetLogFileName 
  380. * 輸入參數: 
  381. * const char *pFile --文件名 
  382. * 輸出參數： 
  383. * 無 
  384. * 返回值: 
  385. * DWORD -- 文件大小 
  386. * 作者: duanyongxing 
  387. * 時間 : 2009-10-11 
  388. *********************************************************************/  
  389. DWORD GetFileLenth(const char *pFile)  
  390. {  
  391.  WIN32_FIND_DATA buff;  
  392.  HANDLE hd = NULL;  
  393.  memset(&buff, 0, sizeof(WIN32_FIND_DATA));  
  394.  hd = FindFirstFile(pFile, &buff);  
  395.  FindClose(hd);  
  396.  return (buff.nFileSizeHigh * MAXDWORD) + buff.nFileSizeLow;  
  397. }  
  398. /********************************************************************* 
  399. * 函數名稱:int Write_Log_Text(LPLOG_DATA lpLogData) 
  400. * 說明:寫日志內容 
  401. * 調用者：Write_Log 
  402. * 輸入參數: 
  403. * LPLOG_DATA lpLogData --日志內容結構體量 
  404. * 輸出參數： 
  405. * 無 
  406. * 返回值: 
  407. * int  -- LOG_FAILED:  失敗 
  408. *      -- LOG_SUCCESS: 成功 
  409. * 作者: duanyongxing 
  410. * 時間 : 2009-10-11 
  411. *********************************************************************/  
  412. int Write_Log_Text(LPLOG_DATA lpLogData)  
  413. {  
  414.     char szFilePath[MAX_FILE_PATH];  
  415.  char szFileName[MAX_LOG_FILE_NAME_LEN];  
  416.  FILE *pFile = NULL;  
  417.  char szLogText[MAX_LOGTEXT_LEN];  
  418.  memset(szFilePath, 0, MAX_FILE_PATH);  
  419.  memset(szFileName, 0, MAX_LOG_FILE_NAME_LEN);  
  420.  memset(szLogText, 0, MAX_LOGTEXT_LEN);  
  421.  GetLogPath(szFilePath);  
  422.  GetLogFileName(lpLogData->iType, szFilePath, szFileName);  
  423.  pFile = fopen(szFileName, "a+");  
  424.     if(NULL == pFile)  
  425.  {  
  426.         return LOG_FAILED;  
  427.  }  
  428.  sprintf(szLogText, "%s %s %s/n", lpLogData->strDate, lpLogData->strTime,  
  429.    lpLogData->strText);  
  430.  fwrite(szLogText, 1, strlen(szLogText), pFile);  
  431.  fclose(pFile);  
  432.  return LOG_SUCCESS;  
  433. }  

Linux編程

初識C++：最簡單的C++程序

堆的C語言實現

用C語言實現簡單的棧

最簡單的C語言程序一例

Linux 下C語言簡單實現線程池

C語言實現簡單線程池

C語言的HashTable簡單實現

C語言寫的一個簡單文件加密程序

相關文章
  • Linux編程
  • SHELL編程
  • PERL編程
    • Copyright © Linux教程網 All Rights Reserved