小白入門學習打日誌

而之前寫了一篇：在公司做的專案和自己在學校做的有什麼區別？中就有提到：公司的專案不會有e.printStackTrace();這種程式碼的存在。因為這列印出來的錯誤資訊沒有日期、等級等等，分析起來不方便。

在工作中去伺服器上查日誌又是一個非常非常常見的操作，所以當初我又寫了一篇 工作中常用到的Linux命令，裡邊就談到了查日誌時常用的Linux命令。

想著，既然接觸日誌也有一段時間了，不妨在回看《手冊》，看看有什麼要注意的地方，於是就有了這篇筆記。

一、Java打日誌的基礎

以前自己自學的時候，排查問題只會寫下面的程式碼：

try {
   // doSomething
} catch (Exception e) {
    e.printStackTrace();
}
----------
// 檢視某個資料的值時：
System.out.println(xxxx);

去到公司就發現上面的程式碼全不見了，剩下的是：

LOGGER.info("begin to run Java3y:{}", id);
----
LOGGER.error("excepiton occurs when run Java3y {}, exception{}", id, e.toString());

如果使用e.printStackTrace();的話，列印在控制的資訊分析不方便：

而我們將資訊分等級和時間記錄在伺服器的磁碟上，有問題了就可以根據對應的資訊去查詢相關的日誌(這樣排查起來是十分方便的)：

我們再來看一下一般的日誌長什麼樣的：

例如：現在有人來反饋某某某使用者好像收不到簡訊，給出傳送時間和使用者ID，我們就可以在日誌上找出該使用者在我們系統的傳送狀態（例如圖上的：state:81，我們就認為是傳送成功狀態)

那麼，問題來了，我們在哪打日誌？《手冊》上其實已經給出了答案：

謹慎地記錄日誌。生產環境禁止輸出 debug 日誌；有選擇地輸出 info 日誌；如果使

用 warn 來記錄剛上線時的業務行為資訊，一定要注意日誌輸出量的問題，避免把伺服器磁碟

撐爆，並記得及時刪除這些觀察日誌。

大量地輸出無效日誌，不利於系統效能提升，也不利於快速定位錯誤點。記錄日誌時請思考：這些

日誌真的有人看嗎？看到這條日誌你能做什麼？能不能給問題排查帶來好處？

1.1什麼叫做 打點 ？

打日誌最常見的就是用來列印出程式執行時的相關資訊，用於快速定位問題和排查問題。我一開始也是這麼理解的，但是其實還可以延伸一下。

我現在搞的那個系統，我們還使用日誌在系統的執行鏈路上打點。比如說，我現在要推送一條通知訊息，通知訊息其實就是下面這種：

這個過程大概是如此的：

• 首先別人呼叫我的RPC提供的介面（或者我自己呼叫自己的介面），發現這是一個通知訊息。於是我組裝成對應的Task，非同步放到訊息佇列中

• 另一個系統從訊息佇列中取出Task，對這個Task進行業務的處理（比如說是否夜間遮蔽，是否強制傳送等等），然後呼叫HTTP介面把這個Task交給下游

• 下游做的事其實也很多，整塊鏈路很長（比如要呼叫SDK的庫，Android和IOS又做不同的處理）

而我們又希望在推送完了之後能統計出一些指標（曝光量，點選率，轉化率）等等。於是乎，就需要在一些關鍵的位置上打一個日誌（專業點叫做打點）

在整塊鏈路都打通了以後，將這些點位（日誌）收集起來，放到實時流式處理平臺(storm/flink)上清洗/過濾。如果是實時需要用到的放到Redis，離線的放在Hive。

二、手冊規範

2.1 使用門面模式的日誌框架

【強制】應用中不可直接使用日誌系統（Log4j、Logback）中的 API，而應依賴使用日誌框架

SLF4J 中的 API，使用門面模式的日誌框架，有利於維護和各個類的日誌處理方式統一。

門面模式我之前也寫過一篇筆記：三分鐘學會門面模式！

其實說白了就是希望抽象出一層API，能夠在切換具體日誌框架的時候不需要大面積更改。

這個我們可以按學JDBC的時候去理解：

無論我是接入MySQL、Oracle還是SQL Server，但我的介面永遠都是那一套，切換資料庫時不需要更改我的Java API

看了一下公司的專案，採用的是SLF4J+Logback

2.2 呼叫RPC介面使用Throwable類攔截

【強制】在呼叫 RPC、二方包、或動態生成類的相關方法時，捕捉異常必須使用 Throwable

類來進行攔截。

之前在排查問題的時候，有個問題死活排不出來，DeBug的時候一直沒進catch模組。後來我學長就說：“要不你改成Throwable試試？

try {

} catch (Throwable e) {

}

我就很疑問，說：“為啥要改成Throwable呢？我們用Exception不就可以捕獲所有的異常了麼，Exception是Throwable的一個子類，但Exception已經是包含所有的Java異常了呀”

眾所周知，Throwable有兩個子類：

• Error（一般我們都會把這個忽略掉…一般情況下出現了Error程式都執行不起來)

• Exception

The  Throwable class is the superclass of all errors and exceptions in the Java language

在《手冊》上也有對上面的規則進行說明：

說明：透過反射機制來呼叫方法，如果找不到方法，丟擲 NoSuchMethodException。什麼情況會丟擲

NoSuchMethodError 呢？二方包在類衝突時，仲裁機制可能導致引入非預期的版本使類的方法簽名不匹

配，或者在位元組碼修改框架（比如：ASM）動態建立或修改類時，修改了相應的方法簽名。這些情況，即

使程式碼編譯期是正確的，但在程式碼執行期時，會丟擲 NoSuchMethodError。

大概的意思就是說：呼叫 RPC、二方包、或動態生成類的相關方法時，可能直接丟擲的是Error，而catch Exception是無法捕獲得到的。

想看例子的同學可以看看這篇文章：

最後

這篇文章好像有點短…

參考資料（阿里巴巴開發手冊下載地址）：