首页   >   代码编程

log4j配置文件详解

Log4j已经发展到Log4j2了,而且现在公司也都喜欢使用logback,都已经好久没用它了,之前一直想写一篇关于Log4j的使用教程,迟迟没有动笔,这几天有点儿时间了,整理一下之前的笔记,来写几篇详细的使用教程。

使用它之前,需要清楚三个核心组件:Appender、Logger、Layout,接下来的所有配置都是围绕这几个组件展开的。

Appender:指定日志的输出源,可以是log文件、数据库、socket、邮件

常用的appender如下:

org.apache.log4j.ConsoleAppender(控制台)

org.apache.log4j.FileAppender(文件)

org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)

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

org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)

Logger:配置Appender和日志级别

总共分为五个级别:DEBUG、INFO、WARN、ERROR、FATAL,分别用来指定这条日志信息的重要程度,这五个级别是有顺序的,DEBUG < INFO < WARN < ERROR < FATAL,而且Log4j有一个规则:只输出级别不低于设定级别的日志信息,假设Loggers级别设定为INFO,则INFO、WARN、ERROR和FATAL级别的日志信息都会输出,而级别比INFO低的DEBUG则不会输出。

Layout:配置日志输出格式

log4j提供了四种日志输出样式,如:根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式。

常用的layout如下:

org.apache.log4j.HTMLLayout(以HTML表格形式布局)

org.apache.log4j.PatternLayout(可以灵活地指定布局模式 - 用得最多

org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)

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

核心参数弄明白之后,后面就简单了,不管多牛逼多高大上的日志配置,归根到底都是对这三个组件的配置,log4j支持xml和properties格式,log4j2开始不再支持properties文件了,改为支持xml和json格式。

配置参数详解

一、上面提到了logger的作用,它用来指定日志级别和输出源,配置语法如下所示:

log4j.xxx = [level], appenderName1, appenderName2, appenderName3, ...

二、与大多数框架一样,总会有一份默认的配置,在这里称之为“根logger”,在配置文件中表示为“log4j.rootLogger”,语法如下:

log4j.rootLogger = [level], appenderName1, appenderName2, appenderName3, ...

如果没有对一些包路径做特殊的日志配置,那么默认生效的就是这个rootLogger的配置,不管是level还是appender都会遵从rootLogger。

三、ConsoleAppender参数:

Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。

ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。

Target=System.err:默认值是System.out。

四、FileAppender参数:

Threshold=INFO:指定日志信息的最低输出级别,默认为DEBUG。

ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。

Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。

File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。

五、DailyRollingFileAppender参数:

Threshold=INFO:指定日志信息的最低输出级别,默认为DEBUG。

ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。

Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。

File=D:/logs/logging.log4j:指定当前消息输出到logging.log4j文件中。

DatePattern='.'yyyy-MM:每月滚动一次日志文件,即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j,前一个月的日志文件名为logging.log4j.yyyy-MM。

另外,也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:

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:指定日志信息的最低输出级别,默认为DEBUG。

ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。

Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。

File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。

MaxFileSize=100KB:后缀可以是KB, MB 或者GB。在日志文件到达该大小时,将会自动滚动,即将原来的内容移到logging.log4j.1文件中。

MaxBackupIndex=2:指定可以产生的滚动文件的最大数,例如,设为2则可以产生logging.log4j.1,logging.log4j.2两个滚动文件和一个logging.log4j文件。

七、格式化符号:

%p:输出日志信息的优先级,即DEBUG,INFO,WARN,ERROR,FATAL。

%d:输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。

%r:输出自应用程序启动到输出该log信息耗费的毫秒数。

%t:输出产生该日志事件的线程名。

%l:输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。例如:test.TestLog4j.main(TestLog4j.java:10)。

%c:输出日志信息所属的类目,通常就是所在类的全名。

%M:输出产生日志信息的方法名。

%F:输出日志消息产生时所在的文件名称。

%L::输出代码中的行号。

%m::输出代码中指定的具体日志信息。

%n:输出一个回车换行符,Windows平台为"rn",Unix平台为"n"。

%x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

%%:输出一个"%"字符。

文章看到这里,基本上对log4j一些常用的参数有了大概的了解,后续我会针对每一个Appender的特性单独写几篇文章来介绍,让大家对log4j有更深刻的了解和认识!

QQ群: 686430774  /  718410762

站长Q: 1347384268

如果文章有帮到你,可以考虑请博主喝杯咖啡!

分享到:

欢迎分享本文,转载请注明出处!

作者:不忘初心

发布时间:2019-05-09

永久地址:https://www.jiweichengzhu.com/article/3b1411709c2f487ba5de5ccf8d8a1af8

评论