(二) Log4j 配置详解

2023-06-13,,

第一节: rootLogger 根配置

Log4j 根配置语法

 log4j.rootLogger = [ level ] , appenderName, appenderName, …

指代 把指定级别的日志信息输出到指定的一个或者多个位置

其中,level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。 (具体详情见第二节log4j日志等级)

我们依然沿用前面的实例,

这里我们把INFO层级以及以上的信息输出到Console和File;

第二节: log4j 日志等级

Log4j根据日志信息的重要程度,分OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL

当然再细分的话 还有 FATAL(严重错误),

如果配置OFF则不打出任何信息;如果配置为INFO这样只显示INFO、WARN、ERROR的log信息,而DEBUG信息不会被显示;如果配置为ALL则打印所有的日志。

但是Log4j官方建议实际实用的话,Log4j建议只使用四个级别,优先级从高到低分别是 ERROR、WARN、INFO、DEBUG

假如rootLogger定义的是DEBUG 那所有的报错信息都会输出;

我们沿用前面HelloWorld实例

假如定义的是INFO 那么DEBUG信息是不会输出的,其他信息输出;

假如定义最高等级ERROR,那么只有ERROR信息会输出,其他低等级信息是不会输出的;

第三节: log4j appender 输出类型配置

Log4j官方的appender给出了一下几种实现

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

org.apache.log4j.FileAppender(文件),

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

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

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

实际开发我们使用第1,第3和第4种实现;

假如日志数据量不是很大,我们可以用DailyRollingFileAppender 每天产生一个日志,方便查看;

假如日志数据量很大,我们一般用RollingFileAppender,固定尺寸的日志,假如超过了 就产生一个新的文件;

我们这里给出一些实例;

 log4j.rootLogger=DEBUG, Console ,File ,DailyRollingFile ,RollingFile

 #Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n #File
log4j.appender.File = org.apache.log4j.FileAppender
log4j.appender.File.File = D://log2.log
log4j.appender.File.layout = org.apache.log4j.PatternLayout
log4j.appender.File.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n #DailyRollingFile
log4j.appender.DailyRollingFile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.DailyRollingFile.File = D://log3.log
log4j.appender.DailyRollingFile.layout = org.apache.log4j.PatternLayout
log4j.appender.DailyRollingFile.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n #RollingFile
log4j.appender.RollingFile = org.apache.log4j.RollingFileAppender
log4j.appender.RollingFile.File = D://log4.log
log4j.appender.RollingFile.MaxFileSize=1KB
log4j.appender.RollingFile.MaxBackupIndex=3
log4j.appender.RollingFile.layout = org.apache.log4j.PatternLayout
log4j.appender.RollingFile.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n

测试代码:

 package com.wishwzp.log4j;

 import org.apache.log4j.Logger;

 /**
* Log4j测试类
* @author ainio
*
*/
public class Test { private static final Logger logger = Logger.getLogger(Test.class); // 获取logger实例 public static void main(String[] args) { logger.info("普通Info信息");
logger.debug("调试debug信息");
logger.error("报错error信息");
logger.warn("警告warn信息");
logger.fatal("严重错误fatal信息"); logger.error("报错信息", new IllegalArgumentException("非法参数")); int i=0;
while(i<10){
logger.info("普通Info信息");
logger.debug("调试debug信息");
logger.error("报错error信息");
logger.warn("警告warn信息");
logger.fatal("严重错误fatal信息"); logger.error("报错信息", new IllegalArgumentException("非法参数"));
i++;
}
} }

这里有两个新的配置项解释下:

MaxFileSize 是日志文件的最大尺寸;根据实际需求来定 10KB 100KB也行

MaxBackupIndex是日志文件的个数,假如超过了,则覆盖,主要考虑到的是硬盘的容量问题;根据实际需求来定 比如 100  500;

这里给下日志文件的效果:

整体效果:

DailyRollingFileAppender  效果:

RollingFileAppender 效果:

第四节: log4j layout 日志信息格式

Log4j提供的layout有以下几种

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

org.apache.log4j.PatternLayout(可以灵活地指定布局模式),

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

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

HTMLLayout实例,我们把前面的实例的配置文件改下

 #Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.HTMLLayout

我们运行 看下输出信息:

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Log4J Log Messages</title>
<style type="text/css">
<!--
body, table {font-family: arial,sans-serif; font-size: x-small;}
th {background: #336699; color: #FFFFFF; text-align: left;}
-->
</style>
</head>
<body bgcolor="#FFFFFF" topmargin="6" leftmargin="6">
<hr size="1" noshade>
Log session start time Wed Mar 29 10:17:41 CST 2017<br>
<br>
<table cellspacing="0" cellpadding="4" border="1" bordercolor="#224466" width="100%">
<tr>
<th>Time</th>
<th>Thread</th>
<th>Level</th>
<th>Category</th>
<th>Message</th>
</tr> <tr>
<td>0</td>
<td title="main thread">main</td>
<td title="Level">INFO</td>
<td title="com.wishwzp.Test category">com.open1111.Test</td>
<td title="Message">普通Info信息</td>
</tr> <tr>
<td>16</td>
<td title="main thread">main</td>
<td title="Level"><font color="#339933">DEBUG</font></td>
<td title="com.wishwzp.Test category">com.open1111.Test</td>
<td title="Message">调试debug信息</td>
</tr> <tr>
<td>16</td>
<td title="main thread">main</td>
<td title="Level"><font color="#993300"><strong>ERROR</strong></font></td>
<td title="com.wishwzp.Test category">com.open1111.Test</td>
<td title="Message">报错error信息</td>
</tr> <tr>
<td>16</td>
<td title="main thread">main</td>
<td title="Level"><font color="#993300"><strong>WARN</strong></font></td>
<td title="com.wishwzp.Test category">com.open1111.Test</td>
<td title="Message">警告warn信息</td>
</tr> <tr>
<td>16</td>
<td title="main thread">main</td>
<td title="Level"><font color="#993300"><strong>FATAL</strong></font></td>
<td title="com.wishwzp.Test category">com.open1111.Test</td>
<td title="Message">严重错误fatal信息</td>
</tr> <tr>
<td>16</td>
<td title="main thread">main</td>
<td title="Level"><font color="#993300"><strong>ERROR</strong></font></td>
<td title="com.wishwzp.Test category">com.open1111.Test</td>
<td title="Message">报错信息</td>
</tr>
<tr><td bgcolor="#993300" style="color:White; font-size : xx-small;" colspan="6">java.lang.IllegalArgumentException: 非法参数
<br>&nbsp;&nbsp;&nbsp;&nbsp; at com.wishwzp.Test.main(Test.java:16)
</td></tr>

标准的html table表格格式,显示信息包括 线程 等级 类 报错信息;

PatternLayout是我们以后推荐使用的,很灵活;

有个ConversionPattern属性,灵活配置输出属性:

%m 输出代码中指定的消息;

%M 输出打印该条日志的方法名;

%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL;

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

%c 输出所属的类目,通常就是所在类的全名;

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

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

%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy-MM-dd HH:mm:ss,SSS},输出类似:2002-10-18 22:10:28,921;

%l 输出日志事件的发生位置,及在代码中的行数;

SimpleLayout简单布局:

 #Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.SimpleLayout

运行输出:

INFO - 普通Info信息

DEBUG - 调试debug信息

ERROR - 报错error信息

WARN - 警告warn信息

FATAL - 严重错误fatal信息

ERROR - 报错信息

java.lang.IllegalArgumentException: 非法参数

at com.wishwzp.Test.main(Test.java:16)

只有级别和信息,确实简单

TTCCLayout我们测试下:

 #Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.TTCCLayout

运行输出:

[main] INFO com.wishwzp.Test - 普通Info信息

[main] DEBUG com.wishwzp.Test - 调试debug信息

[main] ERROR com.wishwzp.Test - 报错error信息

[main] WARN com.wishwzp.Test - 警告warn信息

[main] FATAL com.wishwzp.Test - 严重错误fatal信息

[main] ERROR com.wishwzp.Test - 报错信息

java.lang.IllegalArgumentException: 非法参数

at com.wishwzp.Test.main(Test.java:16)

我们实际开发使用的是灵活的PatternLayout 其他的了解即可;

第五节: Log4j Threshold 属性指定输出等级

有时候我们需要把一些报错ERROR日志单独存到指定文件 ,这时候,Threshold属性就派上用场了;

Threshold属性可以指定日志level

Log4j根据日志信息的重要程度,分OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL

比如我们指定某个appender的Threshold为WARN,那这个appender输出的日志信息就是WARN级别以及WARN以上的级别;

假如我们指定的是ERROR,那这个就输出ERROR或者FATAL日志信息;

当然这里有个提前  rootLogger里配置的level比如小于Threshold层级  否则无效 还是按照总的rootLogger里的level来输出,一般我们实际实用的话 rootLogger里配置DEBUG,然后某个文件专门存储ERRO日志,就配置下Threshold为ERROR,这个就是我们的最佳实践,不要乱七八糟瞎配置;

我们给下参考配置:

log4j.rootLogger=DEBUG, Console ,DFile ,EFILE

#Console

log4j.appender.Console=org.apache.log4j.ConsoleAppender

log4j.appender.Console.layout=org.apache.log4j.TTCCLayout

#DEBUGFile

log4j.appender.DFile = org.apache.log4j.FileAppender

log4j.appender.DFile.File = C://DEBUG.log

log4j.appender.DFile.layout = org.apache.log4j.PatternLayout

log4j.appender.DFile.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n

log4j.appender.DFile.Threshold = DEBUG

#ERRORFile

log4j.appender.EFILE = org.apache.log4j.FileAppender

log4j.appender.EFILE.File = C://ERROR.log

log4j.appender.EFILE.layout = org.apache.log4j.PatternLayout

log4j.appender.EFILE.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n

log4j.appender.EFILE.Threshold = ERROR

rootLogger里配置DEBUG,

DFile的Threshold 配置为DEBUG

EFILE的Threshold 配置为ERROR 只输入ERROR信息;

控制台输出:

DEBUG.log文件:

ERROR.log文件

ERROR.LOG只输出error信息;

第六节: Log4j Append 属性指定是否追加内容

Log4j默认是不断的把日志内容追加到日志文件;

这里就有个属性 Append 默认就是true;

假如我们设置成false 就不追加了 直接覆盖前面的内容;

我们来测试下:

log4j.rootLogger=DEBUG, Console ,FIEL

#Console

log4j.appender.Console=org.apache.log4j.ConsoleAppender

log4j.appender.Console.layout=org.apache.log4j.TTCCLayout

#FIEL

log4j.appender.FIEL = org.apache.log4j.FileAppender

log4j.appender.FIEL.File = C://log.log

log4j.appender.FIEL.layout = org.apache.log4j.PatternLayout

log4j.appender.FIEL.layout.ConversionPattern =%d [%t] %-5p [%c] - %m%n

log4j.appender.FIEL.Append = false

改成了 Append  为  false

测试类:

 package com.wishwzp.log4j;

 import org.apache.log4j.Logger;

 /**
* Log4j测试类
* @author ainio
*
*/
public class Test { private static final Logger logger = Logger.getLogger(Test.class); // 获取logger实例 public static void main(String[] args) {
logger.info("普通Info信息");
logger.debug("调试debug信息");
logger.error("报错error信息");
logger.warn("警告warn信息");
logger.fatal("严重错误fatal信息"); logger.error("报错信息", new IllegalArgumentException("非法参数"));
} }

我们第一次执行:

我们修改下测试代码:

 package com.wishwzp.log4j;

 import org.apache.log4j.Logger;

 /**
* Log4j测试类
* @author ainio
*
*/
public class Test { private static final Logger logger = Logger.getLogger(Test.class); // 获取logger实例 public static void main(String[] args) {
logger.info("普通Info信息222222222222");
logger.debug("调试debug信息");
logger.error("报错error信息22222222222");
logger.warn("警告warn信息");
logger.fatal("严重错误fatal信息"); logger.error("报错信息222222222222", new IllegalArgumentException("非法参数"));
} }

按照默认 Append为 true

是追加的,我们这里Append 为false

结果是覆盖前面的

OK 这个属性我们了解下即可 用默认的true即可;

(二) Log4j 配置详解的相关教程结束。

《(二) Log4j 配置详解.doc》

下载本文的Word格式文档,以方便收藏与打印。