? 如果世界上有一個(gè)人能夠保證一次寫出來的代碼是百分之百正確的，那么毫無疑問，他一定是世界上最優(yōu)秀的程序員，沒有之一。為什么要求代碼寫好過后要進(jìn)行充分的自測(cè)(包括單元測(cè)試和集成測(cè)試)？就因?yàn)槭侨私詴?huì)犯錯(cuò)，使程序就會(huì)有bug。作為一名軟件開發(fā)人員，必須要學(xué)會(huì)對(duì)程序進(jìn)行測(cè)試，也就是要學(xué)會(huì)程序的調(diào)試。

??????? 一般而言，對(duì)代碼的調(diào)試有以下幾種方法：

??????? 第一，憑肉眼看。在開發(fā)階段，我們編寫的每一行代碼都需要用我們的“火眼金睛”多審查幾遍。如果要問，最好的代碼調(diào)試工具是什么？我認(rèn)為是人眼。不管是代碼還是文檔，在用工具檢查之前，都需要先過了我們眼睛這一關(guān)。

??????? 第二，對(duì)代碼進(jìn)行編譯，以發(fā)現(xiàn)語法錯(cuò)誤。編譯器能夠幫助我們發(fā)現(xiàn)代碼中存在的語法錯(cuò)誤，但對(duì)于那些隱蔽性的錯(cuò)誤(如邏輯錯(cuò)誤等)無能為力。

??????? 第三，用代碼檢查工具(如Pclint等)來走查代碼。如果代碼編譯通過，并不表示它就沒有問題了。在學(xué)校的時(shí)候，我們一般認(rèn)為只要程序能夠運(yùn)行就可以了。但在實(shí)際的軟件開發(fā)項(xiàng)目中，程序能夠跑起來，只是“萬里長征走完了第一步”。用代碼檢查工具可以發(fā)現(xiàn)很多編譯器無法發(fā)現(xiàn)的錯(cuò)誤，如變量定義了未引用、不同數(shù)據(jù)類型之間相互賦值、函數(shù)未聲明便被調(diào)用等。

?????? 第四，對(duì)代碼進(jìn)行調(diào)試。對(duì)于運(yùn)行正常而輸出結(jié)果不正確的程序，我們可以用設(shè)置斷點(diǎn)并進(jìn)行單步跟蹤調(diào)試的方法來發(fā)現(xiàn)其中存在的問題。例如，在VC++ 6.0里面，可實(shí)現(xiàn)對(duì)代碼的單步調(diào)試，并輸出變量在某一步產(chǎn)生的值，可據(jù)此判斷程序的邏輯的正確與否。

???????第五，對(duì)程序的日志文件進(jìn)行分析。對(duì)代碼的單步調(diào)試只在代碼行數(shù)較少的時(shí)候比較適用，如學(xué)校教材上面的程序。但在實(shí)際的軟件項(xiàng)目中，代碼少則幾千行，多則數(shù)萬行，用單步調(diào)試的方法顯然不恰當(dāng)。為了跟蹤某一變量值的變化，用該方法可能要花費(fèi)幾個(gè)小時(shí)，這對(duì)工作效率產(chǎn)生了嚴(yán)重影響。為了解決大程序文件代碼調(diào)試問題，日志系統(tǒng)應(yīng)運(yùn)而生。在程序中的重要地方打印日志，之后對(duì)產(chǎn)生的日志進(jìn)行分析，可找到對(duì)應(yīng)代碼的問題。因此，日志文件分析成了大型軟件項(xiàng)目中代碼調(diào)試的主要手段。

?????? 本文對(duì)日志相關(guān)內(nèi)容進(jìn)行詳細(xì)的說明。

?

1.?什么是日志文件？

??????? 在業(yè)務(wù)軟件系統(tǒng)中大量使用日志，日志能夠起到“按圖索驥”的作用，它對(duì)于故障定位和系統(tǒng)正常運(yùn)行維護(hù)具有舉足輕重的作用。

?????? 日志文件是程序中寫日志函數(shù)產(chǎn)生的記錄程序執(zhí)行情況的文件。寫日志函數(shù)也是用C語言編寫的，同C函數(shù)一樣被調(diào)用。在恰當(dāng)?shù)牡胤秸{(diào)用該函數(shù)，可對(duì)整個(gè)程序的運(yùn)行狀況有一個(gè)全面的了解，方便對(duì)程序的跟蹤調(diào)試。

?

2.?有關(guān)日志等級(jí)和日志配置說明

(1)?日志等級(jí)

??????? 事有輕重緩急，日志信息也有重要與不重要之分。一般按照重要程度，將日志等級(jí)分為幾類。在作者參與過的軟件開發(fā)項(xiàng)目中，共有7個(gè)等級(jí)，用宏定義表示如下：

//?日志等級(jí)定義

#define LOG_FATAL????? ??(int)1???? //?嚴(yán)重錯(cuò)誤

#define LOG_ERROR?????? (int)2???? //?一般錯(cuò)誤

#define LOG_WARN??????? (int)3???? //?警告信息

#define LOG_INFO????? ???(int)4???? //?一般信息

#define LOG_TRACE?????? (int)5???? //?跟蹤信息

#define LOG_DEBUG????? ?(int)6???? //?調(diào)試信息

#define LOG_ALL?????? ???(int)7???? //?全部

????? 開發(fā)人員根據(jù)所要打印的日志的具體情況采用不同的日志等級(jí)。

?

(2)?日志配置

??????? 由于不同產(chǎn)品程序行數(shù)、部署情況、實(shí)現(xiàn)功能等的差別，對(duì)日志打印的要求也不盡相同，因此需要有配置來控制日志的產(chǎn)生數(shù)量和顯示情況。

?????? 在配置文件中，有一個(gè)專門的[LOG]配置段，其中的配置項(xiàng)如下：

[LOG]

;日志等級(jí), 0-Fatal 1-Error 2-Warn 3-Info 4-Trace 5-Debug 6-All

LogLevel=

;每個(gè)日志文件的最大容量

LogMaxSize=

;是否輸出該條日志在代碼中的行數(shù), 1-Yes 0-No

LogPosition=

??????? 其中，LogLevel用于控制打印日志的等級(jí)，代碼中日志等級(jí)比配置值大的日志信息均不在日志文件中顯示；LogMaxSize用于控制生成一個(gè)日志文件的大小的上限，超過該值后，便重新生成文件；LogPosition用于控制是否在日志文件中顯示代碼行數(shù)，方便將日志與代碼對(duì)應(yīng)起來。

?

3.?如何調(diào)用寫日志函數(shù)？

?????? ?日志函數(shù)的調(diào)用遵循一般函數(shù)的調(diào)用規(guī)則。有兩類寫日志函數(shù)，如下所示：

??????? (1)?第一類形如：WriteLog(LogLevel, LogInfo)。其中，參數(shù)LogLevel指日志等級(jí)(見第2節(jié)中的說明)；參數(shù)LogInfo是具體要打印的日志信息，我們據(jù)此信息來檢查程序的運(yùn)行情況。該函數(shù)的調(diào)用示例如：WriteLog(LOG_INFO, "The value of this integer is 3.")，日志等級(jí)為LOG_INFO，日志信息為“The value of this integer is 3.”(該信息會(huì)輸出到日志文件中)。

?

?????? (2)?第二類形如：WriteLogEx(LogLevel, LogInfo, ParaInfo)。這是擴(kuò)展的日志函數(shù)，不但能夠輸出日志信息，還能夠在日志信息中顯示變量的值。該函數(shù)的調(diào)用示例如：WriteLogEx(LOG_INFO, "The value of integer iInt is %d.", iInt)，該日志要輸出整型變量iInt的值，可以將該函數(shù)的調(diào)用與printf函數(shù)的調(diào)用比較起來看(可以認(rèn)為WriteLogEx函數(shù)只是在printf函數(shù)中增加了一個(gè)日志等級(jí)參數(shù))。

?

4.編寫日志的基本原則、基本要求和位置要求

????? 日志編寫的總體原則是簡(jiǎn)單清晰、便于排查問題。

(1)?日志編寫的基本原則

????? 1)?顯式輸出，關(guān)鍵信息必須輸出；

????? 2)?在編碼時(shí)使用正確的日志級(jí)別，error錯(cuò)誤和warning錯(cuò)誤必須反應(yīng)出實(shí)在的含義，不是特別嚴(yán)重的問題不能將日志等級(jí)定義為LOG_FATAL；

????? 3)?在寫日志描述時(shí)，要使用正常簡(jiǎn)單易懂的語言，不能使用晦澀難懂的語言或某些專業(yè)術(shù)語；

????? 4)?在極少數(shù)特殊情況不希望用戶知道時(shí)，可使用特殊日志標(biāo)記；

????? 5)?為了寫出優(yōu)美的代碼，在自己修改或添加代碼的地方，都要正確的打上標(biāo)記(包括作者、日期信息等)，方便追蹤版本的演進(jìn)情況。

?

(2)?日志編寫的基本要求

????? 1)?分多條信息分別輸出，不要企圖一次將所有信息打印出來；

????? 2)?分時(shí)輸出；

????? 3)?必須分日志級(jí)別，這樣可根據(jù)等級(jí)迅速對(duì)日志進(jìn)行分析；

????? 4)?控制日志信息的條數(shù)，不重要的信息盡量不要打印日志。

?

(3)?輸出日志的位置要求

??? 1)?所有的輸入輸出，包括收消息和發(fā)消息都要求輸出日志；

??? 2)?關(guān)鍵控制點(diǎn)必須輸出日志；

??? 3)?調(diào)用底層或第三方軟件，必須輸出日志，而且對(duì)不可靠底層，必須加上begin/end兩行日志；

? ? 4)?對(duì)方系統(tǒng)處理時(shí)間必須輸出日志，以利以后維護(hù)時(shí)快速定位性能問題。

?

??? 此外，作者認(rèn)為，在編寫日志時(shí)還需要注意以下幾點(diǎn)：

??? 1) 在編寫日志時(shí)需要注重日志細(xì)節(jié)，目標(biāo)是為了方便以后維護(hù)，在遇到問題時(shí)，可以快速定位問題。

??? 2) 不要在同一行中寫意思重復(fù)的日志。

??? 3) 日志需要足夠的精簡(jiǎn)，不要隨意換行。

??? 4) 日志中字段之間可以用空格或其它符號(hào)分?jǐn)?#xff0c;不能將日志一直連續(xù)而不將其分?jǐn)?#xff0c;盡量使日志本身具備進(jìn)行“識(shí)文斷句”的能力。

??? 5) 對(duì)于日志中的特殊信息(如會(huì)話號(hào)、IP地址等)，用特殊的符號(hào)進(jìn)行標(biāo)識(shí)，其主要目的是為了便于搜索。

?

5.總結(jié)

??????? 日志系統(tǒng)在軟件程序中占有非常重要的地位，日志文件是排查程序問題的主要工具，是程序調(diào)試的利器。作為一名合格的軟件開發(fā)工程師，一定要學(xué)會(huì)日志函數(shù)的靈活調(diào)用及準(zhǔn)確通過日志文件來定位程序問題。

????? “實(shí)踐出真知”，只有通過不斷的積累和總結(jié)，才會(huì)對(duì)日志有更全面的認(rèn)識(shí)。

總結(jié)

以上是生活随笔為你收集整理的程序调试的利器日志的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。