JAVA & XML & JAVASCRIPT & AJAX & CSS

          Web 2.0 技術(shù)儲備............

            BlogJava :: 首頁 :: 新隨筆 :: 聯(lián)系 :: 聚合  :: 管理 ::
            77 隨筆 :: 17 文章 :: 116 評論 :: 0 Trackbacks

          為什么要用日志(Log?

          這個……就不必說了吧。

          為什么不用System.out.println()?

          功能太弱;不易于控制。如果暫時不想輸出了怎么辦?如果想輸出到文件怎么辦?如果想部分輸出怎么辦?……

          為什么同時使用commons-loggingLog4j?為什么不僅使用其中之一?

          Commons-loggin的目的是為“所有的Java日志實現(xiàn)”提供一個統(tǒng)一的接口,它自身的日志功能平常弱(只有一個簡單的SimpleLog?),所以一般不會單獨使用它。

          Log4j的功能非常全面強大,是目前的首選。我發(fā)現(xiàn)幾乎所有的Java開源項目都會用到Log4j,但我同時發(fā)現(xiàn),所有用到Log4j的項目一般也同時會用到commons-loggin。我想,大家都不希望自己的項目與Log4j綁定的太緊密吧。另外一個我能想到的“同時使用commons-loggingLog4j”的原因是,簡化使用和配置。

                 強調(diào)一點,“同時使用commons-loggingLog4j”,與“單獨使用Log4j”相比,并不會帶來更大的學(xué)習(xí)、配置和維護成本,反而更加簡化了我們的工作。我想這也是為什么“所有用到Log4j的項目一般也同時會用到commons-loggin”的原因之一吧。

           

          Commons-logging能幫我們做什么?

          l         提供一個統(tǒng)一的日志接口,簡單了操作,同時避免項目與某個日志實現(xiàn)系統(tǒng)緊密a耦合

          l         很貼心的幫我們自動選擇適當(dāng)?shù)娜罩緦崿F(xiàn)系統(tǒng)(這一點非常好!)

          l         它甚至不需要配置

           

          這里看一下它怎么“‘很貼心的’幫我們‘自動選擇’‘適當(dāng)?shù)摹罩緦崿F(xiàn)系統(tǒng)”:

          1)        首先在classpath下尋找自己的配置文件commons-logging.properties,如果找到,則使用其中定義的Log實現(xiàn)類;

          2)        如果找不到commons-logging.properties文件,則在查找是否已定義系統(tǒng)環(huán)境變量org.apache.commons.logging.Log,找到則使用其定義的Log實現(xiàn)類;

          3)        否則,查看classpath中是否有Log4j的包,如果發(fā)現(xiàn),則自動使用Log4j作為日志實現(xiàn)類;

          4)        否則,使用JDK自身的日志實現(xiàn)類(JDK1.4以后才有日志實現(xiàn)類);

          5)        否則,使用commons-logging自己提供的一個簡單的日志實現(xiàn)類SimpleLog

          (以上順序不保證完全準(zhǔn)確,請參考官方文檔)

           

          可見,commons-logging總是能找到一個日志實現(xiàn)類,并且盡可能找到一個“最合適”的日志實現(xiàn)類。我說它“很貼心”實際上是因為:1、可以不需要配置文件;2、自動判斷有沒有Log4j包,有則自動使用之;3、最悲觀的情況下也總能保證提供一個日志實現(xiàn)(SimpleLog)。

                 可以看到,commons-logging對編程者和Log4j都非常友好。

                 為了簡化配置commons-logging,一般不使用commons-logging的配置文件,也不設(shè)置與commons-logging相關(guān)的系統(tǒng)環(huán)境變量,而只需將Log4jJar包放置到classpash中就可以了。這樣就很簡單地完成了commons-loggingLog4j的融合。如果不想用Log4j了怎么辦?只需將classpath中的Log4jJar包刪除即可。

          就這么簡單!

          代碼應(yīng)該怎么寫?

          我們在需要輸出日志信息的“每一人”類中做如下的三個工作:

          1、導(dǎo)入所有需的commongs-logging類:

          import org.apache.commons.logging.Log;

          import org.apache.commons.logging.LogFactory;

          如果愿意簡化的話,還可以兩行合為一行:

          import org.apache.commons.logging.*;

           

          2、在自己的類中定義一個org.apache.commons.logging.Log類的私有靜態(tài)類成員:

          private static Log log = LogFactory.getLog(YouClassName.class);

          注意這里定義的是static成員,以避免產(chǎn)生多個實例。

          LogFactory.getLog()方法的參數(shù)使用的是當(dāng)前類的class,這是目前被普通認(rèn)為的最好的方式。為什么不寫作LogFactory.getLog(this.getClass())?因為static類成員訪問不到this指針!

           

          3、使用org.apache.commons.logging.Log類的成員方法輸出日志信息:

          log.debug("111");

          log.info("222");

          log.warn("333");

          log.error("444");

          log.fatal("555");

          這里的log,就是上面第二步中定義的類成員變量,其類型是org.apache.commons.logging.Log,通過該類的成員方法,我們就可以將不同性質(zhì)的日志信息輸出到目的地(目的地是哪里?視配置可定,可能是stdout,也可能是文件,還可能是發(fā)送到郵件,甚至發(fā)送短信到手機……詳見下文對log4j.properties的介紹):

          l         debug()   輸出“調(diào)試”級別的日志信息;

          l         info()      輸出“信息”級別的日志信息;

          l         warn()    輸出“警告”級別的日志信息;

          l         error()     輸出“錯誤”級別的日志信息;

          l         fatal()      輸出“致命錯誤”級別的日志信息;

          根據(jù)不同的性質(zhì),日志信息通常被分成不同的級別,從低到高依次是:“調(diào)試(DEBUG)”“信息(INFO)”“警告(WARN)”“錯誤(ERROR)”“致命錯誤(FATAL)”。為什么要把日志信息分成不同的級別呢?這實際上是方便我們更好的控制它。比如,通過Log4j的配置文件,我們可以設(shè)置“輸出‘調(diào)試’及以上級別的日志信息”(即“調(diào)試”“信息”“警告”“錯誤”“致命錯誤”),這對項目開發(fā)人員可能是有用的;我們還可以設(shè)置“輸出“警告”及以上級別的日志信息”(即“警告”“錯誤”“致命錯誤”),這對項目最終用戶可能是有用的。

                 僅從字面上理解,也可以大致得出結(jié)論:最常用的應(yīng)該是debug()info();而warn()error()fatal()僅在相應(yīng)事件發(fā)生后才使用。

           

           

          從上面三個步驟可以看出,使用commons-logging的日志接口非常的簡單,不需要記憶太多東西:僅僅用到了兩個類Log, LogFactory,并且兩個類的方法都非常少(后者只用到一個方法,前者經(jīng)常用到的也只是上面第三步中列出的幾個),同時參數(shù)又非常簡單。

          上面所介紹的方法是目前被普通應(yīng)用的,可以說是被標(biāo)準(zhǔn)化了的方法,幾乎所有的人都是這么用。如果不信,或想確認(rèn)一下,就去下載幾個知名的Java開源項目源代碼看一下吧。

           

          下面給出一個完整的Java類的代碼:

           

          package liigo.testlog;

           

          import org.apache.commons.logging.Log;

          import org.apache.commons.logging.LogFactory;

           

           

          public class TestLog

          {

              private static Log log = LogFactory.getLog(TestLog.class);

           

              public void test()

              {

                  log.debug("111");

                  log.info("222");

                  log.warn("333");

                  log.error("444");

                  log.fatal("555");

              }

           

              public static void main(String[] args)

              {

                  TestLog testLog = new TestLog();

                  testLog.test();

              }

          }

           

           

          只要保證commons-loggingjar包在classpath中,上述代碼肯定可以很順利的編譯通過。那它的執(zhí)行結(jié)果是怎么樣的呢?恐怕會有很大的不同,請繼續(xù)往下看。

           

          Log4j在哪里呢?它發(fā)揮作用了嗎?

          應(yīng)該注意到,我們上面給出的源代碼,完全沒有涉及到Log4j——這正是我們所希望的,這也正是commons-logging所要達到的目標(biāo)之一。

          可是,怎么才能讓Log4j發(fā)揮它的作用呢?答案很簡單,只需滿足“classpath中有Log4jjar包”。前面已經(jīng)說過了,commons-logging會自動發(fā)現(xiàn)并應(yīng)用Log4j。所以只要它存在,它就發(fā)揮作用。(它不存在呢?自然就不發(fā)揮作用,commons-logging會另行選擇其它的日志實現(xiàn)類。)

           

          注意:配置文件log4j.propertiesLog4j來說是必須的。如果classpath中沒有該配置文件,或者配置不對,將會引發(fā)運行時異常。

           

                 這樣,要正確地應(yīng)用Log4j輸出日志信息,log4j.properties的作用就很重要了。好在該文件有通用的模板,復(fù)制一份(稍加修改)就可以使用。幾乎每一個Java項目目錄內(nèi)都會有一個log4j.properties文件,可下載幾個Java開源項目源代碼查看。本文最后也附一個模板性質(zhì)的log4j.properties文件,直接復(fù)制過去就可以用,或者根據(jù)自己的需要稍加修改。后文將會log4j.properties文件適當(dāng)作一些介紹。

          posted on 2006-03-16 22:48 Web 2.0 技術(shù)資源 閱讀(1041) 評論(1)  編輯  收藏 所屬分類: JAVA

          評論

          # re: commons-logging和Log4j 日志管理..... 2006-10-25 14:47 yb
          好文章,謝謝  回復(fù)  更多評論
            

          主站蜘蛛池模板: 荣昌县| 信宜市| 呼玛县| 舟山市| 广南县| 泰兴市| 中方县| 安吉县| 梁平县| 黄山市| 泽普县| 呼图壁县| 甘肃省| 泗洪县| 沙雅县| 西峡县| 吉林市| 卓尼县| 安达市| 上蔡县| 富川| 余干县| 乌兰县| 岳阳市| 共和县| 林西县| 淳安县| 芜湖市| 德格县| 右玉县| 静海县| 乌拉特中旗| 新疆| 长岭县| 县级市| 五峰| 共和县| 耒阳市| 平远县| 沈丘县| 菏泽市|