一文輕松理解打印有效日志

時間：2020-05-25 13:27:09

關鍵字： CURRENT INCLUDE BUF PEN

手機看文章

掃描二維碼
隨時隨地手機看文章

[導讀]、引言在日常代碼測試或運行中，打印日志檢測代碼運行狀態(tài)必不可少。先舉三個例子：在物聯(lián)網(wǎng)系統(tǒng)中設備什么時候上線，可以將上線的信息寫入數(shù)據(jù)庫，也可以將該設備上線的記錄打印到日志中，以該設備的id為文件名，查找日志也比較方便，上線時間、IP地址等

、

引言

在日常代碼測試或運行中，打印日志檢測代碼運行狀態(tài)必不可少。先舉三個例子：

在物聯(lián)網(wǎng)系統(tǒng)中設備什么時候上線，可以將上線的信息寫入數(shù)據(jù)庫，也可以將該設備上線的記錄打印到日志中，以該設備的id為文件名，查找日志也比較方便，上線時間、IP地址等打印到文本中。
在復雜的多環(huán)節(jié)系統(tǒng)中，快速定位問題問題出錯的環(huán)節(jié)，將各個系統(tǒng)數(shù)據(jù)接口的數(shù)據(jù)打印日志，如果有返回值可以判斷執(zhí)行是否成功，可以只打印錯誤的日志，出現(xiàn)問題時查看日志文件就可以定位是那個環(huán)節(jié)。
在異常捕獲中將錯誤的信息打印成日志文件，快速查看代碼或數(shù)據(jù)出現(xiàn)的問題。

日志的作用

一般程序日志出自下面幾個方面的需求：

記錄用戶操作的審計日志，甚至有的時候就是監(jiān)管部門的要求。
快速定位問題的根源
追蹤程序執(zhí)行的過程。
追蹤數(shù)據(jù)的變化
數(shù)據(jù)統(tǒng)計和性能分析
采集運行環(huán)境數(shù)據(jù)

一般在程序上線之后，一旦發(fā)生異常，第一件事就是要弄清楚當時發(fā)生了什么。用戶當時做了什么操作，環(huán)境有無影響，數(shù)據(jù)有什么變化，是不是反復發(fā)生等，然后再進一步的確定大致是哪個方面的問題。確定是程序的問題之后再交由開發(fā)人員去重現(xiàn)、研究、提出解決方案。這時，日志就給我們提供了第一手的資料。

撰寫日志的要求

日志的可讀性

日志是給人讀的，不僅僅是讓自己明白，也要讓沒有接觸過我們源代碼的其他程序員也能夠一目了然。有的同事在日志中打印特殊的標識符號，例如“++++++++++”， “===========”，這些符號令人眼花繚亂。另外，把日志分類輸出到不同的文件也有利于我們排除干擾，迅速找到我們需要的信息。而且，最好在打印日志時輸出英文，防止中文不支持而打印出亂碼的情況。

日志的性能

無論我們把日志寫到文件還是數(shù)據(jù)庫，都需要消耗IO資源。適當?shù)目刂迫罩镜妮敵鲆灿欣谔岣叱绦虻男阅堋＠纾罕M量避免在在大的循環(huán)中打印意義不大的日志內(nèi)容。輸出日志之前最好能判斷日志的級別(例如. debug前先調(diào)用isDebugEnabled()作出判斷)。

占用磁盤空間

通常，我們都是把日志寫入磁盤上的日志文件中。適當?shù)氖褂脻L動日志并且定時清除舊文件是有好處的。我見過這樣一個例子，程序運行幾次后就跑不起來了，前幾次都是正常的。怎么都想不明白程序有什么問題，最后才發(fā)現(xiàn)居然是日志文件占滿了磁盤空間。在實際的應用中出現(xiàn)上G的日志文件也往往不少見。要在這樣規(guī)模的日志文件中找出對解決問題有用的信息也是一大挑戰(zhàn)。

日志的時效性

有的時候我們并不能及時的發(fā)現(xiàn)問題。需要追溯之前的日志。所以我們是需要保留一段時間以內(nèi)的日志便于追溯。

日志級別

通常我們在產(chǎn)品環(huán)境中日志的級別都在INFO以上，所以我們必須保證在這樣的情況下程序仍然能夠輸出足夠我們作出判斷的信息。

日志內(nèi)容

我們在寫日志的時候，需要注意輸出適當?shù)膬?nèi)容。首先，盡量使用業(yè)務相關的描述。我們的程序是實現(xiàn)某種業(yè)務的，那么就最好能描述清楚這個時候走到了業(yè)務過程的哪一步。其次，避免在日志中輸出一些敏感信息，例如用戶名和密碼。以及，要保持編碼的一致。如果不能保證就盡量使用英文而不是中文。這樣當我們拿到日志之后就不會因為看到一堆亂碼而不知所云了。

日志格式

常見的日志格式中對于每一條日志應含有的信息包括日期、時間、日志級別、代碼位置、日志內(nèi)容、錯誤碼等信息。下面是一個工作中的日志文件的一部分內(nèi)容：

代碼實現(xiàn)


#include <iostream>
#include <afxtempl.h>     //CException
#include <ATLComTime.h>   //COleDateTime
#include <io.h>
#include <fcntl.h>
#include <stat.h>

using namespace std;

void PrintRunningLog(char *szbuff)
{

	//AfxMessageBox(szbuff);
	//打印
	int clientNumber = 1;
	CString strInfo;
	CString strCurrentTime;
	COleDateTime currentTime;
	currentTime = COleDateTime::GetCurrentTime();
	strCurrentTime=currentTime.Format("%Y-%m-%d %H:%M:%S");   //打印時間
	strInfo = strCurrentTime;
	strInfo +=" ";
	strInfo +=szbuff;
	strInfo +="\r\n";

	CString strLogTxtName;
	strLogTxtName.Format("log%d.txt",clientNumber);    //文件名

	FILE *stream;//文件流
	if ((stream = fopen(strLogTxtName,"r")) == NULL)
	{
		fopen(strLogTxtName,"w");//新建
	}
	try
	{
		int fh = _open(strLogTxtName,_O_RDWR|_O_CREAT,_S_IREAD|_S_IWRITE);
		if(fh != -1)
		{
			_lseek(fh,0L,SEEK_END);
			_write(fh,strInfo,strlen(strInfo));
			_close(fh);
		}
	}
	catch(CException *pe)
	{
		pe->Delete();
	}
}

int main ()
{
    PrintRunningLog("test");
	return 0 ;
}