常用的日誌控件有commons-logging、Log4j以及JDK1.4自帶的Logging。
日誌簡介:
早期,java開發用System.out.println(),輸出到屏幕,但是這種輸出不可控制,日誌的可讀性差,而且輸出到屏幕需要消耗資源,大量的IO操作會使程序運行變慢。
JKD1.4自帶的Logging,從JDK1.4起,JDK開始自帶一套日誌系統。JDK Logging最大的優點是不需要任何類庫的支持,只要java運行環境就可以運行。但是相對於其他日誌控件,JDK自帶的控件無論是易用性、功能還是擴展型都不如其他的好用,基本上不適用。
Log4j控件,目前使用最廣泛的日誌控件,它把日誌分爲ALL、TRACE、DEBUG、INFO、WARN、ERROR、FITAL、OFF(由低到高)。
ALL 是最低等級的,用於打開所有日誌記錄。
DEBUG 指出細粒度信息事件對調試應用程序是非常有幫助的。
INFO 表明 消息在粗粒度級別上突出強調應用程序的運行過程。
WARN 表明會出現潛在錯誤的情形。
ERROR 指出雖然發生錯誤事件,但仍然不影響系統的繼續運行。
FATAL 指出每個嚴重的錯誤事件將會導致應用程序的退出。
OFF 是最高等級的,用於關閉所有日誌記錄。
commons-logging控件,是apache commons類庫中的一員,Apache類庫是一個通用的類庫,提供了基礎的功能,例如commons-fileupload,commons-httpclient,commons-io,commons-codec等。commons-logging不是一個日誌控件,沒有日誌功能,它只是統一了JDK Logging與Log4j的API,並把日誌功能交給JDK Logging或者Log4j。對於不能確定日誌方式的系統,commons-logging是個不錯的選擇。Spring、Hibernate、Struts等都使用的是commons-logging。
第一、Logger.getLogger()和LogFactory.getLog()的區別
1.Logger.getLogger()是使用log4j的方式記錄日誌;
2.LogFactory.getLog()則來自apache的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()時發生的事情。調用該函數會啓動一個發現過程,即找出必需的底層日誌記錄功能的實現,具體的發現過程在下面列出: ( 換句話說就是,
有這麼多工具,common-logging該使用哪一個呢?這取決於系統的設置,common-logging將按以下順序決定使用哪個日誌記錄工具:)
(1).common-logging首先在CLASSPATH中查找commons-logging.properties文件。這個屬性文件至少定義org.apache.commons.logging.Log屬性,它的值應該是上述任意Log接口實現的完整限定名稱。如果找到 org.apache.commons.logging.Log屬相,則使用該屬相對應的日誌組件。結束髮現過程。
(2).如果上面的步驟失敗(文件不存在或屬相不存在),common-logging接着檢查系統屬性org.apache.commons.logging.Log。如果找到org.apache.commons.logging.Log系統屬性,則使用該系統屬性對應的日誌組件。結束髮現過程。
(3).如果找不到org.apache.commons.logging.Log系統屬性,common-logging接着在CLASSPATH中尋找log4j的類。如果找到了就假定應用要使用的是log4j。不過這時log4j本身的屬性仍要通過log4j.properties文件正確配置。結束髮現過程。
(4).如果上述查找均不能找到適當的Logging API,但應用程序正運行在JRE 1.4或更高版本上,則默認使用JRE 1.4的日誌記錄功能。結束髮現過程。
(5).最後,如果上述操作都失敗(JRE 版本也低於1.4),則應用將使用內建的SimpleLog。SimpleLog把所有日誌信息直接輸出到System.err。結束髮現過程。
爲了簡化配置 commons-logging ,一般不使用 commons-logging 的配置文件,也不設置與 commons-logging 相關的系統環境變量,而只需將 Log4j 的 Jar 包放置到 classpash 中就可以了。這樣就很簡單地完成了 commons-logging 與 Log4j 的融合。
根據不同的性質,日誌信息通常被分成不同的級別,從低到高依次是:“調試( DEBUG )”“信息( INFO )”“警告( WARN )”“錯誤(ERROR )”“致命錯誤( FATAL )”。
舉例說明:
基於common-logging的運行方式:
package org;
import org.apache.commons.logging.Log;
import org.apache.log4j.Logger;
public class Test extends TagSupport{
public static Log log=LogFactory.getLog(Test.class);
public static void test()
{
log.debug("111");
log.info("125");
log.warn("485");
log.error("error");
}
public static void main(String[] a)
{
Test.test();
}
}
基於log4j的運行方式
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
public class TestLog4j {
static Logger logger = Logger.getLogger(TestLog4j.class);
public static void main(String args[]) {
PropertyConfigurator.configure("log4j.properties");
logger.debug("Here is some DEBUG");
logger.info("Here is some INFO");
logger.warn("Here is some WARN");
logger.error("Here is some ERROR");
logger.fatal("Here is some FATAL");
}
}
第二、詳細介紹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提供了以下幾個實現:
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有以下幾種:
org.apache.log4j.HTMLLayout(以HTML表格形式佈局)
org.apache.log4j.PatternLayout(可以靈活地指定佈局模式)
org.apache.log4j.SimpleLayout(包含日誌信息的級別和信息字符串)
org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等信息)
Log4j採用類似C語言中的printf函數的打印格式格式化日誌信息。打印參數如下:
%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開頭。
配置文件的示例
##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 = [email protected]
log4j.appender.MAIL.SMTPHost = www.wusetu.com
log4j.appender.MAIL.Subject = Log4J Message
log4j.appender.MAIL.To = [email protected]
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 = [email protected]
log4j.appender.im.layout = org.apache.log4j.PatternLayout
log4j.appender.im.layout.ConversionPattern = [framework] % d - % c -%- 4r [ % t] %- 5p % c % x - % m % n
# 結束
Log4j控件:
Log4j的執行效率,Log4j只在初始化的時候打開文件,並保持對文件的寫控制,直到在系統結束的時候才關閉文件。這樣就是IO次數達到最小,提高效率。
Log4j.properties配置文件,默認的配置文件爲log4j.properties。啓動時會加載classpath下的log4j.properties初始化Log4j。如果文件不存在,Log4j會在控制檯打印沒有找到Log4j配置。如果不適用默認的文件名log4j.properties,可以使用PropertyConfigurator指定配置文件的路徑。
log4j.properties配置文件:
log4j.xml配置文件:
日誌記錄器Logger:
負責記錄日誌。
輸出地Appender:
負責輸出到什麼地方。
輸出格式Layout:
負責以什麼格式輸出,輸出哪些附加信息。
當使用.class獲取logger對象的時候,查看當前類所處的路徑可用如下方法,當時servlet類時候,log4j相對應的是tomcat的路徑,產生的日誌文件也是相對tomcat路徑進行存放的
new File("").getAbsolutePath();
PS:內容來自資料的搜索總結,謝謝提供資料的網友