021-日志函数及第二套api函数

moc

1、日志库
        在函数出错或是调用调试时记录日志，是软件开发中的重要部分，下面是一套打印日志的函数，可以做成动态库。
        程序中存在着open()等文件操作函数，在win7 x64环境中运行不正常（日志文件不能正常生成）；但业务逻辑可学习。
itcastlog.h

1. #ifndef _ITCAST_LOG_H_
   
2. #define _ITCAST_LOG_H_
   
3. 
   
4. /*
   
5. #define IC_NO_LOG_LEVEL                        0
   
6. #define IC_DEBUG_LEVEL                        1
   
7. #define IC_INFO_LEVEL                        2
   
8. #define IC_WARNING_LEVEL                3
   
9. #define IC_ERROR_LEVEL                        4;
   
10. */
    
11. 
    
12. /************************************************************************/
    
13. /*
    
14. const char *file：文件名称
    
15. int line：文件行号
    
16. int level：错误级别
    
17.                 0 -- 没有日志
    
18.                 1 -- debug级别
    
19.                 2 -- info级别
    
20.                 3 -- warning级别
    
21.                 4 -- err级别
    
22. int status：错误码
    
23. const char *fmt：可变参数
    
24. */
    
25. /************************************************************************/
    
26. //实际使用的Level
    
27. extern int  LogLevel[5];
    
28. void ITCAST_LOG(const char *file, int line, int level, int status, const char *fmt, ...);
    
29. 
    
30. #endif

复制代码

itcastlog.c

1. #include <sys/types.h>
   
2. #include <sys/stat.h>
   
3. #include <fcntl.h>
   
4. #include <stdarg.h>
   
5. #include <string.h>
   
6. #include <stdio.h>
   
7. #include <stdlib.h>
   
8. #include <time.h>
   
9. 
   
10. #include "ItcastLog.h"
    
11. 
    
12. #define ITCAST_DEBUG_FILE_        "socketclient.log"
    
13. #define ITCAST_MAX_STRING_LEN                 10240
    
14. 
    
15. //Level类别
    
16. #define IC_NO_LOG_LEVEL                        0
    
17. #define IC_DEBUG_LEVEL                        1
    
18. #define IC_INFO_LEVEL                        2
    
19. #define IC_WARNING_LEVEL                3
    
20. #define IC_ERROR_LEVEL                        4
    
21. 
    
22. int  LogLevel[5] = {IC_NO_LOG_LEVEL, IC_DEBUG_LEVEL, IC_INFO_LEVEL, IC_WARNING_LEVEL, IC_ERROR_LEVEL};
    
23. 
    
24. //Level的名称
    
25. char ICLevelName[5][10] = {"NOLOG", "DEBUG", "INFO", "WARNING", "ERROR"};
    
26. 
    
27. static int ITCAST_Error_GetCurTime(char* strTime)
    
28. {
    
29.         struct tm*                tmTime = NULL;
    
30.         size_t                        timeLen = 0;
    
31.         time_t                        tTime = 0;       
    
32.        
    
33.         tTime = time(NULL);
    
34.         tmTime = localtime(&tTime);
    
35.         //timeLen = strftime(strTime, 33, "%Y(Y)%m(M)%d(D)%H(H)%M(M)%S(S)", tmTime);
    
36.         timeLen = strftime(strTime, 33, "%Y.%m.%d %H:%M:%S", tmTime);
    
37.        
    
38.         return timeLen;
    
39. }
    
40. 
    
41. static int ITCAST_Error_OpenFile(int* pf)
    
42. {
    
43.         char        fileName[1024];
    
44.        
    
45.         memset(fileName, 0, sizeof(fileName));
    
46. #ifdef WIN32
    
47.         sprintf(fileName, "c:\\itcast\\%s",ITCAST_DEBUG_FILE_);
    
48.         printf("**x86**  %s\n", fileName);  // 说明我用的是x86环境
    
49. #else
    
50.         //sprintf(fileName, "%s/log/%s", getenv("HOME"), ITCAST_DEBUG_FILE_);
    
51.         sprintf(fileName, "c:\\itcast\\%s",ITCAST_DEBUG_FILE_);
    
52.         printf("**x64**  %s\n", fileName);
    
53. #endif
    
54.    
    
55.     *pf = open(fileName, O_WRONLY|O_CREAT|O_APPEND, 0666);
    
56.     if(*pf < 0)
    
57.     {
    
58.         return -1;
    
59.     }       
    
60.         return 0;
    
61. }
    
62. 
    
63. static void ITCAST_Error_Core(const char *file, int line, int level, int status, const char *fmt, va_list args)
    
64. {
    
65.     char str[ITCAST_MAX_STRING_LEN];
    
66.     int         strLen = 0;
    
67.     char tmpStr[64];
    
68.     int         tmpStrLen = 0;
    
69.     int  pf = 0;
    
70.    
    
71.     //初始化
    
72.     memset(str, 0, ITCAST_MAX_STRING_LEN);
    
73.     memset(tmpStr, 0, 64);
    
74.    
    
75.     //加入LOG时间
    
76.     tmpStrLen = ITCAST_Error_GetCurTime(tmpStr);
    
77.     tmpStrLen = sprintf(str, "[%s] ", tmpStr);
    
78.     strLen = tmpStrLen;
    
79. 
    
80.     //加入LOG等级
    
81.     tmpStrLen = sprintf(str+strLen, "[%s] ", ICLevelName[level]);
    
82.     strLen += tmpStrLen;
    
83.    
    
84.     //加入LOG状态
    
85.     if (status != 0)
    
86.     {
    
87.         tmpStrLen = sprintf(str+strLen, "[ERRNO is %d] ", status);
    
88.     }
    
89.     else
    
90.     {
    
91.             tmpStrLen = sprintf(str+strLen, "[SUCCESS] ");
    
92.     }
    
93.     strLen += tmpStrLen;
    
94. 
    
95.     //加入LOG信息
    
96.     tmpStrLen = vsprintf(str+strLen, fmt, args);
    
97.     strLen += tmpStrLen;
    
98. 
    
99.     //加入LOG发生文件
    
100.     tmpStrLen = sprintf(str+strLen, " [%s]", file);
     
101.     strLen += tmpStrLen;
     
102. 
     
103.     //加入LOG发生行数
     
104.     tmpStrLen = sprintf(str+strLen, " [%d]\n", line);
     
105.     strLen += tmpStrLen;
     
106.    
     
107.     //打开LOG文件
     
108.     if(ITCAST_Error_OpenFile(&pf))
     
109.         {
     
110.                 return ;
     
111.         }
     
112.        
     
113.     //写入LOG文件
     
114.     write(pf, str, strLen);
     
115.     //IC_Log_Error_WriteFile(str);
     
116.    
     
117.     //关闭文件
     
118.     close(pf);
     
119.    
     
120.     return ;
     
121. }
     
122. 
     
123. void ITCAST_LOG(const char *file, int line, int level, int status, const char *fmt, ...)
     
124. {
     
125.     va_list args;
     
126.        
     
127.         //判断是否需要写LOG
     
128. //        if(level!=IC_DEBUG_LEVEL && level!=IC_INFO_LEVEL && level!=IC_WARNING_LEVEL && level!=IC_ERROR_LEVEL)
     
129.         if(level == IC_NO_LOG_LEVEL)
     
130.         {
     
131.                 return ;
     
132.         }
     
133.        
     
134.         //调用核心的写LOG函数
     
135.     va_start(args, fmt);
     
136.     ITCAST_Error_Core(file, line, level, status, fmt, args);
     
137.     va_end(args);
     
138.     return ;
     
139. }

复制代码

2、第二套api的实现
调用该api函数

1. // 调用第二套api函数
   
2. void  main()
   
3. {
   
4.         int ret = 0;
   
5.         void *handle = NULL;
   
6. 
   
7.         unsigned char buf[128];
   
8.         int buflen = 11;  /*in*/
   
9. 
   
10.         unsigned char *out = NULL;
    
11.         int outlen = 0;
    
12. 
    
13.         strcpy(buf, "adddasdadddddddddasdada");
    
14.         // 客户端初始化
    
15.         ret = cltSocketInit2(&handle /*out*/);
    
16.         // 客户端发报文
    
17.         ret = cltSocketSend2(handle/*in*/, buf/*in*/, buflen/*in*/);
    
18.         // 客户端收报文
    
19.         ret = cltSocketRev2(handle/*in*/, &out, &outlen);
    
20.         ret = cltSocketRev2_Free(&out);  //不但要把out所指向的内存空间释放，同样也把实参out赋成NULL,避免野指针
    
21.         //客户端释放资源
    
22.         if (handle != NULL)
    
23.         {
    
24.                 cltSocketDestory2(&handle/*in*/);
    
25.         }
    
26. 
    
27.         system("pause");
    
28. }

复制代码

第二套api函数的源码；该源码置于第一套之后，共同做成dll文件，用于别的函数调用。

1. //------------------第二套api接口---Begin--------------------------------//
   
2. //客户端初始化 获取handle上下
   
3. __declspec(dllexport)     //该语句的含义是下面的函数是向外抛出的函数
   
4. int cltSocketInit2(void **handle /*out*/)
   
5. {
   
6.         return cltSocketInit(handle);
   
7. }
   
8. 
   
9. //客户端发报文
   
10. __declspec(dllexport)
    
11. int cltSocketSend2(void *handle /*in*/, unsigned char *buf /*in*/, int buflen /*in*/)
    
12. {
    
13.         return cltSocketSend(handle, buf, buflen);
    
14. }
    
15. 
    
16. //客户端收报文
    
17. __declspec(dllexport)
    
18. int cltSocketRev2(void *handle /*in*/, unsigned char **buf /*in*/, int *buflen /*in out*/)
    
19. {
    
20.         int ret = 0;
    
21.         SCK_HANDLE *sh = NULL;
    
22.         unsigned char *tmp = NULL;
    
23.         if (handle == NULL || buf == NULL || buflen == NULL)
    
24.         {
    
25.                 ret = -1;
    
26.                 printf("func cltSocketRev2 error:%d", ret);
    
27.                 return ret;
    
28.         }
    
29.         sh = (SCK_HANDLE *)handle;
    
30. 
    
31.         tmp = (char *)malloc(sh->buflen * sizeof(char));
    
32.         if (tmp == NULL)
    
33.         {
    
34.                 ret = -1;
    
35.                 printf("func cltSocketSend malloc error, buflen:%d", *buflen);
    
36.                 return ret;
    
37.         }
    
38.         memcpy(tmp, sh->pbuf, sh->buflen);
    
39. 
    
40.         *buf = tmp;
    
41.         *buflen = sh->buflen;
    
42.         return ret;
    
43. }
    
44. 
    
45. __declspec(dllexport)
    
46. int cltSocketRev2_Free(unsigned char **buf)
    
47. {
    
48.         int ret = 0;
    
49.         if (buf == NULL)
    
50.         {
    
51.                 ret = -1;
    
52.                 printf("func cltSocketRev2_Free error:%d", ret);
    
53.                 return ret;
    
54.         }
    
55.         free(*buf);
    
56.         *buf = NULL;  // 释放的同时，也间接把实参修改啦
    
57. 
    
58.         return ret;
    
59. }
    
60. 
    
61. //客户端释放资源
    
62. __declspec(dllexport)
    
63. int cltSocketDestory2(void **handle/*in*/)
    
64. {
    
65.         int ret = 0;
    
66.         SCK_HANDLE *sh = NULL;
    
67.         if (handle == NULL)
    
68.         {
    
69.                 ret = -1;
    
70.                 printf("func cltSocketDestory error:%d", ret);
    
71.                 return ret;
    
72.         }
    
73.         sh = (SCK_HANDLE *) *handle;
    
74. 
    
75.         if (sh->pbuf != NULL)
    
76.         {
    
77.                 free(sh->pbuf);
    
78.         }
    
79.         free(sh);
    
80.         *handle = NULL;  // 间接修改实参的值，避免野指针
    
81. 
    
82.         return ret;
    
83. }
    
84. //------------------第二套api接口---End-----------------------------------//

复制代码

两套api函数的区别一个在主调函数中分配内存，一个在被调函数中分配内存。
另外：内存在哪里申请的的就要在哪里去释放，动态库里申请的内存就要调用动态库的函数去释放。