Log4j最簡入門

by zhlmmc

Log4j實在是很熟悉，幾乎所有的Java項目都用它啊。但是我確一直沒有搞明白。終于有一天我受不了了，定下心去看了一把文檔，才兩個小時，我終于搞明白了。一般情況下Log4j總是和Apache Commons-logging一起用的，我也就一起介紹吧。多了個東西不是更麻煩，而是更簡單！

<!--[if !supportLists]-->一、<!--[endif]-->Log4j的簡單思想

Log4j真的很簡單，簡單到令人發指的地步。不是要記錄日志嗎？那就給你一個Log，然后你用Log來寫東西就行了，先來一個完整類示例：

package test;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

public class Test {

        static Log log = LogFactory.getLog(Test.class);

        public void log(){

           log.debug("Debug info.");

           log.info("Info info");

           log.warn("Warn info");

           log.error("Error info");

           log.fatal("Fatal info");

        }

        /**

         * @param args

         */

        public static void main(String[] args) {

           Test test = new Test();

           test.log();

        }

}

別怕，看完這篇文章你就會覺得很簡單了。

        Log4j默認把日志信息分為五個等級

        debug < info < warn < error < fatal

雖然可以自己添加等級，但是我覺得沒有必要，五個夠用了吧！你要寫入信息的時候就把信息歸為五個等級中的一個，然后調用相應的函數即可。

    分五個等級到底有什么用呢？日志信息到底寫到哪里去了？

    “LogFactory.getLog(Test.class)”又是什么意思捏？接著往下看吧！

Log4j的關鍵之處在于它的繼承思想。也就是一個Log可以繼承另外一個Log的屬性（輸出到哪里，日志等級，日志格式等等）。怎么繼承？

Log4j是根據Log的名字來判斷繼承關系的，比如：

名字為“com.zhlmmc.lib”的Log就是“com.zhlmmc.lib.log”的parent，明白了吧！Log4j還有一個rootLogger，相當于Java的Object。

回過頭來看“LogFactory.getLog(Test.class)”這里的“Test.class”事實上傳進去的是Test這個類的完整路徑（包名+類名），“test.Test”。這樣如果存在“test”這個Log那么Test這個Log就繼承它，否則就繼承rootLogger。 

    那具體的Log屬性是在哪里定義的呢？

<!--[if !supportLists]-->二、<!--[endif]-->常見的配置文件

雖然可以用xml或者在運行時用Java來配置Log4j，但還是properties文件好用啊！

log4j.rootLogger=info, stdout

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.

log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

分析一下：

第一行，配置log4j.rootLogger你明白吧。應為它是根，總得配置一下，否則別的Log繼承什么啊。其他的Log可以配置也可以不配置。等號后面的第一個參數表示日志級別，可以填五個級別中的一種，后面的參數都是讓Log知道輸出到哪里，如果你想讓日志輸出到兩個地方就加兩個輸出參數，比如：

 

log4j.rootLogger=info, stdout, file

這里的info表示，該Log的日志級別為info，所有級別小于info的日志都不會被記錄。比如使用這個配置文件的話，我剛開始舉的那個類中

 

log.debug("Debug info.");

這句話是不起作用的，因為debug的級別小于info。這樣就很容易控制什么信息在調試的時候要顯示，什么信息在發布的時候要去掉。這些都不用改代碼，很方便吧。

但，stdout和file又是什么呢？

接著往下看，就是配置stdout了，這個名字是隨便取的，你可以叫它A：

 

log4j.appender.A=org.apache.log4j.ConsoleAppender

那么上面的rootLogger的參數stdout也要改成A，其他用到的地方當然也要改。這里的關鍵不是名字，而是appender類型，比如這里的“ConsoleAppender”，看明白了吧，輸出到Console。后面兩行都是設置日志格式的，一般情況下你就照抄吧。既然是最簡入門關注于理解Log4j的工作原理，我就不介紹file類型的appender了，一搜一大把。

在實際的項目開發中，很可能遇到所引用的包用Log4j來記錄日志，比如Hibernate。那么在這里你可以很容易的控制這個包如何記錄日志。比如在上面的配置文件中加一行：

 

log4j.logger.org.hibernate=fatal

    那么所有org.hibernate包下面的類就只會顯示很少的信息，因為fatal的級別最高啊。

<!--[if !supportLists]-->三、<!--[endif]-->部署

別怕，這可不是部署Tomcat。把log4j的包和commons-logging的包（加在一起才兩個）放到classpath下面。然后把配置文件保存為log4j.properties，也放在classpath下面（如果用Eclipse的話，放在src目錄下即可）。然后你就可以跑了。