Log4j配置详解

2019/08/21 14:54 分类：技术交流浏览：0

一引入

Log4j是用得比较多的日志框架，需要使用配置文件进行定制配置。但是很多网友不知道具体每句配置代表什么意思。所以写一篇文章来详细说明一下。

二配置详解

2.1 配置文件类型

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties文件，其中properties格式的配置文件最为常用，其有一个固定的文件名log4j.properties，接下来即介绍properties的配置方式，Log4j核心配置主要是配置“产生日志信息”，“将日志信息输出到指定位置”，“调整输出样式”,所以接下来主要讲解这三种配置方式

2.2 配置rootLogger

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

1）Level表示日志级别日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别，默认优先级：ALL < DEBUG < INFO <WARN < ERROR < FATAL < OFF,Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。一般项目开发时使用debug来打印调试日志，要上线时修改为error以防止日志过多而不好定位问题。

2)appenderName是日志信息输出位置，可以同时指定多个输出目的地

2.3 配置输出目的地Appender

格式如下：

log4j.appender.appenderName = Log4j提供的appender类

log4j.appender.appenderName.属性名 = 属性值

.....

log4j.appender.appenderName.属性名 = 属性值

Log4j提供的appender有以下5种，分别可以将日志信息输出到5个不同的平台。

org.apache.log4j.ConsoleAppender（控制台），项目上线前可以有

org.apache.log4j.FileAppender（文件）

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）

org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）基本不用

类型	常用细节配置
ConsoleAppender	Threshold=WARN：指定日志消息的输出最低层次。 ImmediateFlush=true：默认值是true,意谓着所有的消息都会被立即输出。 Target=System.err：默认情况下是：System.out,指定输出控制台
FileAppender	Threshold=WARN：指定日志消息的输出最低层次。 ImmediateFlush=true：默认值是true,意谓着所有的消息都会被立即输出。 File=mylog.txt：指定消息输出到mylog.txt文件。 Append=false：默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
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: 每分钟
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：指定可以产生的滚动文件的最大数

2.4 配置日志信息的格式（布局）

格式如下：

log4j.appender.appenderName.layout = Log4j提供的layout类

log4j.appender.appenderName.layout.属性 = 值

.....

log4j.appender.appenderName.layout.属性 = 值

Log4j提供的常见layout有以下几个：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），

org.apache.log4j.PatternLayout（可以灵活地指定布局模式），

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

类型	说明
PatternLayout	ConversionPattern=%m%n：指定怎样格式化指定的消息。
XMLLayout	LocationInfo=true：默认值是false,输出java文件和行号 Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：
日志信息格式中几个符号所代表的含义： -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 %c: 输出日志信息所属的类目，通常就是所在类的全名 %t: 输出产生该日志事件的线程名 %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及行数。举例：Testlog4.main(TestLog4.java:10) %%: 输出一个”%”字符 %F: 输出日志消息产生时所在的文件名称 %L: 输出代码中的行号 %m: 输出代码中指定的消息,产生的日志具体信息 %n: 输出一个回车换行符，Windows平台为”\r\n”，Unix平台为”\n”输出日志信息换行可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。

2.5 一个完整配置案例

log4j.rootLogger=INFO,consoleAppender,logfile,errorlogfile

log4j.addivity.org.apache=true

#文件输出：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

#是否显示类名和行数

l############################## 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 打印线程名

# 打印信息如下：

###############################################################################

#每天文件的输出：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 方式输出

三总结

一般来说一个log4j的配置应该包含根配置，输出路径，和格式处理

#标签：Log4j,日志框架