Log4j日誌輸出詳細
日誌論
在應用程式中輸出日誌有有三個目的:
(1)監視程式碼中變數的變化情況,把資料週期性地記錄到檔案中供其他應用進行統計分析工作。
(2)跟蹤程式碼執行進軌跡,作為日後審計的依據。
(3)擔當整合開發環境中的偵錯程式,向檔案或控制檯列印程式碼的除錯資訊。
Apache能用日誌包(Commons LoggingPackage)是Apache的一個開放原始碼專案,它提供了一組通用的日誌介面,使用者可以自由地選擇實現日誌介面的第三方軟體。通用日誌包目前支援以下日誌實現:
- JDK1.4 Logging日誌器(JDK1.4自帶)
- SimpleLog日誌器(把日誌訊息輸出到標準系統錯誤流System.err)
- NoOpLog(不輸出任何日誌資訊)
通用日誌包中的兩個常用介面:LogFactory和Log,分別介紹如下:
- Log介面
通用日誌包把訊息分為6個級別:FATAL、ERROR、WARN、INFO、DEBUG和TRACE。其中FATAL級別最高,TRACE級別最低。Log介面提供輸出不同級別訊息的方法:
off---------------------------------最高等級的,用於關閉所有日誌記錄
fatal(Object message)-------輸出FATAL級別的訊息。
error(Object message)-------輸出ERROR級別的訊息。
warn(Object message)-------輸出WARN級別的訊息。
info(Object message)-------輸出INFO級別的訊息。
debug(Object message)-------輸出DEBUG級別的訊息。
trace(Object message)-------輸出TRACE級別的訊息。
all----------------------------------最低等級的,用於開啟所有日誌記錄
注:只有當輸出日誌的級別大於或等於為日誌配置器配置的日誌級別時,這個方法才會執行。
如何指定日誌器的日誌級別,不同的日誌器實現會有不同的實現方案。
- LogFactory介面
LogFactory介面提供了獲得日誌器例項的兩個靜態方法:
public static Log getLog(String name) throwsLogConfigurationException;
public static Log getLog(Class class) throwsLogConfigurationException;
注:name引數作為日誌器的名字;class引數指定類名作為日誌器名字。
log4j簡介
幾乎每個大的應用程式都有它自己的日誌和跟蹤程式的API。順應這一規則,E.U. SEMPER專案組決定編寫它自己的程式跟蹤API(tracing API)。這開始於1996年早期。經過無數的工作,更改和效能加強,這個API終於成為一個十分受歡迎的Java日誌軟體包,那就是log4j。這個軟體包的發行遵守open source動議認證的Apache Software License。最新的log4j版本包括全部的原始碼,類檔案和文件資料,可以在 http://logging.apache.org/log4j/找到它們。另外,log4j已經被轉換成 C, C++, C#, Perl, Python, Ruby, 和 Eiffel 語言。
Log4j是Apache的一個開放原始碼專案,通過使用Log4j,我們可以控制日誌資訊輸送的目的地是控制檯、檔案、GUI元件、甚至是套介面伺服器、NT的事件記錄器、UNIX Syslog守護程序等;我們也可以控制每一條日誌的輸出格式;通過定義每一條日誌資訊的級別,我們能夠更加細緻地控制日誌的生成過程。最令人感興趣的就是,這些可以通過一個配置檔案來靈活地進行配置,而不需要修改應用的程式碼。
log4j三個元件
通常,我們都提供一個名為log4j.properties的檔案,在第一次呼叫到Log4J時,Log4J會在類路徑(../web-inf/class/當然也可以放到其它任何目錄,只要該目錄被包含到類路徑中即可)中定位這個檔案,並讀入這個檔案完成的配置。這個配置檔案告訴Log4J以什麼樣的格式、把什麼樣的資訊、輸出到什麼地方。
Log4j有三個主要的元件:Loggers(記錄器),Appenders(輸出源)和Layouts(佈局),這裡可簡單理解為日誌類別,日誌要輸出的地方和日誌以何種形式輸出。綜合使用這三個元件可以輕鬆的記錄資訊的型別和級別,並可以在執行時控制日誌輸出的樣式和位置。下面對三個元件分別進行說明:
1、 Loggers
Loggers元件在此係統中被分為五個級別:DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序的,DEBUG < INFO < WARN< ERROR < FATAL,分別用來指定這條日誌資訊的重要程度,明白這一點很重要,這裡Log4j有一個規則:假設Loggers級別為P,如果在Loggers中發生了一個級別Q比P高,則可以啟動,否則遮蔽掉。
假設你定義的級別是info,那麼error和warn的日誌可以顯示而比他低的debug資訊就不顯示了。
Java程式舉例來說:
//建立Logger的一個例項,命名為“com.foo”
Logger logger =Logger.getLogger("com.foo"); //"com.foo"是例項進行命名,也可以任意
//設定logger的級別。通常不在程式中設定logger的級別。一般在配置檔案中設定。
logger.setLevel(Level.INFO);
Logger barlogger =Logger.getLogger("com.foo.Bar");
//下面這個請求可用,因為WARN >= INFO
logger.warn("Low fuel level.");
//下面這個請求不可用,因為DEBUG < INFO
logger.debug("Starting search for nearest gasstation.");
//命名為“com.foo.bar”的例項barlogger會繼承例項“com.foo”的級別。因此,下面這個請求可用,因為INFO >= INFO
barlogger.info("Located nearest gasstation.");
//下面這個請求不可用,因為DEBUG < INFO
barlogger.debug("Exiting gas stationsearch");
這裡“是否可用”的意思是能否輸出Logger資訊。
在對Logger例項進行命名時,沒有限制,可以取任意自己感興趣的名字。一般情況下建議以類的所在位置來命名Logger例項,這是目前來講比較有效的Logger命名方式。這樣可以使得每個類建立自己的日誌資訊,便於管理。比如:
static Logger logger =Logger.getLogger(ClientWithLog4j.class.getName());
2、Appenders
禁用與使用日誌請求只是Log4j其中的一個小小的地方,Log4j日誌系統允許把日誌輸出到不同的地方,如控制檯(Console)、檔案(Files)、根據天數或者檔案大小產生新的檔案、以流的形式傳送到其它地方等等。
其語法表示為:
org.apache.log4j.ConsoleAppender(控制檯)
org.apache.log4j.FileAppender(檔案)
org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌檔案)
org.apache.log4j.RollingFileAppender(檔案大小到達指定尺寸的時候產生一個新的檔案)
org.apache.log4j.WriterAppender(將日誌資訊以流格式傳送到任意指定的地方)
配置時使用方式為:
log4j.appender.appenderName =fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN
這樣就為日誌的輸出提供了相當大的便利。
3、Layouts
有時使用者希望根據自己的喜好格式化自己的日誌輸出。Log4j可以在Appenders的後面附加Layouts來完成這個功能。Layouts提供了 四種日誌輸出樣式,如根據HTML樣式、自由指定樣式、包含日誌級別與資訊的樣式和包含日誌時間、執行緒、類別等資訊的樣式等等。
其語法表示為:
org.apache.log4j.HTMLLayout(以HTML表格形式佈局),
org.apache.log4j.PatternLayout(可以靈活地指定佈局模式),
org.apache.log4j.SimpleLayout(包含日誌資訊的級別和資訊字串),
org.apache.log4j.TTCCLayout(包含日誌產生的時間、執行緒、類別等等資訊)
配置時使用方式為:
log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
log4j基本程式設計方法
以上是從原理方面說明Log4j的使用方法,在具體Java程式設計使用Log4j可以參照以下示例:
1、 建立Logger例項:
語法表示:public static Logger getLogger( String name)
實際使用:static Logger logger =Logger.getLogger(ServerWithLog4j.class.getName ()) ;
2、 讀取配置檔案:
獲得了Logger的例項之後,接下來將配置Log4j使用環境:
語法表示:
BasicConfigurator.configure():自動快速地使用預設Log4j環境。
PropertyConfigurator.configure(String configFilename):讀取使用Java的特性檔案編寫的配置檔案。
DOMConfigurator.configure(String filename):讀取XML形式的配置檔案。
實際使用:
PropertyConfigurator.configure("log4j.properties");
若log4j.properties放在工程的根目錄,可以不寫上面的程式語句,程式會自動找到配置檔案。
3、 插入日誌資訊
完成了以上連個步驟以後,下面就可以按日誌的不同級別插入到你要記錄日誌的任何地方了。
語法表示:
Logger.debug(Object message);//除錯資訊
Logger.info(Object message);//一般資訊
Logger.warn(Object message);//警告資訊
Logger.error(Object message);//錯誤資訊
Logger.fatal(Object message);//致命錯誤資訊
實際使用:logger.info("ServerSocket before accept: "+ server);
log4j配置檔案 在實際程式設計時,要使Log4j真正在系統中執行事先還要對配置檔案進行定義。定義步驟就是對Logger、Appender及Layout的分別使用。
Log4j支援兩種配置檔案格式,一種是XML格式的檔案,一種是java properties(key=value)【Java特性檔案(鍵=值)】。下面我們介紹使用Java特性檔案做為配置檔案的方法
具體如下:
1、配置根Logger,其語法為:
log4j.rootLogger = [ level ] , appenderName1,appenderName2, …
level : 是日誌記錄的優先順序,分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別,優先順序從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裡定義的級別,您可以控制到應用程式中相應級別的日誌資訊的開關。比如在這裡定 義了INFO級別,則應用程式中所有DEBUG級別的日誌資訊將不被打印出來。
appenderName:就是指定日誌資訊輸出到哪個地方。您可以同時指定多個輸出目的地。
例如:log4j.rootLogger=info,A1,B2,C3
2、配置日誌資訊輸出目的地,其語法為:
log4j.appender.appenderName =fully.qualified.name.of.appender.class //
"fully.qualified.name.of.appender.class" 可以指定下面五個目的地中的一個:
1.org.apache.log4j.ConsoleAppender(控制檯)
2.org.apache.log4j.FileAppender(檔案)
3.org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌檔案)
4.org.apache.log4j.RollingFileAppender(檔案大小到達指定尺寸的時候產生一個新的檔案)
5.org.apache.log4j.WriterAppender(將日誌資訊以流格式傳送到任意指定的地方)
1.ConsoleAppender選項
Threshold=WARN:指定日誌訊息的輸出最低層次。
ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
Target=System.err:預設情況下是:System.out,指定輸出控制檯
2.FileAppender 選項
Threshold=WARN:指定日誌訊息的輸出最低層次。
ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
File=mylog.txt:指定訊息輸出到mylog.txt檔案。
Append=false:預設值是true,即將訊息增加到指定檔案中,false指將訊息覆蓋指定的檔案內容。
3.DailyRollingFileAppender選項
Threshold=WARN:指定日誌訊息的輸出最低層次。
ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
File=mylog.txt:指定訊息輸出到mylog.txt檔案。
Append=false:預設值是true,即將訊息增加到指定檔案中,false指將訊息覆蓋指定的檔案內容。
DatePattern='.'yyyy-ww:每週滾動一次檔案,即每週產生一個新的檔案。當然也可以指定按月、周、天、時和分。即對應的格式如下:
1)'.'yyyy-MM: 每月
2)'.'yyyy-ww: 每週
3)'.'yyyy-MM-dd: 每天
4)'.'yyyy-MM-dd-a: 每天兩次
5)'.'yyyy-MM-dd-HH: 每小時
6)'.'yyyy-MM-dd-HH-mm: 每分鐘
4.RollingFileAppender選項
Threshold=WARN:指定日誌訊息的輸出最低層次。
ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
File=mylog.txt:指定訊息輸出到mylog.txt檔案。
Append=false:預設值是true,即將訊息增加到指定檔案中,false指將訊息覆蓋指定的檔案內容。
MaxFileSize=100KB: 字尾可以是KB, MB 或者是 GB. 在日誌檔案到達該大小時,將會自動滾動,即將原來的內容移到mylog.log.1檔案。
MaxBackupIndex=2:指定可以產生的滾動檔案的最大數。
實際應用:
log4j.appender.A1=org.apache.log4j.ConsoleAppender //這裡指定了日誌輸出的第一個位置A1是控制檯ConsoleAppender
3、配置日誌資訊的格式,其語法為:
1). log4j.appender.appenderName.layout =fully.qualified.name.of.layout.class
"fully.qualified.name.of.layout.class" 可以指定下面4個格式中的一個:
1.org.apache.log4j.HTMLLayout(以HTML表格形式佈局),
2.org.apache.log4j.PatternLayout(可以靈活地指定佈局模式),
3.org.apache.log4j.SimpleLayout(包含日誌資訊的級別和資訊字串),
4.org.apache.log4j.TTCCLayout(包含日誌產生的時間、執行緒、類別等等資訊)
1.HTMLLayout 選項
LocationInfo=true:預設值是false,輸出java檔名稱和行號
Title=my app file: 預設值是 Log4J Log Messages.
2.PatternLayout選項
ConversionPattern=%m%n :指定怎樣格式化指定的訊息。
3.XMLLayout 選項
LocationInfo=true:預設值是false,輸出java檔案和行號
實際應用:
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
2).log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS}%c %m%n
這裡需要說明的就是日誌資訊格式中幾個符號所代表的含義:
-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字元,就從左邊交遠銷出的字元截掉。
這裡上面三個步驟是對前面Log4j元件說明的一個簡化;下面給出一個具體配置例子,在程式中可以參照執行:
log4j.rootLogger=INFO,A1,B2
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p%d{yyyy-MM-dd HH:mm:ssS} %c %m%n
根據上面的日誌格式,某一個程式的輸出結果如下:
0 INFO 2003-06-13 13:23:46968 ClientWithLog4j Client socket:Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says: 'Java server withlog4j, Fri Jun 13 13:23:46 CST 2003'
16 DEBUG 2003-06-1313:23:46984 ClientWithLog4j GOOD
16 DEBUG 2003-06-1313:23:46984 ClientWithLog4j Server responds: 'Command 'HELLO' not understood.'
16 DEBUG 2003-06-1313:23:46984 ClientWithLog4j HELP
16 DEBUG 2003-06-1313:23:46984 ClientWithLog4j Server responds: 'Vocabulary: HELP QUIT'
16 DEBUG 2003-06-1313:23:46984 ClientWithLog4j QUIT
4. 當輸出資訊於回滾檔案時
log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender //指定以檔案的方式輸出日誌
log4j.appender.ROLLING_FILE.Threshold=ERROR
log4j.appender.ROLLING_FILE.File=rolling.log //檔案位置,也可以用變數${java.home}、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
5.Log4J對應用效能的影響
如果在程式執行中輸出大量日誌,顯然會對應用的效能造成一定的影響。Log4J對效能的影響取決於以下因素:
- 日誌輸出目的地:輸出到控制檯的速度和輸出到檔案系統的速度是不一樣的。
- 日誌輸出格式:格式簡單,速度也更快。
- 日誌級別:日誌級別設定的越低,輸出的日誌內容越多,對效能的影響也越大。
log4j全能配置檔案(轉自gmmgood)
使用XML配置檔案
首先,看看下面的XML配置檔案示例:
<?xml version="1.0"encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="ConsoleAppender"class="org.apache.log4j.ConsoleAppender">
<layoutclass="org.apache.log4j.SimpleLayout"/>
</appender>
<root>
<priority value ="debug" />
<appender-ref ref="ConsoleAppender"/>
</root>
</log4j:configuration>
檔案以標準的XML宣告作為開始,後面跟著指出DTD(文件型別定義)的DOCTYPE宣告,它定義了XML檔案的結構,例如,什麼元素可以嵌入在其他元素中等等。上面檔案在log4j發行版的src/java/org/apache/log4j/xml目錄中。 接著看看封裝所有元素的 log4j:configuration 元素,它在DOCTYPE宣告中被指定為根元素。嵌入在根元素中有兩個結構:
<appendername="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
<layoutclass="org.apache.log4j.SimpleLayout"/>
</appender>
這裡建立一個名叫"ConsoleAppender"的 Appender,注意,你可以選擇任何名字,該示例之所以選擇"ConsoleAppender",完全是為了示例的設計。接著這個appender類以全名形式給出,經常用規範(fully qualified)類名。 Appender必須具有一個指定的 name和class。嵌入在 Appender之內的是 layout元素,這裡它被指定為SimpleLayout。 Layout 必須具有一個 class屬性。
<root>
<priority value ="debug" />
<appender-ref ref="ConsoleAppender"/>
</root>
root元素必須存在且不能被子類化。示例中的優先順序被設定為"debug",設定appender飽含一個appender-ref元素。還有更多的屬性或元素可以指定。檢視log4j發行版中的src/java/org/apache/log4j/xml/log4j.dtd以瞭解關於XML配置檔案結構的更多資訊。可以用下面這種方法把配置資訊檔案讀入到Java程式中:
DOMConfigurator.configure("configurationfile.xml");
DOMConfigurator 用一棵DOM樹來初始化log4j環境。這裡是示例中的XML配置檔案:configurationfile.xml。這裡是執行該配置檔案的java程式:
import org.apache.log4j.Logger;
import org.apache.log4j.xml.DOMConfigurator;
public class externalxmltest {
static Logger logger = Logger.getLogger(filetest.class);
public static void main(String args[]) {
DOMConfigurator.configure("xmllog4jconfig.xml");
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");
}
}
對於帶有PatternLayout的FileAppender的日誌記錄器Logger的XML配置檔案:
<?xml version="1.0"encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="appender"class="org.apache.log4j.FileAppender">
<param name="File"value="Indentify-Log.txt"/>
<param name="Append"value="true"/>
<layoutclass="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"value="%d [%t] %p - %m%n"/>
</layout>
</appender>
<root>
<priority value ="info"/>
<appender-ref ref="appender"/>
</root>
</log4j:configuration>
log4j日誌寫入資料庫
首先建立一資料庫表:
欄位 |
描述 |
GUID |
流水號 IDENTITY (1, 1) |
DATE |
時間 |
THREAD |
當前執行緒 |
LEVEL |
當前級別 |
CLASS |
當前類的java程式/方法 |
MESSAGES |
當前輸出資訊 |
EXCEPTION |
異常資訊 |
log4j.properties如下配置:
log4j.rootLogger=DEBUG,CONSOLE,DATABASE
log4j.addivity.org.apache=true
########################
# JDBC Appender
#######################
log4j.appender.DATABASE.Threshold=INFO
log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender
#log4j.appender.DATABASE.BufferSize=10
log4j.appender.DATABASE.URL=you jdbcurl
log4j.appender.DATABASE.driver=you jdbc driver
log4j.appender.DATABASE.user=
log4j.appender.DATABASE.password=
log4j.appender.DATABASE.sql=INSERTINTO YOU_LOG_TABLE VALUES ('%d{yyyy-MM-dd HH:mm:ss}', '%t', '%p','%l', '%m', '')
log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout
下面我們對“%d %t %p %l %m%n”一一講解:
l %d輸出日誌時間點的日期或時間,預設格式為ISO8601,也可以在其後指定格式,比如:%d{yyyy-MM-ddHH:mm:ss},輸出類似:2006-01-18 17:50:22',剛好適合插入SQLServer;
l %t 產生該日誌事件的執行緒名;
l %p 日誌的log_level,如DEBUG、WARN或者INFO;
l %c 輸出所屬的類目,通常就是所在類的全名,如“com.eking.TestLog”;
l %m 日誌的內容;
l %l 輸出日誌事件的發生位置,包括類目名、發生的執行緒,以及在程式碼中的行數。如Wite2Database.main(Wite2Database.java:18);
l %n 輸出一個回車換行符,Windows平臺為“ ”,Unix平臺為“ ”
程式程式碼:
import sun.jdbc.odbc.*;
import java.sql.*;
import org.apache.log4j.Category;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
import org.apache.log4j.jdbc.*;
public class Write2Database{
public static void main(String[] args){
static Logger logger = Logger.getLogger
(write2database.class.getName () ) ;
PropertyConfigurator.configure ("log4j2database.properties" ) ;
logger.info ( "test" ) ;
}
}
執行起來,你就會看到有這樣的sql語句被執行了:
INSERT INTO jws_log VALUES('2006-01-18 17:50:22', 'main', 'INFO','Wite2Database.main(Write2Database.java:18)', 'test', '')
注意:在賽迪論壇上有一個筆者按照上述類似的方法沒有執行成功,現將他所出現的問題和解決方法轉載。
上述方法是利用傳統的資料庫連線方法,對於資料庫的管理和效率嚴重不足,在現在這個連線池橫行的時代,為什麼我們不能給給Log4j配上連線池,讓Log4j利用資料連線池的連線和資料庫進行通訊。現檢視Log4j的Api,發現JDBCAppender這個類有以下幾段話:WARNING:This version of JDBCAppender is very likely to be completely replaced in thefuture. Moreoever, it does not log exceptions. The JDBCAppender provides for sendinglog events to a database.
For use as a base class:
- Override
getConnection()
to pass any connection you want. Typically this is used to enable application wide connection pooling. - Override
closeConnection(Connection con)
-- if you override getConnection make sure to implementcloseConnection
to handle the connection you generated. Typically this would return the connection to the pool it came from. - Override
getLogStatement(LoggingEvent event)
to produce specialized or dynamic statements. The default uses the sql option value.
原來log4j建議我們把其提供的JDBCAppender作為基類來使用,然後Override三個父類的方法:getConnection(),closeConnection(Connectioncon)和getLogStatement(LoggingEventevent)。
原來如此,那就寫一個子類JDBCPoolAppender來替代這個JDBCAppender
JDBCPoolAppender程式碼和其相關程式碼如下:
JDBCPoolAppender.java:
package common.log;
import java.sql.Connection;
import org.apache.log4j.spi.LoggingEvent;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Iterator;
import org.apache.log4j.spi.ErrorCode;
import org.apache.log4j.PatternLayout;
import common.sql.MyDB;
import common.sql.GeneralDb;
public class JDBCPoolAppender extendsorg.apache.log4j.jdbc.JDBCAppender {
private MyDB mydb = null;
protected String sqlname=""; //增加一個數據庫jndiName的屬性
protected Connection connection = null;
protected String sqlStatement = "";
/**
* size of LoggingEvent buffer before writting to thedatabase.
* Default is 1.
*/
protected int bufferSize = 1;
public JDBCPoolAppender() {
super();
}
/**
* ArrayList holding the buffer of Logging Events.
*/
public void append(LoggingEvent event) {
buffer.add(event);
if (buffer.size() >= bufferSize)
flushBuffer();
}
/**
* By default getLogStatement sends the event to therequired Layout object.
* The layout will format the given pattern into aworkable SQL string.
*
* Overriding this provides direct access to theLoggingEvent
* when constructing the logging statement.
*
*/
protected String getLogStatement(LoggingEvent event){
return getLayout().format(event);
}
/**
*
* Override this to provide an alertnate method ofgetting
* connections (such as caching). One method to fix this is to open
* connections at the start of flushBuffer() and closethem at the
* end. I use a connectionpool outside of JDBCAppender which is
* accessed in an override of this method.
* */
protected void execute(String sql) throws SQLException{
Connection con = null;
Statement stmt = null;
try {
con = getConnection();
stmt = con.createStatement();
stmt.executeUpdate(sql);
} catch (SQLException e) {
if (stmt != null)
stmt.close();
throw e;
}
stmt.close();
closeConnection(con);
//System.out.println("Execute: " + sql);
}
/**
* Override this to return the connection to a pool,or to clean up the
* resource.
*
* The default behavior holds a single connection openuntil the appender
* is closed (typically when garbage collected).
*/
protected void closeConnection(Connection con) {
mydb=null;
try {
if (connection != null &&!connection.isClosed())
connection.close();
} catch (SQLException e) {
errorHandler.error("Error closing connection",e,
ErrorCode.GENERIC_FAILURE);
}
}
/**
* Override 此函式來利用連線池返回一個Connetion物件
*
*/
protected Connection getConnection() throwsSQLException {
try {
mydb = GeneralDb.getInstance(sqlname);
connection = mydb.getConnection();
} catch (Exception e) {
errorHandler.error("Error openingconnection", e, ErrorCode.GENERIC_FAILURE);
}
return connection;
}
/**
* Closes the appender, flushing the buffer first thenclosing the default
* connection if it is open.
*/
public void close() {
flushBuffer();
try {
if (connection != null &&!connection.isClosed())
connection.close();
} catch (SQLException e) {
errorHandler.error("Error closingconnection", e,
ErrorCode.GENERIC_FAILURE);
}
this.closed = true;
}
/**
* loops through the buffer of LoggingEvents, gets a
* sql string from getLogStatement() and sends it toexecute().
* Errors are sent to the errorHandler.
*
* If a statement fails the LoggingEvent stays in thebuffer!
*/
public void flushBuffer() {
//Do the actual logging
removes.ensureCapacity(buffer.size());
for (Iterator i = buffer.iterator(); i.hasNext(); ) {
try {
LoggingEvent logEvent = (LoggingEvent) i.next();
String sql = getLogStatement(logEvent);
execute(sql);
removes.add(logEvent);
} catch (SQLException e) {
errorHandler.error("Failed to excute sql",e,
ErrorCode.FLUSH_FAILURE);
}
}
// remove from the buffer any events that werereported
buffer.removeAll(removes);
// clear the buffer of reported events
removes.clear();
}
/** closes the appender before disposal */
public void finalize() {
close();
}
/**
* JDBCAppender requires a layout.
* */
public boolean requiresLayout() {
return true;
}
/**
*
*/
public void setSql(String s) {
sqlStatement = s;
if (getLayout() == null) {
this.setLayout(new PatternLayout(s));
} else {
((PatternLayout)getLayout()).setConversionPattern(s);
}
}
/**
* Returns pre-formated statement eg: insert intoLogTable (msg) values ("%m")
*/
public String getSql() {
return sqlStatement;
}
public void setSqlname(String sqlname){
sqlname=sqlname;
}
public String getSqlname(){
return sqlname;
}
public void setBufferSize(int newBufferSize) {
bufferSize = newBufferSize;
buffer.ensureCapacity(bufferSize);
removes.ensureCapacity(bufferSize);
}
public int getBufferSize() {
return bufferSize;
}
}
MyDB.java:
package common.sql;
import java.sql.*;
import com.codestudio.sql.*; //引入開源專案Poolman資料庫連線池的包
public class MyDB {
public static final String module =MyDB.class.getName();
private String dbName = "";
private PoolMan plmn = null;
public MyDB(String dbName) {
try {
if (plmn == null) {
plmn = (PoolMan)Class.forName("com.codestudio.sql.PoolMan").
newInstance();
}
} catch (Exception ec) {
System.out.println(ec.toString()+module);
}
this.dbName = dbName;
}
private Connection getNewConnection() {
Connection conn = null;
try {
conn = plmn.connect("jdbc:poolman://" +dbName);
conn.setAutoCommit(true);
} catch (Exception ec) {
System.out.println(ec.toString()+"First:Connectsqlsever failed"+module);
try {
Thread.sleep(1000);
conn = plmn.connect("jdbc:poolman://" +dbName);
conn.setAutoCommit(true);
} catch (Exception ecs) {
System.out.println(ecs.toString()+"Again:Connectsqlsever faile"+module);
}
}
return conn;
}
public Connection getConnection() {
return getNewConnection();
}
}
GeneralDb.java:
package common.sql;
package common.sql;
import java.util.*;
public class GeneralDb {
private static Hashtable dbPool;
public static MyDB getInstance(String dbname) {
if (dbPool == null) {
dbPool = new Hashtable();
}
MyDB db = (MyDB) dbPool.get(dbname);
if (db == null) {
db = new MyDB(dbname);
dbPool.put(dbname, db);
}
return db;
}
}
Log4j資料庫連線池的配置如下:
log4j.appender.JDBC=common.log.JDBCPoolAppender
log4j.appender.JDBC.sqlname=log
log4j.appender.JDBC.layout=org.apache.log4j.PatternLayout
log4j.appender.JDBC.sql=INSERT INTO LOGGING(log_date, log_level,
location, message) VALUES ('%d{ISO8601}', '%-5p', '%C,%L', '%m')
poolman.xml配置如下:
〈?xml version="1.0"encoding="UTF-8"?>
〈poolman>
〈management-mode>local〈/management-mode>
〈datasource>
〈dbname>log〈/dbname>
〈jndiName>log〈/jndiName>
〈driver>com.mysql.jdbc.Driver〈/driver>
〈url>jdbc:mysql://localhost:3306/test〈/url>
〈username>use〈/username>
〈password>password〈/password>
〈minimumSize>0〈/minimumSize>
〈maximumSize>10〈/maximumSize>
〈logFile>logs/mysql.log〈/logFile>
〈/datasource>
〈/poolman>
執行成功!對於JDBCPoolAppender的屬性(比如sqlname屬性)我們可以利用Log4j的反射機制隨便新增,只要在配置檔案給其附上值即可應用,而原來的父類裡面的一些屬性(username什麼的)和其get,set方法由於在連線池中不需要,所以刪除。而在JDBCPoolAppender類中,我也只是將getConnection 方法Override ,在這個方法中我們可以根據需要生成我們的Connection物件,另外兩個方法大家可以根據需求來決定怎樣Override。
Log4Net for .net framework
等待研究
下載log4net的原始碼。解壓軟體包後,在解壓的src目錄下將log4net.sln載入Visual Studio .NET,編譯後可以得到log4net.dll。使用者要在自己的程式里加入日誌功能,只需將log4net.dll引入工程即可。
轉載:http://blog.csdn.net/jojo52013145/article/details/6533991