欢迎访问我的博客:https://javacfox.github.io
一、Log4j的简介
Log4j有三个主要的组件:Loggers(记录器),Appenders (输出源)和Layouts(布局)。这里可简单理解为日志级别,日志要输出位置和日志输出形式。综合运用这三个组件可以轻松地记录信息的类型和级别,并可以在运行时控制日志输出的样式和位置。Log4j支持两种配置文件格式,一种是XML格式的文件,一种是properties属性文件。下面以xml文件为例介绍log4j.xml的配置。
二、组件介绍
1、Loggers
Loggers中有5级logger ,FATAL 0 ,ERROR 3 ,WARN 4 ,INFO 6 ,DEBUG 7,级别是有顺序的,DEBUG < INFO < WARN < ERROR < FATAL,分别用来指定这条日志信息的重要程度,Log4j有一个规则:只输出级别不低于设定级别的日志信息,WARN,则只会输出WARN、ERROR和FATAL级别的日志信息,而级别比INFOwarn低的INFO和DEBUG则不会输出。
<!-- Spring -->
<logger name="org.springframework" additivity="false">
<level value="ERROR"/>
<appender-ref ref="fileAppender" />
</logger>
<logger name="com.mchange.v2" additivity="false">
<level value="ERROR" />
<appender-ref ref="fileAppender" />
</logger>
- additivity=“false” : 表示Logger不会在父Logger的appender里输出,默认为true
- level :设定日志记录的最低级别,可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别,Log4j建议只使用中间四个级别
- appenderName:就是指定日志信息要输出到哪里,可以有一个或多个appenderName。
2、Appenders
禁用和使用日志请求只是Log4j的基本功能,Log4j日志系统还提供许多强大的功能,比如允许把日志输出到不同的地方,如控制台(Console)、文件(Files)等,可以根据天数或者文件大小产生新的文件,可以以流的形式发送到其它地方等等。
常使用的类如下:
- org.apache.log4j.ConsoleAppender(控制台)
- org.apache.log4j.FileAppender(文件)
- org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
- org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
- org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
<!--输出到文件-->
<appender name="fileAppender" class="org.apache.log4j.DailyRollingFileAppender">
<param name="File" value="D:/abc/logs/NS.log" />
<param name="DatePattern" value="yyyy-MM-dd" />
<param name="Append" value="true" />
<param name="Threshold" value="DEBUG" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyy-MM-dd HH:mm:ss,SSS} %r [%t] %p %c %x - %m%n" />
</layout>
</appender>
- appender ==> name:别名,方便引用
- appender ==> class:配置日志信息输出目的地
- org.apache.log4j.ConsoleAppender(控制台)
- org.apache.log4j.FileAppender(文件)
- org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
- org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
- org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
- param ==> name:相关配置属性
- 一、ConsoleAppender选项
- 1)、Threshold:指定日志信息的最低输出级别,默认为DEBUG
- 2)、ImmediateFlush:表示所有消息都会被立即输出,设为false则不输出,默认值是true
- 3)、Target:默认值是System.out
- 二、FileAppender选项
- 1)、Threshold:指定日志信息的最低输出级别,默认为DEBUG
- 2)、ImmediateFlush:表示所有消息都会被立即输出,设为false则不输出,默认值是true
- 3)、Append:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true(控制台输出没有这个属性)
- 4)、File:指定消息输出到logging.log4j文件中
- 三、DailyRollingFileAppender选项
- 1)、Threshold:指定日志信息的最低输出级别,默认为DEBUG。
- 2)、ImmediateFlush:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
- 3)、Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
- 4)、File:指定当前消息输出到logging.log4j文件中。
- 5)、DatePattern:设置多久滚动一次日志文件。若当前月的日志文件名为logging.log4j,前一个月的日志文件名为logging.log4j.yyyy-MM。
- 另外补充一下,DatePattern也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:
- 5.1)’.'yyyy-MM:每月
- 5.2)’.'yyyy-ww:每周
- 5.3)’.'yyyy-MM-dd:每天
- 5.4)’.'yyyy-MM-dd-a:每天两次
- 5.5)’.'yyyy-MM-dd-HH:每小时
- 5.6)’.'yyyy-MM-dd-HH-mm:每分钟
- 四、RollingFileAppender选项
- 1)、Threshold:指定日志信息的最低输出级别,默认为DEBUG。
- 2)、ImmediateFlush:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
- 3)、Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
- 4)、File:指定当前消息输出到logging.log4j文件中。
- 5)、MaxFileSize:后缀可以是KB, MB 或者GB。在日志文件到达该大小时,将会自动滚动,即将原来的内容移到logging.log4j.1文件中。
- 6)、指定可以产生的滚动文件的最大数,例如,设为2则可以产生logging.log4j.1,logging.log4j.2两个滚动文件和一个logging.log4j文件
- 一、ConsoleAppender选项
3、Layouts
用户可以自定义日志输出格式,Log4j可以在Appenders的后面附加Layouts来完成这个功能,上面有用到。Layouts提供四种日志输出样式,如根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式。
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyy-MM-dd HH:mm:ss,SSS} %r [%t] %p %c %x - %m%n" />
</layout>
-
layout ==> class:配置日志信息的输出格式
- (1)org.apache.log4j.HTMLLayout(以HTML表格形式布局)
- param ==> name:输出参数属性
- 1.1、LocationInfo:输出java文件名称和行号,默认值是false
- 1.2、Title:默认值是Log4J Log Messages
- (2)org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
- ConversionPattern:设定以怎样的格式显示消息
- (3)org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
- (4)org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
- (1)org.apache.log4j.HTMLLayout(以HTML表格形式布局)
-
补充ConversionPattern的格式化符号说明
- %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这样的多客户多线程的应用中。
- %%:输出一个"%"字符。
- 另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如:
-
- c:指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。
-
- 2)%-20c:"-"号表示左对齐。
- 3)%.30c:指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。
完整版的xml配置文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<!--#log4j中有5级logger ,#FATAL 0 ,#ERROR 3 ,#WARN 4 ,#INFO 6 ,#DEBUG 7 -->
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>
<!--输出到控制台-->
<appender name="consoleAppender" class="org.apache.log4j.ConsoleAppender">
<
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyy-MM-dd HH:mm:ss,SSS} %r [%t] %p %c %x - %m%n" />
</layout>
</appender>
<!--输出到文件-->
<appender name="fileAppender" class="org.apache.log4j.DailyRollingFileAppender">
<param name="File" value="D:/abc/logs/NS.log" />
<param name="DatePattern" value="yyyy-MM-dd" />
<param name="Append" value="true" />
<param name="Threshold" value="DEBUG" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyy-MM-dd HH:mm:ss,SSS} %r [%t] %p %c %x - %m%n" />
</layout>
</appender>
<!--输出到文件-->
<appender name="rollFileAppender" class="org.apache.log4j.RollingFileAppender">
<param name="File" value="D:/abc/logs/ra.log" />
<param name="MaxFileSize" value="5120KB" />
<param name="MaxBackupIndex" value="10" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyy-MM-dd HH:mm:ss,SSS} %r [%t] %p %c %x - %m%n" />
</layout>
</appender>
<!-- 3rdparty Loggers -->
<!-- Mybatis and SQL -->
<logger name="org.apache.ibatis" additivity="false">
<level value="DEBUG"/>
<appender-ref ref="fileAppender" />
</logger>
<!-- shiro -->
<logger name="org.apache.shiro" additivity="false">
<level value="ERROR"/>
<appender-ref ref="fileAppender" />
</logger>
<logger name="net.sf.ehcache" additivity="false">
<level value="ERROR"/>
<appender-ref ref="fileAppender" />
</logger>
<!-- -->
<logger name="org.apache.commons" additivity="false">
<level value="ERROR"/>
<appender-ref ref="fileAppender" />
</logger>
<logger name="org.mybatis.spring" additivity="false">
<level value="ERROR"/>
<appender-ref ref="fileAppender" />
</logger>
<logger name="java.sql" additivity="false">
<level value="ERROR"/>
<appender-ref ref="fileAppender" />
</logger>
<!-- Spring -->
<logger name="org.springframework" additivity="false">
<level value="ERROR"/>
<appender-ref ref="fileAppender" />
</logger>
<logger name="com.mchange.v2" additivity="false">
<level value="ERROR" />
<appender-ref ref="fileAppender" />
</logger>
<!-- ActiveMQ -->
<logger name="org.apache.activemq" additivity="false">
<level value="ERROR"/>
<appender-ref ref="fileAppender" />
</logger>
<!-- WEBSERVICE -->
<logger name="org.springframework.ws.server.MessageTracing." additivity="false">
<level value="TRACE"/>
<appender-ref ref="fileAppender" />
</logger>
<logger name="com.infosec.mapper" additivity="false">
<level value="ERROR"/>
<appender-ref ref="fileAppender" />
</logger>
<root>
<priority value="info"/>
<appender-ref ref="fileAppender" />
<appender-ref ref="consoleAppender" />
</root>
</log4j:configuration>
Log4j也支持log4j.properties
其基本的属性配置同上
Log4j配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。
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
# 自定义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=[%-5p] %d(%r) --> [%t] %l: %m %x %n