從common-logging談log4j

從common-logging談log4j 文章收藏,  網上資源,  軟體技術,  電腦與網路 李小白 發表於 2009-4-2 23:25:06

引子：     最近老是用到log4j的東西，我想這樣優秀的一個日誌工具大家都比我熟悉，想必都已經領略了它的強大。大家也知道log4j都是和common-logging一起運用的。今天我自己把log4j的東西做個總結吧，就是算是複習，當然，要說log4j，就不的不從common-logging說起了。  common-logging組件：  Jakarta Commons Logging (JCL)提供的是一個日誌(Log)介面(interface)，同時兼顧輕量級和不依賴於具體的日誌實現工具。它提供給中介軟體/日誌工具開發人員一個簡單的日誌操作抽象，允許程式開發人員使用不同的具體日誌實現工具。瞭解包裡情況，可以查看它的API文檔：http://www.oschina.net/uploads/doc/commons-logging-1.1.1/index.html  其中Log(基本記錄器)和LogFactory(負責建立Log執行個體)是兩個基類。該API直接提供對下列底層日誌記錄工具的支援：Jdk14Logger，Log4JLogger，LogKitLogger，NoOpLogger （直接丟棄所有日誌資訊），還有一個SimpleLog。  有必要詳細說明一下調用LogFactory.getLog()時發生的事情。調用該函數會啟動一個發現過程，即找出必需的底層日誌記錄功能的實現，具體的發現過程在下面列出：  ⑴ Commons的Logging首先在CLASSPATH中尋找commons-logging.properties檔案。這個屬性檔案至少定義 org.apache.commons.logging.Log屬性，它的值應該是上述任意Log介面實現的完整限定名稱。如果找到 org.apache.commons.logging.Log屬相，則使用該屬相對應的日誌組件。結束髮現過程。  ⑵ 如果上面的步驟失敗（檔案不存在或屬相不存在），Commons的Logging接著檢查系統屬性 org.apache.commons.logging.Log。如果找到org.apache.commons.logging.Log系統屬性，則使用該系統屬性對應的日誌組件。結束髮現過程。  ⑶ 如果找不到org.apache.commons.logging.Log系統屬性，Logging接著在CLASSPATH中尋找log4j的類。如果找到了，Logging就假定應用要使用的是log4j。不過這時log4j本身的屬性仍要通過log4j.properties檔案正確配置。結束髮現過程。  ⑷ 如果上述尋找均不能找到適當的Logging API，但應用程式正運行在JRE 1.4或更高版本上，則預設使用JRE 1.4的日誌記錄功能。結束髮現過程。  ⑸ 最後，如果上述操作都失敗（JRE 版本也低於1.4），則應用將使用內建的SimpleLog。SimpleLog把所有日誌資訊直接輸出到System.err。結束髮現過程。  以下主要學習log4j  一、 Log4j的架構  Log4j系統的三大板塊：日誌寫入器、日誌輸出終端、日誌配置模式。    Logger類是日誌包的核心，Logger的名稱是大小寫敏感的，並且名稱之間有繼承關係。子名由父名做首碼，用點號“.”分隔，如x.y是x.y.z的父親Logger。  Logger系統中有個根logger，是所有logger的祖先，它總是存在的，並且不可以通過名字擷取，可以通過Logger.getRootLogger()來擷取。擷取Logger對象的方法很多，可以參考API文檔，在某對象中，用該對象所屬的類作為參數，調用Logger.getLogger(Class clazz)以擷取logger對象被認為是目前所知最理智的命名logger方法。  二、 Log4j的記錄層級（Level）  每個logger都有一個記錄層級，用來控制日誌的輸出。未分配層級的logger將自動繼承它最近的父logger的記錄層級。Logger的由低到進階別如下：  ALL<DEBUG<INFO<WARN<ERROR<FATAL<OFF  三、 Log4j的輸出終端（Appender介面）  Log4j提供了以下幾個實現： Java代碼  org.apache.log4j.ConsoleAppender(控制台)    org.apache.log4j.FileAppender(檔案)    org.apache.log4j.DailyRollingFileAppender(每天都產生一個記錄檔)    org.apache.log4j.RollingFileAppender(檔案大小達到指定尺寸時產生一個新的記錄檔，檔案名稱上會自動添加數字序號。)    org.apache.log4j.WriterAppender(將日誌資訊以流的格式發送到任意指定的地方)   預設情況下，子logger將繼承父logger的所有appenders。  四、 Log4j的輸出配置模式（Layout介面）  Log4j提供Layout有以下幾種： Java代碼  org.apache.log4j.HTMLLayout（以HTML表格形式布局）    org.apache.log4j.PatternLayout（可以靈活地指定配置模式）    org.apache.log4j.SimpleLayout（包含日誌資訊的層級和資訊字串）    org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等資訊）   Log4j採用類似C語言中的printf函數的列印格式格式化日誌資訊。列印參數如下： Java代碼  %m：輸出代碼中指定的訊息。    %p：輸出優先順序。    %r：輸入自應用啟動到輸出該log資訊耗費的毫秒數。    %c：輸出所屬的類目，通常就是所在類的全名。    %t：輸出產生該日誌線程的線程名。    %n：輸出一個斷行符號分行符號。Windows平台為“/r/n”，UNIX為“/n”。    %d：輸出日誌時間點的日期或時間，預設格式為ISO8601，推薦使用“%d{ABSOLUTE}”，這個輸出格式形如：“2007-05-07 18:23:23,500”，符合中國人習慣。    %l：輸出日誌事件發生的位置，包括類名、線程名，以及所在代碼的行數。   五、 Log4j的配置  在實際使用中，Log4j一般是通過設定檔配置使用的。設定檔有兩種，Java properties和XML檔案。一般都選用properties檔案來配置，因為簡潔易讀。下面只介紹Java properties的配置方式。  對Log4j的配置就是對rootLogger和子Logger的配置。主要的配置項為：rootLogger、輸出終端、輸出配置模式，所有的配置項都必須以log4j開頭。  設定檔的樣本 Java代碼  ##Log4J的配置之簡單使它遍及于越來越多的應用中了       ##Log4J設定檔實現了輸出到控制台、檔案、復原檔案、發送日誌郵件、輸出到資料庫日誌表、自訂標籤等全套功能。擇其一二使用就夠用了。       ##此檔案（log4j.properties）內容來自網路，非本文作者liigo原創。    log4j.rootLogger = DEBUG, CONSOLE,A1    log4j.addivity.org.apache = true      # 應用於控制台    log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender    log4j.appender.Threshold = DEBUG    log4j.appender.CONSOLE.Target = System.out    log4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayout    log4j.appender.CONSOLE.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n    #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       #應用於檔案    log4j.appender.FILE = org.apache.log4j.FileAppender    log4j.appender.FILE.File = file.log    log4j.appender.FILE.Append = false   log4j.appender.FILE.layout = org.apache.log4j.PatternLayout    log4j.appender.FILE.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n    # Use this layout for LogFactor 5 analysis       # 應用於檔案復原    log4j.appender.ROLLING_FILE = org.apache.log4j.RollingFileAppender    log4j.appender.ROLLING_FILE.Threshold = ERROR    log4j.appender.ROLLING_FILE.File = rolling.log    log4j.appender.ROLLING_FILE.Append = true   log4j.appender.ROLLING_FILE.MaxFileSize = 10KB    log4j.appender.ROLLING_FILE.MaxBackupIndex = 1   log4j.appender.ROLLING_FILE.layout = org.apache.log4j.PatternLayout    log4j.appender.ROLLING_FILE.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n       #應用於socket    log4j.appender.SOCKET = org.apache.log4j.RollingFileAppender    log4j.appender.SOCKET.RemoteHost = localhost    log4j.appender.SOCKET.Port = 5001   log4j.appender.SOCKET.LocationInfo = true   # Set up for Log Facter 5   log4j.appender.SOCKET.layout = org.apache.log4j.PatternLayout    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       # Log Factor 5 Appender    log4j.appender.LF5_APPENDER = org.apache.log4j.lf5.LF5Appender    log4j.appender.LF5_APPENDER.MaxNumberOfRecords = 2000      # 發送日誌給郵件    log4j.appender.MAIL = org.apache.log4j.net.SMTPAppender    log4j.appender.MAIL.Threshold = FATA    log4j.appender.MAIL.BufferSize = 10   log4j.appender.MAIL.From = web@www.wuset.com    log4j.appender.MAIL.SMTPHost = www.wusetu.com    log4j.appender.MAIL.Subject = Log4J Message    log4j.appender.MAIL.To = web@www.wusetu.com    log4j.appender.MAIL.layout = org.apache.log4j.PatternLayout    log4j.appender.MAIL.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n          # 用於資料庫    log4j.appender.DATABASE = org.apache.log4j.jdbc.JDBCAppender    log4j.appender.DATABASE.URL = jdbc:mysql: // localhost:3306/test    log4j.appender.DATABASE.driver = com.mysql.jdbc.Driver    log4j.appender.DATABASE.user = root    log4j.appender.DATABASE.password =    log4j.appender.DATABASE.sql = INSERT INTO LOG4J (Message) VALUES ( ' [framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n ' )    log4j.appender.DATABASE.layout = org.apache.log4j.PatternLayout    log4j.appender.DATABASE.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n    log4j.appender.A1 = org.apache.log4j.DailyRollingFileAppender    log4j.appender.A1.File = SampleMessages.log4j    log4j.appender.A1.DatePattern = yyyyMMdd - HH ' .log4j '   log4j.appender.A1.layout = org.apache.log4j.xml.XMLLayout       #自訂Appender    log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender    log4j.appender.im.host = mail.cybercorlin.net    log4j.appender.im.username = username    log4j.appender.im.password = password    log4j.appender.im.recipient = corlin@cybercorlin.net    log4j.appender.im.layout = org.apache.log4j.PatternLayout    log4j.appender.im.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n       # 結束