log4j.properties配置文件详解

我就是我 2022-08-06 15:17 144阅读 0赞

项目中的classes 中新建立一个log4j.properties文件即可；

在实际编程时，要使Log4j真正在系统中运行事先还要对配置文件进行定义。定义步骤就是对Logger、Appender及Layout的分别使用。Log4j支持两种配置文件格式，一种是XML格式的文件，一种是java properties（key=value）【Java特性文件（键=值）】。（这里只说明properties文件）

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:指定可以产生的滚动文件的最大数。

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文件和行号  
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平台为"  
"，Unix平台为"  
"输出日志信息换行  
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：  
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.rootLogger=INFO,consoleAppender,logfile,MAIL  
log4j.addivity.org.apache=true

\#ConsoleAppender，控制台输出  
\#FileAppender，文件日志输出  
\#SMTPAppender，发邮件输出日志  
\#SocketAppender，Socket日志  
\#NTEventLogAppender，Window NT日志  
\#SyslogAppender，  
\#JMSAppender，  
\#AsyncAppender，  
\#NullAppender

\#文件输出：RollingFileAppender  
\#log4j.rootLogger = INFO,logfile  
log4j.appender.logfile = org.apache.log4j.RollingFileAppender  
log4j.appender.logfile.Threshold = INFO  
\# 输出以上的INFO信息  
log4j.appender.logfile.File = INFO\_log.html  
\#保存log文件路径  
log4j.appender.logfile.Append = true  
\# 默认为true，添加到末尾，false在每次启动时进行覆盖  
log4j.appender.logfile.MaxFileSize = 1MB  
\# 一个log文件的大小，超过这个大小就又会生成1个日志 \# KB ，MB，GB  
log4j.appender.logfile.MaxBackupIndex = 3  
\# 最多保存3个文件备份  
log4j.appender.logfile.layout = org.apache.log4j.HTMLLayout  
\# 输出文件的格式  
log4j.appender.logfile.layout.LocationInfo = true  
\#是否显示类名和行数  
log4j.appender.logfile.layout.Title =title:/u63d0/u9192/u60a8/uff1a/u7cfb/u7edf/u53d1/u751f/u4e86/u4e25/u91cd/u9519/u8bef  
\#html页面的 < title >  
\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\# SampleLayout \#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#  
\# log4j.appender.logfile.layout = org.apache.log4j.SampleLayout  
\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\# PatternLayout \#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#  
\# log4j.appender.logfile.layout = org.apache.log4j.PatternLayout  
\# log4j.appender.logfile.layout.ConversionPattern =% d % p \[ % c\] - % m % n % d  
\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\# XMLLayout \#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#  
\# log4j.appender.logfile.layout = org.apache.log4j.XMLLayout  
\# log4j.appender.logfile.layout.LocationInfo = true \#是否显示类名和行数  
\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\# TTCCLayout \#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#  
\# log4j.appender.logfile.layout = org.apache.log4j.TTCCLayout  
\# log4j.appender.logfile.layout.DateFormat = ISO8601  
\#NULL, RELATIVE, ABSOLUTE, DATE or ISO8601.  
\# log4j.appender.logfile.layout.TimeZoneID = GMT - 8 : 00  
\# log4j.appender.logfile.layout.CategoryPrefixing = false \#\#默认为true 打印类别名  
\# log4j.appender.logfile.layout.ContextPrinting = false \#\#默认为true 打印上下文信息  
\# log4j.appender.logfile.layout.ThreadPrinting = false \#\#默认为true 打印线程名  
\# 打印信息如下：  
\#2007 - 09 - 13 14 : 45 : 39 , 765 \[http - 8080 - 1 \] ERROR com.poxool.test.test - error成功关闭链接  
\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#  
\#每天文件的输出：DailyRollingFileAppender  
\#log4j.rootLogger = INFO,errorlogfile  
log4j.appender.errorlogfile = org.apache.log4j.DailyRollingFileAppender  
log4j.appender.errorlogfile.Threshold = ERROR  
log4j.appender.errorlogfile.File = ../logs/ERROR\_log  
log4j.appender.errorlogfile.Append = true  
\#默认为true，添加到末尾，false在每次启动时进行覆盖  
log4j.appender.errorlogfile.ImmediateFlush = true  
\#直接输出，不进行缓存  
\# ' . ' yyyy - MM: 每个月更新一个log日志  
\# ' . ' yyyy - ww: 每个星期更新一个log日志  
\# ' . ' yyyy - MM - dd: 每天更新一个log日志  
\# ' . ' yyyy - MM - dd - a: 每天的午夜和正午更新一个log日志  
\# ' . ' yyyy - MM - dd - HH: 每小时更新一个log日志  
\# ' . ' yyyy - MM - dd - HH - mm: 每分钟更新一个log日志  
log4j.appender.errorlogfile.DatePattern = ' . ' yyyy - MM - dd ' .log '  
\#文件名称的格式  
log4j.appender.errorlogfile.layout = org.apache.log4j.PatternLayout  
log4j.appender.errorlogfile.layout.ConversionPattern =%d %p \[ %c\] - %m %n %d

\#控制台输出：  
\#log4j.rootLogger = INFO,consoleAppender  
log4j.appender.consoleAppender = org.apache.log4j.ConsoleAppender  
log4j.appender.consoleAppender.Threshold = ERROR  
log4j.appender.consoleAppender.layout = org.apache.log4j.PatternLayout  
log4j.appender.consoleAppender.layout.ConversionPattern =%d %-5p %m %n  
log4j.appender.consoleAppender.ImmediateFlush = true

\# 直接输出，不进行缓存  
log4j.appender.consoleAppender.Target = System.err  
\# 默认是System.out方式输出

\#发送邮件：SMTPAppender  
\#log4j.rootLogger = INFO,MAIL  
log4j.appender.MAIL = org.apache.log4j.net.SMTPAppender  
log4j.appender.MAIL.Threshold = INFO  
log4j.appender.MAIL.BufferSize = 10  
log4j.appender.MAIL.From = [yourmail@gmail.com][yourmail_gmail.com]  
log4j.appender.MAIL.SMTPHost = smtp.gmail.com  
log4j.appender.MAIL.Subject = Log4J Message  
log4j.appender.MAIL.To = [yourmail@gmail.com][yourmail_gmail.com]  
log4j.appender.MAIL.layout = org.apache.log4j.PatternLayout  
log4j.appender.MAIL.layout.ConversionPattern =%d - %c -%-4r \[%t\] %-5p %c %x - %m %n

\#数据库：JDBCAppender  
log4j.appender.DATABASE = org.apache.log4j.jdbc.JDBCAppender  
log4j.appender.DATABASE.URL = jdbc:oracle:thin:@ 210.51 . 173.94 : 1521 :YDB  
log4j.appender.DATABASE.driver = oracle.jdbc.driver.OracleDriver  
log4j.appender.DATABASE.user = ydbuser  
log4j.appender.DATABASE.password = ydbuser  
log4j.appender.DATABASE.sql = INSERT INTO A1 (TITLE3) VALUES ( ' %d - %c %-5p %c %x - %m%n ' )  
log4j.appender.DATABASE.layout = org.apache.log4j.PatternLayout  
log4j.appender.DATABASE.layout.ConversionPattern =% d - % c -%- 4r \[ % t\] %- 5p % c % x - % m % n  
\#数据库的链接会有问题，可以重写org.apache.log4j.jdbc.JDBCAppender的getConnection() 使用数据库链接池去得链接，可以避免insert一条就链接一次数据库

指定包的日志级别：

log4j.logger.com. neusoft =DEBUG

指定com.neusoft包下的所有类的等级为DEBUG。

可以把com.neusoft改为自己项目所用的包名。

log4j.logger.com.opensymphony.oscache=ERROR

log4j.logger.net.sf.navigator=ERROR

这两句是把这两个包下出现的错误的等级设为ERROR，如果项目中没有配置EHCache，则不需要这两句。

log4j.logger.org.apache.commons=ERROR

log4j.logger.org.apache.struts=WARN

这两句是struts的包。

log4j.logger.org.displaytag=ERROR

这句是displaytag的包。（QC问题列表页面所用）

log4j.logger.org.springframework=DEBUG

此句为Spring的包。

log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN

log4j.logger.org.hibernate=DEBUG

此两句是hibernate的包。

以上这些包的设置可根据项目的实际情况而自行定制。

log4j.additivity是 子Logger 是否继承 父Logger 的 输出源（appender） 的标志位。具体说，默认情况下 子Logger 会继承 父Logger 的appender，也就是说 子Logger 会在 父Logger 的appender里输出。若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。  
如：  
log4j.rootLogger=INFO, stdout,logfile  
log4j.logger.com.ambow.upgrade=INFO, dataSync  
则com.ambow.upgrade包及其子包下的Logger不光在Appender dataSync里输出，也会在rootLogger的Appender stuout和logfile中输出；  
若想让com.ambow.upgrade包及其子包下的Logger只在Appender dataSync中输出，则在log4j.properties中添加下行即可：  
log4j.additivity.com.ambow.upgrade=false

[yourmail_gmail.com]: mailto:yourmail@gmail.com