別再亂打日志了，這份 Java 日志規(guī)范，應(yīng)有盡有，建議收藏！
1 簡介
在程序中寫日志是一件非常重要，但是很容易被開發(fā)人員忽視的地方。寫好程序的日志可以幫助我們大大減輕后期維護(hù)壓力。在實(shí)際的工作中，開發(fā)人員往往迫于巨大時(shí)間壓力，而寫日志又是一個(gè)非常繁瑣的事情，往往沒有引起足夠的重視。
開發(fā)人員應(yīng)在一開始就養(yǎng)成良好的日志撰寫習(xí)慣，并且應(yīng)在實(shí)際的開發(fā)工作中為寫日志預(yù)留足夠的時(shí)間。
1.1 日志的作用
記錄用戶操作的審計(jì)日志，甚至有的時(shí)候就是監(jiān)管部門的要求。 快速定位問題的根源 追蹤程序執(zhí)行的過程。 追蹤數(shù)據(jù)的變化 數(shù)據(jù)統(tǒng)計(jì)和性能分析 采集運(yùn)行環(huán)境數(shù)據(jù)
1.2 撰寫日志的要求
1.2.1 日志的可讀性
日志時(shí)給人讀的，不僅僅是讓自己明白，也要讓沒有接觸過我們源代碼的其他程序員也能夠一目了然。有的同事在日志中打印特殊的標(biāo)識符號，例如“++++++++++”， “===========”，“—————”，這些符號令人眼花繚亂。這是一種不好的編程習(xí)慣。
另外，把日志分類輸出到不同的文件也有利于我們排除干擾，迅速找到我們需要的信息。而且，最好在打印日志時(shí)輸出英文，防止中文不支持而打印出亂碼的情況。
1.2.2 日志的性能
無論我們把日志寫到文件還是數(shù)據(jù)庫，都需要消耗IO資源。適當(dāng)?shù)目刂迫罩镜妮敵鲆灿欣谔岣叱绦虻男阅堋?/p>
例如：盡量避免在在大的循環(huán)中打印意義不大的日志內(nèi)容。輸出日志之前最好能判斷日志的級別(例如. debug前先調(diào)用isDebugEnabled()作出判斷)。
1.2.3 占用磁盤空間
通常，我們都是把日志寫入磁盤上的日志文件中。適當(dāng)?shù)氖褂脻L動(dòng)日志并且定時(shí)清除舊文件是有好處的。我見過這樣一個(gè)例子，程序運(yùn)行幾次后就跑不起來了，前幾次都是正常的。
怎么都想不明白程序有什么問題，最后才發(fā)現(xiàn)居然是日志文件占滿了磁盤空間。在實(shí)際的應(yīng)用中出現(xiàn)上G的日志文件也往往不少見，要在這樣規(guī)模的日志文件中找出對解決問題有用的信息也是一大挑戰(zhàn)。
1.2.4 日志的時(shí)效性
有的時(shí)候我們并不能及時(shí)的發(fā)現(xiàn)問題。需要追溯之前的日志。所以我們是需要保留一段時(shí)間以內(nèi)的日志便于追溯。
1.2.5 日志級別
通常我們在產(chǎn)品環(huán)境中日志的級別都在INFO以上，所以我們必須保證在這樣的情況下程序仍然能夠輸出足夠我們作出判斷的信息。
例如常見的系統(tǒng)具有如下的日志級別：
// 定義FATAL級別輸出宏
#define DRV_LOG_FATAL(fmt, ...) hlog_format(HLOG_LEVEL_FATAL, "PluginDriver", "[%s(%d)] "fmt, __FUNCTION__, __LINE__, ##__VA_ARGS__)
// 定義ERROR級別輸出宏
#define DRV_LOG_ERROR(fmt, ...) hlog_format(HLOG_LEVEL_ERROR, "PluginDriver", "[%s(%d)] "fmt, __FUNCTION__, __LINE__, ##__VA_ARGS__)
// 定義WARN級別輸出宏
#define DRV_LOG_WARN(fmt, ...) hlog_format(HLOG_LEVEL_WARN, "PluginDriver", "[%s(%d)] "fmt, __FUNCTION__, __LINE__, ##__VA_ARGS__)
// 定義INFO級別輸出宏
#define DRV_LOG_INFO(fmt, ...) hlog_format(HLOG_LEVEL_INFO, "PluginDriver", "[%s(%d)] "fmt, __FUNCTION__, __LINE__, ##__VA_ARGS__)
// 定義DEBUG級別輸出宏
#define DRV_LOG_DEBUG(fmt, ...) hlog_format(HLOG_LEVEL_DEBUG, "PluginDriver", "[%s(%d)] "fmt, __FUNCTION__, __LINE__, ##__VA_ARGS__)
// 定義TRACE級別輸出宏
#define DRV_LOG_TRACE(fmt, ...) hlog_format(HLOG_LEVEL_TRACE, "PluginDriver", "[%s(%d)] "fmt, __FUNCTION__, __LINE__, ##__VA_ARGS__)
上述的日志文件中定義了6種日志級別，不同級別的含義在下文詳述，需要了解到在一個(gè)程序開發(fā)的過程中需要維護(hù)不同的分別為FATAL， ERROR， EARN， INFO， DEBUG， TRACE。
1.2.6 日志內(nèi)容
我們在寫日志的時(shí)候，需要注意輸出適當(dāng)?shù)膬?nèi)容。首先，盡量使用業(yè)務(wù)相關(guān)的描述。我們的程序是實(shí)現(xiàn)某種業(yè)務(wù)的，那么就最好能描述清楚這個(gè)時(shí)候走到了業(yè)務(wù)過程的哪一步。
其次，避免在日志中輸出一些敏感信息，例如用戶名和密碼。以及，要保持編碼的一致。如果不能保證就盡量使用英文而不是中文。這樣當(dāng)我們拿到日志之后就不會(huì)因?yàn)榭吹揭欢褋y碼而不知所云了。
1.2.7 日志格式
常見的日志格式中對于每一條日志應(yīng)含有的信息包括日期、時(shí)間、日志級別、代碼位置、日志內(nèi)容、錯(cuò)誤碼等信息。
下面是一個(gè)工作中的日志文件的一部分內(nèi)容：
2018-05-22 15:35:53.850 TRACE TDWZLog [0x00001b10] <36> <TDWZProtocol::Init>,TDWZProtocol::Init
2018-05-22 15:35:53.850 TRACE TDWZLog [0x00001b10] <89> <TDWZProtocol::Init>,End in processing TDWZProtocol::Init
2018-05-22 15:35:53.853 TRACE TDWZLog [0x00001b10] <142> <TDWZProtocol::Connect>,Connect Execute finish
2018-05-22 15:35:53.853 TRACE TDWZLog [0x00002f10] <149> <GetAlarmEventPro>,Enter GetAlarmEventPro func
2018-05-22 15:39:36.382 WARN TrackLog [0x000029fc] - [ internal WARN htrace_server_convert_msgstring_to_contextintls(493) ] detect input id error, trace_id span_id,this chain may not be tracked.
2018-05-22 15:39:36.383 WARN TrackLog [0x000029fc] - [ internal WARN htrace_server_receive(195) ] can not detect trace_id in context, this chain may not be tracked.
2018-05-22 15:39:36.383 TRACE TDWZLog [0x000029fc] <231> <TDWZProtocol::DisConnect>,TDWZProtocol::DisConnect
2018-05-22 15:39:37.502 TRACE TDWZLog [0x00002f10] <225> <GetAlarmEventPro>,End Get AlarmEventPro Func
2018-05-22 15:39:37.503 TRACE TDWZLog [0x000029fc] <241> <TDWZProtocol::DisConnect>,close socket
2018-05-22 15:39:37.503 TRACE TDWZLog [0x000029fc] <242> <TDWZProtocol::DisConnect>,Execute DisConnect function succeed.
可以從該文件中看出一般日志文件中應(yīng)該含有的信息。
2 日志級別和含義
Log4j是Apache的一個(gè)開源項(xiàng)目，通過使用Log4j，我們可以控制日志信息輸出目的地是控制臺(tái)、文件、GUI組件甚至是套接口服務(wù)器；我們也可以控制每一條日志的輸出格式；通過定義每一條日志信息的級別，我們能夠更加細(xì)致地控制日志的生成過程。
最令人感興趣的就是，這些可以通過一個(gè)配置文件來靈活地進(jìn)行配置，而不需要修改應(yīng)用的代碼。
2.1 Log4j的組成
Log4j由三個(gè)重要的組成構(gòu)成：日志記錄器(Loggers)，輸出端(Appenders)和日志格式化器(Layout)。
2.1.1 Logger
控制要啟用或禁用哪些日志記錄語句，并對日志信息進(jìn)行級別限制
2.1.2 Appenders
指定了日志將打印到控制臺(tái)還是文件中.
2.1.3 Layout
控制日志信息的顯示格式。
2.2 日志級別
Log4j中將要輸出的Log信息定義了6種級別，依次為TRACE、DEBUG、INFO、WARN、ERROR和FATAL，當(dāng)輸出時(shí)，只有級別高過配置中規(guī)定的 級別的信息才能真正的輸出，這樣就很方便的來配置不同情況下要輸出的內(nèi)容，而不需要更改代碼，非常方便快捷。
2.2.1 TRACE
TRACE designates finer-grained informational events than the DEBUG.Since:1.2.12，很低的日志級別，一般不會(huì)使用。TRACE一般跟蹤的是函數(shù)的調(diào)用，并且TRACE不應(yīng)該含有變量參數(shù)，而僅能提示函數(shù)的調(diào)用關(guān)系。
2.2.2 DEBUG
一般用于細(xì)粒度級別上，對調(diào)試應(yīng)用程序非常有幫助，主要用于開發(fā)過程中打印一些運(yùn)行信息。
2.2.3 INFO
INFO消息在粗粒度級別上突出強(qiáng)調(diào)應(yīng)用程序的運(yùn)行過程。打印一些你感興趣的或者重要的信息，這個(gè)可以用于生產(chǎn)環(huán)境中輸出程序運(yùn)行的一些重要信息，但是不能濫用，避免打印過多的日志。
2.2.4 WARN
WARN表示會(huì)出現(xiàn)潛在錯(cuò)誤的情形，有些信息不是錯(cuò)誤信息，但是也要給程序員一些提示。該級別表示程序會(huì)自動(dòng)調(diào)整到正常的狀態(tài)，類似參數(shù)未傳入，使用了默認(rèn)的參數(shù)，仍符合程序員預(yù)期之內(nèi)的情況。
2.2.5 ERROR
ERROR指出雖然發(fā)生錯(cuò)誤事件，但仍然不影響系統(tǒng)的繼續(xù)運(yùn)行。打印錯(cuò)誤和異常信息，如果不想輸出太多的日志，可以使用這個(gè)級別。一般在WARN之后的級別在打印錯(cuò)誤時(shí)，應(yīng)該同時(shí)打印錯(cuò)誤碼。
2.2.6 FATAL
FATAL指出每個(gè)嚴(yán)重的錯(cuò)誤事件將會(huì)導(dǎo)致應(yīng)用程序的退出，這個(gè)級別比較高，重大錯(cuò)誤，程序無法恢復(fù)，必須通過重啟程序來解決。
2.3 日志級別大小關(guān)系
日志級別就像開關(guān)一樣，來決定哪些日志方法被調(diào)用，哪些不被調(diào)用。在log4j中，日志級別的關(guān)系如下所示：
ALL<TRACE<DEBUG<INFO<WARN<ERROR<FATAL<OFF
設(shè)置了對應(yīng)的級別之后，日志框架就只調(diào)用大于等于這個(gè)級別的方法。Log4j建議只使用如下的四個(gè)界別
DEBUG<INFO<WARN<ERROR
3 日志規(guī)范示例
模仿，抄寫是比較好的學(xué)習(xí)方式，借鑒前人撰寫日志的良好風(fēng)格以形成自己的風(fēng)格是不錯(cuò)的方式。下面是一些不錯(cuò)的日志記錄。
3.1 TRACE日志記錄示例
DRV_LOG_TRACE("Connect Execute start");
DRV_LOG_TRACE("Connect Execute finish");
DRV_LOG_TRACE("DisConnect func");
DRV_LOG_TRACE("Execute DisConnect function succeed.");
DRV_LOG_TRACE("Enter UploadEvent Func");
DRV_LOG_TRACE("extInfo = %s", Extension);
DRV_LOG_TRACE("Send a Msg ");
DRV_LOG_TRACE("- Connect Execute start");
DRV_LOG_TRACE("- Connect Execute finish");
DRV_LOG_TRACE("- Enter GetAlarmEventPro func");
DRV_LOG_TRACE("- Receive an info");
DRV_LOG_TRACE("- End Get AlarmEventPro Func");
DRV_LOG_TRACE("- DisConnect func");
DRV_LOG_TRACE("- Execute DisConnect function succeed.");
DRV_LOG_TRACE("- Enter UploadEvent Func");
DRV_LOG_TRACE("- Leave UploadEvent Func");
DRV_LOG_TRACE("- ============電網(wǎng)報(bào)警觸發(fā)");
DRV_LOG_TRACE("- ============開始發(fā)送電流電壓值");
DRV_LOG_TRACE("- ============間隔超過分鐘再次發(fā)送電流電壓值");
3.2 INFO日志記錄示例
DRV_LOG_INFO("- UpdataEvent nchal= %d,EventID = %d.",iChannelNo,nEventType);
DRV_LOG_INFO("- do not support doControl");
DRV_LOG_INFO("- channelId = %s, nStatusType = %d", channelId.c_str(), nStatusType);
3.3 DEBUG日志記錄示例
DRV_LOG_DEBUG("- 輸出報(bào)警情況:電網(wǎng)編號:%d,報(bào)警數(shù)量:%d,報(bào)警內(nèi)容:%s.",datas.data1.chn,datas.data1.alarm_num,datas.data1.alarms);
DRV_LOG_DEBUG("- 輸出報(bào)警情況:電網(wǎng)編號:%d,報(bào)警數(shù)量:%d,報(bào)警內(nèi)容:%s.",datas.data2.chn,datas.data2.alarm_num,datas.data2.alarms);
DRV_LOG_DEBUG("- 輸出報(bào)警情況:電網(wǎng)編號:%d,報(bào)警數(shù)量:%d,報(bào)警內(nèi)容:%s.",datas.data3.chn,datas.data3.alarm_num,datas.data3.alarms);
DRV_LOG_DEBUG("- 輸出報(bào)警情況:電網(wǎng)編號:%d,報(bào)警數(shù)量:%d,報(bào)警內(nèi)容:%s.",datas.data4.chn,datas.data4.alarm_num,datas.data4.alarms);
DRV_LOG_DEBUG("- ============datas.data1.huab = %d",datas.data1.huab);
DRV_LOG_DEBUG("- ============datas.data1.hiab = %d",datas.data1.hiab);
DRV_LOG_DEBUG("- ============datas.data2.huab = %d",datas.data2.huab);
DRV_LOG_DEBUG("- ============datas.data2.hiab = %d",datas.data2.hiab);
DRV_LOG_DEBUG("- ============datas.data3.huab = %d",datas.data3.huab);
DRV_LOG_DEBUG("- ============datas.data3.hiab = %d",datas.data3.hiab);
DRV_LOG_DEBUG("- ============datas.data4.huab = %d",datas.data4.huab);
DRV_LOG_DEBUG("- ============datas.data4.hiab = %d",datas.data4.hiab);
DRV_LOG_DEBUG("- Alarm is : %s",szEvent.c_str());
DRV_LOG_DEBUG("- GetChannelExtInfo channelId=%s", channelId.c_str());
DRV_LOG_DEBUG("- nChan = %d, szInfo = %s", nChan, szInfo);
3.4 WARN日志記錄示例
DRV_LOG_WARN("[0x%08x] - invaild event msg,discard it", DRV_INVALID_ARG);
DRV_LOG_WARN("[0x%08x] - Can't find channel by channelId");
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x]Connect device failed", DRV_CONNECT_FAILED, sdkErrCode);
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x]dw_start_receive failed", DRV_ERROR, sdkErrCode);
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x]Communicate failed, socket recv error", DRV_ERROR, DW_SOCKET_RECV_ERROR);
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x>other error", DRV_ERROR, iGetResult);
DRV_LOG_WARN("[0x%08x] - [DWSdk.errorcode=0x%08x>other error", DRV_ERROR, iGetResult);
DRV_LOG_WARN("[0x%08x] - SetEventCallBack should be called first", DRV_ERROR);
3.5 ERROR日志記錄示例
DRV_LOG_ERROR("Init DwSDK filded;<errCode=%d>", initRet);
DRV_LOG_ERROR("Connect device failed");
DRV_LOG_ERROR("Create thread failed");
DRV_LOG_ERROR("dw_start_receive failed");
DRV_LOG_ERROR("Communicate failed, socket recv error");
DRV_LOG_ERROR("other error<errCode=%d>", iGetResult);
DRV_LOG_ERROR("SetEventCallBack should be called first");
DRV_LOG_ERROR("[0x%08x] - [DWSdk.errorcode=0x%08x]Init DwSDK filded", DRV_INIT_FAILED, initRet);
DRV_LOG_ERROR("- [HPR.errorcode=0x%08x]Create thread failed", HPR_GetLastError());
上述代碼中[0x%08x]有下述作用：
該語句出現(xiàn)于格式化輸出時(shí)的格式字符串中。形式為
"0x%08x"
其中，0x為普通字符，輸出的時(shí)候會(huì)原樣輸出為0x。
%08x為整型以16進(jìn)制方式輸出的格式字符串，會(huì)把后續(xù)對應(yīng)參數(shù)的整型數(shù)字，以16進(jìn)制輸出。08的含義為，輸出的16進(jìn)制值占8位，不足部分左側(cè)補(bǔ)0。
于是，如果執(zhí)行
printf("0x%08x", 0x1234);
會(huì)輸出0x00001234。