月亮的太陽

一 ：為什么同時使用commons-logging和Log4j?為什么不僅使用其中之一？

Commons-loggin的目的是為“所有的Java日志實現”提供一個統一的接口，它自身的日志功能平常弱（只有一個簡單的 SimpleLog?），所以一般不會單獨使用它。Log4j的功能非常全面強大，是目前的首選。我發現幾乎所有的Java開源項目都會用到Log4j， 但我同時發現，所有用到Log4j的項目一般也同時會用到commons-loggin。我想，大家都不希望自己的項目與Log4j綁定的太緊密吧。另外 一個我能想到的“同時使用commons-logging和Log4j”的原因是，簡化使用和配置。

二 ：Commons-logging能幫我們做什么？

提供一個統一的日志接口，簡單了操作，同時避免項目與某個日志實現系統緊密a耦合很貼心的幫我們自動選擇適當的日志實現系統（這一點非常好！）它甚至不需要配置

這里看一下它怎么“‘很貼心的’幫我們‘自動選擇’‘適當的’日志實現系統”：

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

2) 如果找不到commons-logging.properties文件，則在查找是否已定義系統環境變量org.apache.commons.logging.Log，找到則使用其定義的Log實現類；



建立一個叫 ：CATALINA_OPTS 的環境變量
給他的值 ： - Dorg.apache.commons.logging.Log = org.apache.commons.logging.impl.SimpleLog - Dorg.apache.commons.logging.simplelog.defaultlog = warn

3) 否則，查看classpath中是否有Log4j的包，如果發現，則自動使用Log4j作為日志實現類；

4) 否則，使用JDK自身的日志實現類（JDK1.4以后才有日志實現類）；

5) 否則，使用commons-logging自己提供的一個簡單的日志實現類SimpleLog；

（以上順序不保證完全準確，請參考官方文檔）

可見，commons-logging總是能找到一個日志實現類，并且盡可能找到一個“最合適”的日志實現類。我說它“很貼心”實際上是因為：

1、可以不需要配置文件；
2、自動判斷有沒有Log4j包，有則自動使用之；
3、最悲觀的情況下也總能保證提供一個日志實現（SimpleLog）。


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

為了簡化配置commons-logging，一般不使用commons-logging的配置文件，也不設置與commons-logging相關的系 統環境變量，而只需將Log4j的Jar包放置到classpash中就可以了。這樣就很簡單地完成了commons-logging與Log4j的融 合。如果不想用Log4j了怎么辦？只需將classpath中的Log4j的Jar包刪除即可。就這么簡單！

代碼應該怎么寫？
我們在需要輸出日志信息的“每一人”類中做如下的三個工作：

1、導入所有需的commongs-logging類：

1  import  org.apache.commons.logging.Log;
2  import  org.apache.commons.logging.LogFactory; 

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

1  import  org.apache.commons.logging. * ; 

2、在自己的類中定義一個org.apache.commons.logging.Log類的私有靜態類成員：

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

注意這里定義的是static成員，以避免產生多個實例。

LogFactory.getLog()方法的參數使用的是當前類的class，這是目前被普通認為的最好的方式。為什么不寫作LogFactory.getLog(this.getClass())？因為static類成員訪問不到this指針！

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

1 log.debug( " 111 " );
2 log.info( " 222 " );
3 log.warn( " 333 " );
4 log.error( " 444 " );
5 log.fatal( " 555 " ); 

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

1         debug()   輸出“調試”級別的日志信息；
2         info()      輸出“信息”級別的日志信息；
3         warn()    輸出“警告”級別的日志信息；
4         error()     輸出“錯誤”級別的日志信息；
5         fatal()      輸出“致命錯誤”級別的日志信息； 

根據不同的性質，日志信息通常被分成不同的級別，從低到高依次是：
“調試（DEBUG）”“信息（INFO）”“警告（WARN）”“錯誤（ERROR）”“致命錯誤（FATAL）”。
為什么要把日志信息分成不同的級別呢？這實際上是方便我們更好的控制它。比如，通過Log4j的配置文件，我們可以設置“輸出‘調試’及以上級別 的日志信息”（即“調試”“信息”“警告”“錯誤”“致命錯誤”），這對項目開發人員可能是有用的；我們還可以設置“輸出“警告”及以上級別的日志信息” （即“警告”“錯誤”“致命錯誤”），這對項目最終用戶可能是有用的。

僅從字面上理解，也可以大致得出結論：最常用的應該是debug()和info()；而warn()、error()、
fatal()僅在相應事件發生后才使用。

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

上面所介紹的方法是目前被普通應用的，可以說是被標準化了的方法，幾乎所有的人都是這么用。如果不信，或想確認一下，就去下載幾個知名的Java開源項目源代碼看一下吧。

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

1  package  liigo.testlog;
2
3  import  org.apache.commons.logging.Log;
4  import  org.apache.commons.logging.LogFactory;
5
6   public   class  TestLog  {
7      private   static  Log log  =  LogFactory.getLog(TestLog. class );
8       public   void  test()   {
9         log.debug( " 111 " );
10         log.info( " 222 " );
11         log.warn( " 333 " );
12         log.error( " 444 " );
13         log.fatal( " 555 " );
14     }
15
16       public   static   void  main(String[] args)   {
17         TestLog testLog  =   new  TestLog();
18         testLog.test();
19     }
20 } 

只要保證commons-logging的jar包在classpath中，上述代碼肯定可以很順利的編譯通過。那它的執行結果是怎么樣的呢？恐怕會有很大的不同，請繼續往下看。
Log4j在哪里呢？它發揮作用了嗎？
應該注意到，我們上面給出的源代碼，完全沒有涉及到Log4j——這正是我們所希望的，這也正是commons-logging所要達到的目標之一。
可是，怎么才能讓Log4j發揮它的作用呢？答案很簡單，只需滿足“classpath中有Log4j的jar包”。前面已經說過了， commons-logging會自動發現并應用Log4j。所以只要它存在，它就發揮作用。（它不存在呢？自然就不發揮作用，commons- logging會另行選擇其它的日志實現類。）

注意：配置文件log4j.properties對Log4j來說是必須的。如果classpath中沒有該配置文件，或者配置不對，將會引發運行時異常。
這樣，要正確地應用Log4j輸出日志信息，log4j.properties的作用就很重要了。好在該文件有通用的模板，復制一份（稍加修改）就可以使 用。幾乎每一個Java項目目錄內都會有一個log4j.properties文件，可下載幾個Java開源項目源代碼查看。本文最后也附一個模板性質的 log4j.properties文件，直接復制過去就可以用，或者根據自己的需要稍加修改。后文將會log4j.properties文件適當作一些介 紹。
這里順便提示一點：如果不用commons-logging，僅僅單獨使用Log4j，操作上反而要稍微麻煩一些，因為Log4j需要多一點點的初始化代碼（相比commons-logging而言）：

1  import  org.apache.log4j.Logger;
2  import  org.apache.log4j.PropertyConfigurator;
3  public  class  TestLog4j   {
4     static  Logger logger  =  Logger.getLogger(TestLog4j. class );  // First step
5       public   static   void  main(String args[])   {
6       PropertyConfigurator.configure( " log4j.properties " );  // Second step
7       logger.debug( " Here is some DEBUG " );  // Third step
8       logger.info( " Here is some INFO " );
9       logger.warn( " Here is some WARN " );
10       logger.error( " Here is some ERROR " );
11       logger.fatal( " Here is some FATAL " );
12    }
13 } 

不過也就多出一行。但這至少說明，引用commons-logging并沒有使問題復雜化，反而簡單了一些。在這里1+1就小于2了。這也驗證了前面的結論。

總結
將commons-logging和Log4j的jar包都放置到classpath下，同時也將Log4j的配置文件放到classpath中，兩者就可以很好的合作。
采用Log4j配合commons-logging作為日志系統，是目前Java領域非常非常流行的模式，使用非常非常的普遍。兩者的結合帶來的結果就是：簡單 + 強大。

commons-logging提供了簡捷、統一的接口，不需要額外配置，簡單；

Log4j功能非常全面、強大；

commons-logging僅僅對Log4j(當然還包括其它LOG實現)作了一層包裝，具體的日志輸出還是在內部轉交給身后的Log4j來處理；而Log4j雖然做了所有的事情，卻甘作綠葉，從不以真身示人。

兩者堪稱絕配。

對log4j.properties的一點介紹
下面對log4j.properties文件內容作一點點介紹，以后文所附log4j.properties文件為例：

除去以#開頭的注釋以及空行，第一行有用的內容是：

1 log4j.rootLogger = DEBUG, CONSOLE,A1
log4j.rootLogger是最最重要的一個屬性了，它定義日志信息的“輸出級別”和“輸出目的地”。
關鍵看“=”后面的值，“DEBUG, CONSOLE,A1”這里我們要把它分成兩部分：第一個逗號之前的是第一部分，指定“輸出級別”；后面的是第二部分，指定“輸出目的地”。可以同時指定多個“輸出目的地”，以逗號隔開。
具體到上面這一行：它指定的“輸出級別”是“DEBUG”；它指定的“輸出目的地”是“CONSOLE”和“A1”。

注意：

“輸出級別”有可選的五個值，分別是DEBUG、INFO、WARN、ERROR、FATAL，它們是由Log4j系統定義的。

“輸出目的地”就是我們自己定義的了，就在log4j.properties的后面部分，此文件定義的“輸出目的地”有CONSOLE、FILE、 ROLLING_FILE、SOCKET、LF5_APPENDER、MAIL、DATABASE、A1、im。該文件之所以可作主模板，就是因為它比較 全面地定義了各種常見的輸出目的地（控制臺、文件、電子郵件、數據庫等）。

好，下面詳細解釋“log4j.rootLogger=DEBUG, CONSOLE,A1”這一行：

指定“輸出級別”是“DEBUG”，即，僅輸出級別大于等于“調試（DEBUG）”的日志信息。如果此處指定的是“WARN”則僅調用warn()、 error()、fatal()方法輸出的日志信息才被輸出到“輸出目的地”，而調用debug()、info()方法輸出的日志信息不被輸出到“輸出目 的地”。明白了嗎？Log4j就是以這種方式來過濾控制日志信息的輸出與否，這也是對日志信息進行級別分類的目的。
指定“輸出目的地”是“CONSOLE”和“A1”，即，將指定的日志信息（根據日志級別已進行了過濾）同時輸出到的“控制臺”和“SampleMessages.log4j文件”。


為什么說“CONSOLE”表示將日志信息輸出到“控制臺”呢？那就要看一下后文的定義了：

# 應用于控制臺

1 log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender
2 log4j.appender.Threshold = DEBUG
3 log4j.appender.CONSOLE.Target = System.out
4 log4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayout
5 log4j.appender.CONSOLE.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n
6 #log4j.appender.CONSOLE.layout.ConversionPattern = [start] % d {DATE} [DATE] % n % p[PRIORITY] % n % x[NDC] % n % t[THREAD] n % c[CATEGORY] % n % m[MESSAGE] % n % n
為什么說“A1”表示將日志信息輸出到“SampleMessages.log4j文件”呢？還要看后文的定義：

1 log4j.appender.A1 = org.apache.log4j.DailyRollingFileAppender
2 log4j.appender.A1.File = SampleMessages.log4j
3 log4j.appender.A1.DatePattern = yyyyMMdd - HH ' .log4j '
4 log4j.appender.A1.layout = org.apache.log4j.xml.XMLLayout
注意：這里的定義沒有指定輸出文件的路徑，它的路徑實際上是 java.user.path的值。
您應該已經注意到，在定義“輸出目的地”時，還可以指定日志格式、時間、布局等相關信息。略過。

好了，我可以根據需要，將這一行修改為：

1 log4j.rootLogger = ERROR, CONSOLE,FILE,MAIL
將“錯誤（ERROR）”及“致命錯誤（FATAL）”級別的日志信息同時輸出到控制臺、文件，并且發電子郵件向系統管理員報告。是不是很爽？ （如果將“調試（DEBUG）”級別的日志信息郵件給管理員，恐怕遲早會把他/她的郵箱漲爆，哪怕用的是Gmail！再次理解了“將日志信息分為不同級 別”的意圖了吧？）

附：一個有用的log4j.properties文件模板

1.  ##Log4J的配置之簡單使它遍及于越來越多的應用中了  
2.   
3. ##Log4J配置文件實現了輸出到控制臺、文件、回滾文件、發送日志郵件、輸出到數據庫日志表、自定義標簽等全套功能。擇其一二使用就夠用了。  
4.   
5. ##此文件（log4j.properties）內容來自網絡，非本文作者liigo原創。  
6. log4j.rootLogger = DEBUG, CONSOLE,A1  
7. log4j.addivity.org.apache = true    
8.   
9. # 應用于控制臺   
10. log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender   
11. log4j.appender.Threshold = DEBUG   
12. log4j.appender.CONSOLE.Target = System.out   
13. log4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayout   
14. log4j.appender.CONSOLE.layout.ConversionPattern = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n   
15. #log4j.appender.CONSOLE.layout.ConversionPattern = [start] % d  {DATE} [DATE] % n % p[PRIORITY] % n % x[NDC] % n % t[THREAD] n % c[CATEGORY] % n % m[MESSAGE] % n % n   
16.   
17. #應用于文件  
18. log4j.appender.FILE = org.apache.log4j.FileAppender   
19. log4j.appender.FILE.File = file.log   
20. log4j.appender.FILE.Append = false    
21. log4j.appender.FILE.layout = org.apache.log4j.PatternLayout   
22. log4j.appender.FILE.layout.ConversionPattern = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n   
23. # Use  this  layout  for  LogFactor  5  analysis   
24.   
25. # 應用于文件回滾   
26. log4j.appender.ROLLING_FILE = org.apache.log4j.RollingFileAppender   
27. log4j.appender.ROLLING_FILE.Threshold = ERROR   
28. log4j.appender.ROLLING_FILE.File = rolling.log   
29. log4j.appender.ROLLING_FILE.Append = true    
30. log4j.appender.ROLLING_FILE.MaxFileSize = 10KB   
31. log4j.appender.ROLLING_FILE.MaxBackupIndex = 1    
32. log4j.appender.ROLLING_FILE.layout = org.apache.log4j.PatternLayout   
33. log4j.appender.ROLLING_FILE.layout.ConversionPattern = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n   
34.   
35. #應用于socket   
36. log4j.appender.SOCKET = org.apache.log4j.RollingFileAppender   
37. log4j.appender.SOCKET.RemoteHost = localhost   
38. log4j.appender.SOCKET.Port = 5001    
39. log4j.appender.SOCKET.LocationInfo = true    
40. # Set up  for  Log Facter  5    
41. log4j.appender.SOCKET.layout = org.apache.log4j.PatternLayout   
42. log4j.appender.SOCET.layout.ConversionPattern = [start] % d  {DATE} [DATE] % n % p[PRIORITY] % n % x[NDC] % n % t[THREAD] % n % c[CATEGORY] % n % m[MESSAGE] % n % n   
43.   
44. # Log Factor  5  Appender   
45. log4j.appender.LF5_APPENDER = org.apache.log4j.lf5.LF5Appender   
46. log4j.appender.LF5_APPENDER.MaxNumberOfRecords = 2000    
47.   
48. # 發送日志給郵件   
49. log4j.appender.MAIL = org.apache.log4j.net.SMTPAppender   
50. log4j.appender.MAIL.Threshold = FATA  
51. log4j.appender.MAIL.BufferSize = 10    
52. log4j.appender.MAIL.From = web@www.wuset.com  
53. log4j.appender.MAIL.SMTPHost = www.wusetu.com   
54. log4j.appender.MAIL.Subject = Log4J Message   
55. log4j.appender.MAIL.To = web@www.wusetu.com  
56. log4j.appender.MAIL.layout = org.apache.log4j.PatternLayout   
57. log4j.appender.MAIL.layout.ConversionPattern = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n   
58.   
59.   
60. # 用于數據庫   
61. log4j.appender.DATABASE = org.apache.log4j.jdbc.JDBCAppender   
62. log4j.appender.DATABASE.URL = jdbc:mysql: // localhost:3306/test    
63. log4j.appender.DATABASE.driver = com.mysql.jdbc.Driver   
64. log4j.appender.DATABASE.user = root   
65. log4j.appender.DATABASE.password =    
66. log4j.appender.DATABASE.sql = INSERT INTO LOG4J (Message) VALUES ( ' [framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n ' )   
67. log4j.appender.DATABASE.layout = org.apache.log4j.PatternLayout   
68. log4j.appender.DATABASE.layout.ConversionPattern = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n   
69. log4j.appender.A1 = org.apache.log4j.DailyRollingFileAppender   
70. log4j.appender.A1.File = SampleMessages.log4j   
71. log4j.appender.A1.DatePattern = yyyyMMdd - HH ' .log4j '    
72. log4j.appender.A1.layout = org.apache.log4j.xml.XMLLayout   
73.   
74. #自定義Appender   
75. log4j.appender.im  =  net.cybercorlin.util.logger.appender.IMAppender   
76. log4j.appender.im.host  =  mail.cybercorlin.net   
77. log4j.appender.im.username  =  username   
78. log4j.appender.im.password  =  password   
79. log4j.appender.im.recipient  =  corlin@cybercorlin.net  
80. log4j.appender.im.layout = org.apache.log4j.PatternLayout   
81. log4j.appender.im.layout.ConversionPattern  = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n  
82.   
83. # 結束

日志信息格式中幾個符號所代表的含義：
 -X號: X信息輸出時左對齊；
 %p: 輸出日志信息優先級，即DEBUG，INFO，WARN，ERROR，FATAL,
 %d: 輸出日志時間點的日期或時間，默認格式為ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921
 %r: 輸出自應用啟動到輸出該log信息耗費的毫秒數
 %c: 輸出日志信息所屬的類目，通常就是所在類的全名
 %t: 輸出產生該日志事件的線程名
 %l: 輸出日志事件的發生位置，相當于%C.%M(%F:%L)的組合,包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main (TestLog4.java:10)
 %x: 輸出和當前線程相關聯的NDC(嵌套診斷環境),尤其用到像java servlets這樣的多客戶多線程的應用中。
 %%: 輸出一個"%"字符
 %F: 輸出日志消息產生時所在的文件名稱
 %L: 輸出代碼中的行號
 %m: 輸出代碼中指定的消息,產生的日志具體信息
 %n: 輸出一個回車換行符，Windows平臺為"\r\n"，Unix平臺為"\n"輸出日志信息換行
 可以在%與模式字符之間加上修飾符來控制其最小寬度、最大寬度、和文本的對齊方式。如：
 1)%20c：指定輸出category的名稱，最小的寬度是20，如果category的名稱小于20的話，默認的情況下右對齊。
 2)%-20c:指定輸出category的名稱，最小的寬度是20，如果category的名稱小于20的話，"-"號指定左對齊。
 3)%.30c:指定輸出category的名稱，最大的寬度是30，如果category的名稱大于30的話，就會將左邊多出的字符截掉，但小于30的話也不會有空格。
 4)%20.30c:如果category的名稱小于20就補空格，并且右對齊，如果其名稱長于30字符，就從左邊較遠輸出的字符截掉。