一、前言:
Java 的開(kāi)源項(xiàng)目太多太多了。這種遍地開(kāi)花的局面絕對(duì)趕得上中國(guó)五代十國(guó)時(shí)期的“百家爭(zhēng)鳴”、“百花爭(zhēng)艷”的繁榮。使用 java 技術(shù),我們的項(xiàng)目幾乎不需要購(gòu)買有關(guān) java 支撐開(kāi)發(fā)產(chǎn)品,只需把一個(gè)一個(gè)開(kāi)源產(chǎn)品經(jīng)過(guò)架構(gòu)師的手,合理搭配和拼接,就能做出靈活性佳、性能不錯(cuò)的商業(yè)產(chǎn)品來(lái)。
無(wú)疑, 作為一個(gè)流行的日志記錄工具, Log4j 是 java 開(kāi)源項(xiàng)目中最閃亮的環(huán)節(jié)之一。筆者所見(jiàn)的 java 項(xiàng)目,十九都采用了 Log4j ,究其原因,我認(rèn)為有以下幾點(diǎn):
a ) Log4j 受大多數(shù) web 應(yīng)用服務(wù)器的擁護(hù):以我目前所知, tomcat , weblogic , websphere , jboss 都支持 log4j 。
b )快速,功能強(qiáng)大: Log4J 配置文件實(shí)現(xiàn)了輸出到控制臺(tái)、文件、回滾文件、發(fā)送日志郵件、輸出到數(shù)據(jù)庫(kù)日志表、自定義標(biāo)簽等全套功能。在速度上,從 log4j 一開(kāi)始出現(xiàn),注重運(yùn)行的速度就一直放在首位,并且堅(jiān)持不懈地進(jìn)行著改進(jìn)和完善。
c )使用簡(jiǎn)單、方便:只需要導(dǎo)入一個(gè)簡(jiǎn)單的 log4j-1.2.x.jar ,然后在程序類的開(kāi)頭寫(xiě)上下面一句 private final static Logger log =Logger.getLogger(ClassName.class);
這樣你就得到了一個(gè)日志對(duì)象 log ,可以輕松往特定目標(biāo)寫(xiě)日志了。
二、為什么需要 Log4j ? ---項(xiàng)目的調(diào)試是 log4j 產(chǎn)生的內(nèi)在驅(qū)動(dòng)力
原始的方法是:把信息輸出到屏幕(
console
),利用
JDK
提供的
System.out.println
。但是,這樣做的壞處是顯而易見(jiàn)的:
a
)信息的輸出不夠靈活,并且繁瑣。比如,要輸出執(zhí)行處的文件名,行數(shù),當(dāng)前時(shí)間等,
println
顯得很原始。
b
)如果要改變輸出的內(nèi)容和格式,需要重新編譯源程序。
c
)更嚴(yán)重的是,如果程序中有很多的
println
,會(huì)嚴(yán)重的影響程序的性能。
三、 Log4j 使用的幾個(gè)關(guān)鍵點(diǎn)?
??根記錄器( Logger ),輸出端( appenders )和布局( layouts )
a )定義根記錄器的格式為
log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN
。同一個(gè)記錄器可有多個(gè)輸出端。
PS : level 的級(jí)別(此級(jí)別可以自定義,系統(tǒng)默認(rèn)提供了以下級(jí)別)
◆
debug//
調(diào)試信息
◆
info//
一般信息
◆
warn//
警告信息
◆
error//
錯(cuò)誤信息
◆
fatal//
致命錯(cuò)誤信息
上面列出的就是所謂log4j的輸出級(jí)別,log4j建議只使用4個(gè)級(jí)別,它們從上到下分別為ERROR、WARN、INFO、DEBUG,假設(shè)你定義的級(jí)別是info,那么error和warn的日志可以顯示而比他低的debug信息就不顯示了。
b )定義一個(gè) appender 的輸出目的地的格式為
log4j.appender.appenderName = fully.qualified.name.of.appender.class
。
log4j
提供了以下幾種常用的輸出目的地:
◆
org.apache.log4j.ConsoleAppender
,將日志信息輸出到控制臺(tái)
◆
org.apache.log4j.FileAppender
,將日志信息輸出到一個(gè)文件
◆
org.apache.log4j.DailyRollingFileAppender
,將日志信息輸出到一個(gè),并且每天輸出到一個(gè)新的日志文件
◆
org.apache.log4j.RollingFileAppender
,將日志信息輸出到一個(gè)文件,通過(guò)指定文件的的尺寸,當(dāng)文件大小到達(dá)指定尺寸的時(shí)候會(huì)自動(dòng)把文件改名,如名為
example.log
的文件會(huì)改名為
example.log.1
,同時(shí)產(chǎn)生一個(gè)新的
example.log
文件。如果新的文件再次達(dá)到指定尺寸,又會(huì)自動(dòng)把文件改名為
example.log.2
,同時(shí)產(chǎn)生一個(gè)
example.log
文件。依此類推,直到
example.log. MaxBackupIndex
,
MaxBackupIndex
的值可在配置文件中定義。
◆
org.apache.log4j.WriterAppender
,將日志信息以流格式發(fā)送到任意指定的地方。
◆
org.apache.log4j.jdbc.JDBCAppender
,通過(guò)
JDBC
把日志信息輸出到數(shù)據(jù)庫(kù)中。
c )輸出格式(布局) layout
Log4j
提供了一下幾種布局:
◆
org.apache.log4j.HTMLLayout
,以
HTML
表格形式布局
◆
org.apache.log4j.PatternLayout
,可以靈活地指定布局模式
◆
org.apache.log4j.SimpleLayout
,包含日志信息的級(jí)別和信息字符串
定義一個(gè)
PatternLayout
布局的語(yǔ)句為:
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1} - %m%n
PS
:
ConversionPattern
參數(shù)的格式含義
格式名
含義
%c
輸出日志信息所屬的類的全名
%d
輸出日志時(shí)間點(diǎn)的日期或時(shí)間,默認(rèn)格式為
ISO8601
,也可以在其后指定格式,比如:
%d{yyy-MM-dd HH:mm:ss }
,輸出類似:
%f
輸出日志信息所屬的類的類名
%l
輸出日志事件的發(fā)生位置,即輸出日志信息的語(yǔ)句處于它所在的類的第幾行
%m
輸出代碼中指定的信息,如
log(message)
中的
message
%n
輸出一個(gè)回車換行符,
Windows
平臺(tái)為
“\r\n”
,
Unix
平臺(tái)為
“\n”
%p
輸出優(yōu)先級(jí),即
DEBUG
,
INFO
,
WARN
,
ERROR
,
FATAL
。如果是調(diào)用
debug()
輸出的,則為
DEBUG
,依此類推
%r
輸出自應(yīng)用啟動(dòng)到輸出該日志信息所耗費(fèi)的毫秒數(shù)
%t
輸出產(chǎn)生該日志事件的線程名
四、
log4j
的配置文件
??
log4j.properties
或者
log4j.xml
a )有幾種方式可以配置 Log4J
◆
在程序中調(diào)用
BasicConfigurator.configure()
方法;
◆
配置放在文件里,通過(guò)命令行參數(shù)傳遞文件名字,通過(guò)
PropertyConfigurator.configure(args[x])
解析并配置;
◆
配置放在文件里,通過(guò)環(huán)境變量傳遞文件名等信息,利用
log4j
默認(rèn)的初始化過(guò)程解析并配置;
◆
配置放在文件里,通過(guò)應(yīng)用服務(wù)器配置傳遞文件名等信息,利用一個(gè)特殊的
servlet
來(lái)完成配置。
b )配置文件的初始化:
通過(guò)應(yīng)用服務(wù)器完成初始化
通過(guò) servlet 輔助完成初始化
c )一個(gè) log4j.properties 文件示例
log4j.rootLogger=INFO, stdout, logfile
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - <%m>%n
log4j.appender.logfile=org.apache.log4j.RollingFileAppender
log4j.appender.logfile.File=/webserver/specialTraining3/wangzj.log
log4j.appender.logfile.MaxFileSize=51200KB
log4j.appender.logfile.MaxBackupIndex=3
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - <%m>%n
五、用 log4j 來(lái)演練一個(gè)例子
Web.xml
文件:
version=
"1.0"
encoding=
"ISO-8859-1"
?>
web-app
PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/j2ee/dtds/web-app_2_3.dtd"
>
Log4j.properties
文件:
log4j.rootLogger=
DEBUG,
ROOT
log4j.appender.ROOT=
org.apache.log4j.RollingFileAppender
log4j.appender.ROOT.File=
E
:
\wangzj\myapplication.log
log4j.appender.ROOT.MaxFileSize=
1000KB
log4j.appender.ROOT.MaxBackupIndex=
5
log4j.appender.ROOT.layout=
org.apache.log4j.PatternLayout
log4j.appender.ROOT.layout.ConversionPattern=
[%d]
%t
%c
%-5p
-
%m%n
ootLogger=DEBUG,CONSOLE,A1,im
log4j.addivity.org.apach
MyModel.java
文件:
package com.webage.model;
import org.apache.log4j.Logger;
public class MyModel {
static Logger logger = Logger.getLogger(MyModel.class);;
public void checkValid(String name, String value) throws Exception {
logger.debug("ENTRY");
logger.debug(" 檢查參數(shù) : " + name);
if (value == null) {
throw new Exception(" 缺少參數(shù)。 ");
}
if (value.trim().length() == 0) {
throw new Exception(" 參數(shù)空。 ");
}
logger.debug("EXIT");
}
}
MyServlet.java
package com.webage.servlets;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.log4j.Logger;
import com.webage.model.MyModel;
public class MyServlet extends HttpServlet {
Logger logger = Logger.getLogger(MyServlet.class);
public void doGet(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
logger.debug("ENTRY");
MyModel model = new MyModel();
resp.getWriter().println("
Log4J測(cè)試
");try {
model.checkValid("firstName", req.getParameter("firstName"));
} catch (Exception e) {
logger.error("doGet出現(xiàn)錯(cuò)誤.", e);
}
logger.debug("EXIT");
}
public void init() throws ServletException {
super.init();
logger.info("Servlet初始化...");
}
}
需要兩個(gè)jar包:servlet.jar和log4j-
準(zhǔn)備就緒,運(yùn)行之于tomcat或者weblogic,筆者暫用weblogic代之。每當(dāng)運(yùn)行Logger logger = Logger.getLogger(MyServlet.class);時(shí)即生成E:\wangzj\myapplication.log文件。
Happy~~~~!
六、其它一點(diǎn)實(shí)用性資料??網(wǎng)上摘抄而來(lái),具體哪里忘了
log4j.rootLogger=DEBUG,CONSOLE,A1,im
log4j.addivity.org.apache=true
# 應(yīng)用于控制臺(tái)
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
#應(yīng)用于文件
log4j.appender.FILE=org.apache.log4j.FileAppender
log4j.appender.FILE.File=file.log //相對(duì)路徑和絕對(duì)路徑
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
# 應(yīng)用于文件回滾
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
#應(yīng)用于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
# 發(fā)送日志給郵件
log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender
log4j.appender.MAIL.Threshold=FATAL
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
# 用于數(shù)據(jù)庫(kù)
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