2013年7月16日

Spring MVC 3 實作教學 (7) - 使用 log4j ( 搭配 slf4j ) ( Use and configure log4j )

完整的 Web Project 必定需要完善的 Log 紀錄,故將 Log 紀錄實作納入本次系列文章中。當然 Spring MVC 可以搭配的 Log Library 也有很多選擇, log4j 與 slf4j 的組合不過是其中的選擇之一。



首先於 Apache log4j 網站下載我們需要的 Library, 下載完後將它放置到 /WebContent/WEB-INF/lib 底下。除了需要將 Library 放到指定路徑下,我們還須要一個 log4j 的設定檔,檔名為 log4j.properties,我習慣擺放路徑如下:


除了  log4j 之外,我們還需要到 slf4j 網站下載 Library,一樣將我們需要的兩個檔案放置到 lib 路徑底下。故我們總共需要三個 JAR 檔分別為 log4j-1.2.17.jarslf4j-api-1.7.5.jarslf4j-log4j12-1.7.5.jar,當然 JAR 檔的版本盡量是使用最新的版本較佳,如下圖:


如此我們的準備工作完成,接著我們還要來定義 log4j.properties 內容,內容如下:


因 log4j  定義了幾個 log 輸出的層級分別為 TRACE、DEBUG 、INFO 、WARN、ERROR、FATAL,這幾個層級關係到我們 Log 輸出的資訊,照上面範例可看到  log4j.rootLogger 部份定義參數為 INFO 與 CONSOLE,代表 Log 輸出層級設定為 INFO,而後面的 CONSOLE 不代表層級,而是指定 log 輸出模式的代號 log4j.appender.CONSOLE。若將 CONSOLE 改為 A1 輸出模式則設定檔內容如下:


範例目前設定為輸出模式為顯示在 Console 畫面,而你也可以同時輸出多個模式,例如增加輸出文字檔案,如下圖:


設定檔完成之後,於 Controller 中做個測試,如下:


可看到我們在 Controller 中增加了兩個輸出訊息方式,隨著 log4j 對應的層級也分別有它對應的 Method ,例如 INFO 對應為 logger.info( ) 而 DEBUG 對應 logger.debug( )。還記得我們在 log4j.properties 裡的 log4j.rootLogger 定義了輸出層級為 INFO 嗎,雖然在 home ( ) 裡面執行了兩個 Log Method ,但根據層級設定為 INFO 時,實際輸出的資訊只會有 logger.info( ) 的部份,根據設定檔的的參數不同,於輸出 Log 更加有調整彈性。測試結果如下:


如此一來就完成了 lo4j 與 slf4j 的搭配使用。當然 log4j 還有其他更多的應用,詳細的部份可以參考官網文件。其他 Spring Framework 相關教學可以參考本篇整理


熱門文章