log4j.properties 配置详解

本文最后更新于 7 年前，文中信息可能已经过时。如有问题请在评论区留言。

Log4j简介

Log4j 有三个主要的组件：Loggers (记录器)，Appenders (输出源) 和 Layouts (布局)。这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松地记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。

在实际应用中，要使 Log4j 在系统中运行须事先设定配置文件。配置文件事实上也就是对 Logger、Appender 及 Layout 进行相应设定。Log4j 支持两种配置文件格式，一种是 XML 格式的文件，一种是 properties 属性文件。下面以 properties 属性文件为例介绍log4j.properties 的配置。

Loggers

Loggers 组件在此系统中被分为五个级别：DEBUG < INFO < WARN < ERROR < FATAL，分别用来指定这条日志信息的重要程度。

Log4j 只输出级别不低于设定级别的日志信息，假设 Loggers 级别设定为 INFO，则 INFO、WARN、ERROR 和 FATAL 级别的日志信息都会输出，而级别比 INFO 低的 DEBUG 则不会输出。

配置根 Logger：

properties

1
log4j.rootLogger=level,appenderName1,appenderName2,...

level：设定日志记录的最低级别，可设的值有 OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL 或者自定义的级别，Log4j 建议只使用中间四个级别（高亮部分）。通过在这里设定级别，可以控制应用程序中相应级别的日志信息的开关，比如在这里设定了INFO 级别，则应用程序中所有 DEBUG 级别的日志信息将不会被打印出来。
appenderName：就是指定日志信息要输出到哪里。可以同时指定多个输出目的地，用逗号隔开。

Appenders

禁用和使用日志请求只是 Log4j 的基本功能，Log4j 日志系统还提供许多强大的功能，比如允许把日志输出到不同的地方，如控制台（Console）、文件（Files）等，可以根据天数或者文件大小产生新的文件，可以以流的形式发送到其它地方等等。

配置方式：

properties

1
2
3
4
log4j.appender.appenderName=className
log4j.appender.appenderName.Option1=value1
…
log4j.appender.appenderName.OptionN=valueN

常使用的类（className）如下：

org.apache.log4j.ConsoleAppender（控制台）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

ConsoleAppender

Option	Description
Threshold=WARN	指定日志信息的最低输出级别，默认为 `DEBUG`
ImmediateFlush=true	表示所有消息都会被立即输出，设为 false 则不输出，默认值是 `true`
Target=System.err	默认值是 `System.out`

FileAppender

Option	Description
Threshold=WARN	指定日志信息的最低输出级别，默认为 `DEBUG`
ImmediateFlush=true	表示所有消息都会被立即输出，设为 false 则不输出，默认值是 `true`
Append=false	true 表示消息增加到指定文件中，false 则将消息覆盖指定的文件内容，默认值是 `true`
File=D:/applogs/log4j.log	指定消息输出到 D:/applogs/log4j.log 文件中

DailyRollingFileAppender

Option	Description
Threshold=WARN	指定日志信息的最低输出级别，默认为 `DEBUG`
ImmediateFlush=true	表示所有消息都会被立即输出，设为 false 则不输出，默认值是 `true`
Append=false	true 表示消息增加到指定文件中，false 则将消息覆盖指定的文件内容，默认值是 `true`
File=D:/applogs/log4j.log	指定消息输出到 D:/applogs/log4j.log 文件中
DatePattern=’.‘yyyy-MM	每月滚动一次日志文件，即每月产生一个新的日志文件。当前月的日志文件名为 log4j.log，前一个月的日志文件名为 log4j.log.yyyy-MM

DatePattern 还可以使用如下配置方式：

'.'yyyy-MM：每月
'.'yyyy-ww：每周
'.'yyyy-MM-dd：每天
'.'yyyy-MM-dd-a：每天两次
'.'yyyy-MM-dd-HH：每小时
'.'yyyy-MM-dd-HH-mm：每分钟

RollingFileAppender

Option	Description
Threshold=WARN	指定日志信息的最低输出级别，默认为 `DEBUG`
ImmediateFlush=true	表示所有消息都会被立即输出，设为 false 则不输出，默认值是 `true`
Append=false	true 表示消息增加到指定文件中，false 则将消息覆盖指定的文件内容，默认值是 `true`
File=D:/applogs/log4j.log	指定消息输出到 D:/applogs/log4j.log 文件中
MaxFileSize=100KB	后缀可以是KB, MB 或者 GB。在日志文件到达该大小时，将会自动滚动，即将原来的内容移到 log4j.log.1文件中
MaxBackupIndex=2	指定可以产生的滚动文件的最大数，例如，设为2则可以产生 log4j.log.1，log4j.log.2 两个滚动文件和一个 log4j.log 文件

Layouts

有时用户希望根据自己的喜好格式化自己的日志输出，Log4j 可以在 Appenders 的后面附加 Layouts 来完成这个功能。Layouts 提供四种日志输出样式，如根据 HTML 样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式。

配置方式：

properties

1
2
3
4
log4j.appender.appenderName.layout=className
log4j.appender.appenderName.layout.Option1 = value1
…
log4j.appender.appenderName.layout.OptionN = valueN

常使用的类（className）如下：

org.apache.log4j.HTMLLayout（以HTML表格形式布局）
org.apache.log4j.PatternLayout（可以灵活地指定布局模式）
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）

HTMLLayout

Option	Description
LocationInfo=true	输出 java 文件名称和行号，默认值是 `false`
Title=My Logging	默认值是 `Log4J Log Messages`

PatternLayout

Option	Description
ConversionPattern=%m%n	设定以怎样的格式显示消息

常用的格式化符号如下：

格式化符号	说明
`%p`	输出日志信息的优先级，即 DEBUG，INFO，WARN，ERROR，FATAL
`%d`	输出日志时间点的日期或时间，默认格式为 `ISO8601`，也可以在其后指定格式，如：`%d{yyyy/MM/dd HH:mm:ss,SSS}`
`%r`	输出自应用程序启动到输出该log信息耗费的毫秒数
`%t`	输出产生该日志事件的线程名
`%l`	输出日志事件的发生位置，相当于 `%c.%M(%F:%L)` 的组合，包括类全名、方法、文件名以及在代码中的行数。例如：demo.Log4jDemo.main(Log4jDemo.java:12)
`%c`	输出日志信息所属的类目，通常就是所在类的全名
`%M`	输出产生日志信息的方法名
`%F`	输出日志消息产生时所在的文件名称
`%L`	输出代码中的行号
`%m`	输出代码中指定的具体日志信息
`%n`	输出一个回车换行符，Windows平台为 `/r/n`，Unix平台为 `/n`
`%x`	输出和当前线程相关联的 NDC (嵌套诊断环境)，尤其用到像 java servlets 这样的多客户多线程的应用中
`%%`	输出一个 `%` 字符

此外，还可以在 % 与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式：

%20c：指定输出 category 的名称，最小的长度是 20，如果 category 的名称长度小于 20 的话，默认的情况下右对齐
%-20c：左对齐，最小长度是 20
%.30c：指定输出 category 的名称，最大的长度是 30，如果 category 的名称长度大于 30 的话，就会将左边多出的字符截掉，但小于 30 的话不会补空格

附录：配置参考

properties

log4j.properties

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
log4j.rootLogger=DEBUG,console,dailyFile,im
log4j.additivity.org.apache=true
# 控制台(console)
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.err
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 日志文件(logFile)
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
log4j.appender.logFile.ImmediateFlush=true
log4j.appender.logFile.Append=true
log4j.appender.logFile.File=D:/logs/log.log4j
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 回滚文件(rollingFile)
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.Threshold=DEBUG
log4j.appender.rollingFile.ImmediateFlush=true
log4j.appender.rollingFile.Append=true
log4j.appender.rollingFile.File=D:/logs/log.log4j
log4j.appender.rollingFile.MaxFileSize=200KB
log4j.appender.rollingFile.MaxBackupIndex=50
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 定期回滚日志文件(dailyFile)
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=DEBUG
log4j.appender.dailyFile.ImmediateFlush=true
log4j.appender.dailyFile.Append=true
log4j.appender.dailyFile.File=D:/logs/log.log4j
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %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 Factor 5
log4j.appender.socket.layout=org.apache.log4j.PatternLayout
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %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=FATAL
log4j.appender.mail.BufferSize=10
log4j.appender.mail.From = xxx@mail.com
log4j.appender.mail.SMTPHost=mail.com
log4j.appender.mail.Subject=Log4J Message
log4j.appender.mail.To= xxx@mail.com
log4j.appender.mail.layout=org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %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('=[%-5p] %d(%r) --> [%t] %l: %m %x %n')
log4j.appender.database.layout=org.apache.log4j.PatternLayout
log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

Log4j简介#

Loggers#

Appenders#

ConsoleAppender#

FileAppender#

DailyRollingFileAppender#

RollingFileAppender#

Layouts#

HTMLLayout#

PatternLayout#

附录：配置参考#

Log4j简介

Loggers

Appenders

ConsoleAppender

FileAppender

DailyRollingFileAppender

RollingFileAppender

Layouts

HTMLLayout

PatternLayout

附录：配置参考