目录
1. 配置应用场景
2. 前提条件
3. 配置示例(为dubbu服务提供方spring+maven项目配置的日志)
4. 中的标签与配置类解读
4.1 5种输出方式Appender
4.2 日记记录的优先级priority
4.3 layout标签中的格式说明
4.4 xml declaration and DTD
4.5 在xml文件中配置appender和layout
4.6 创建ConsoleAppender对象
4.8 创建RollingFileAppender对象
4.9 创建PatternLayout对象
在spring+maven项目中,尤其在生产环境要定位项目运行过程中出现的bugger,必须借助于详细的日志记录。
2. 前提条件
在maven项目的文件中引入log4j的maven依赖
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
3. 配置示例(为dubbu服务提供方spring+maven项目配置的日志)
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM
"/log4j/1.2/apidocs/org/apache/log4j/xml/doc-files/">
<log4j:configuration debug="false" >
<appender name="myConsole" class=".">
<layout class=".">
<param name="ConversionPattern" value="[%d{dd HH:mm:ss,SSS\} %-5p] [%t] %c{2\} - %m%n"/>
</layout>
<!--过滤器设置输出的级别-->
<filter class=".">
<param name="levelMin" value="debug" />
<param name="levelMax" value="warn" />
<param name="AcceptOnMatch" value="true" />
</filter>
</appender>
<appender name="myFile" class=".">
<param name="File" value="D:/dubbo/logs/provider/rollingLog/" /><!-- 设置日志输出文件名 -->
<!-- 设置是否在重新启动服务时,在原有日志的基础添加新日志 -->
<param name="Append" value="true" />
<param name="MaxBackupIndex" value="10" />
<layout class=".">
<param name="ConversionPattern" value="%p (%c:%L)- %m%n" />
</layout>
</appender>
<appender name="activexAppender" class=".">
<param name="File" value="D:/dubbo/logs/provider/dailyLog/" />
<param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />
<layout class=".">
<param name="ConversionPattern" value="[%d{MMdd HH:mm:ss SSS\} %-5p] [%t] %c{3\} - %m%n" />
</layout>
</appender>
<!-- 指定logger的设置,additivity指示是否遵循缺省的继承机制-->
<logger name="" additivity="false">
<appender-ref ref="activexAppender" />
</logger>
<!-- 根logger的设置-->
<root>
<priority value ="debug"/>
<appender-ref ref="myConsole"/>
<appender-ref ref="myFile"/>
</root>
</log4j:configuration>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//log4j/log4j Configuration//EN" "">
<log4j:configuration xmlns:log4j="/log4j/">
<!-- 日志输出到控制台 -->
<appender name="console" class=".">
<!-- 日志输出格式 -->
<layout class=".">
<param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}][%c]-[%m]%n"/>
</layout>
<!--过滤器设置输出的级别-->
<filter class=".">
<!-- 设置日志输出的最小级别 -->
<param name="levelMin" value="INFO"/>
<!-- 设置日志输出的最大级别 -->
<param name="levelMax" value="ERROR"/>
</filter>
</appender>
<!-- 输出日志到文件 -->
<appender name="fileAppender" class=".">
<!-- 输出文件全路径名-->
<param name="File" value="/data/applogs/own/"/>
<!--是否在已存在的文件追加写:默认时true,若为false则每次启动都会删除并重新新建文件-->
<param name="Append" value="false"/>
<param name="Threshold" value="INFO"/>
<!--是否启用缓存,默认false-->
<param name="BufferedIO" value="false"/>
<!--缓存大小,依赖上一个参数(bufferedIO), 默认缓存大小8K -->
<param name="BufferSize" value="512"/>
<!-- 日志输出格式 -->
<layout class=".">
<param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}][%c]-[%m]%n"/>
</layout>
</appender>
<!-- 输出日志到文件,当文件大小达到一定阈值时,自动备份 -->
<!-- FileAppender子类 -->
<appender name="rollingAppender" class=".">
<!-- 日志文件全路径名 -->
<param name="File" value="/data/applogs/" />
<!--是否在已存在的文件追加写:默认时true,若为false则每次启动都会删除并重新新建文件-->
<param name="Append" value="true" />
<!-- 保存备份日志的最大个数,默认值是:1 -->
<param name="MaxBackupIndex" value="10" />
<!-- 设置当日志文件达到此阈值的时候自动回滚,单位可以是KB,MB,GB,默认单位是KB,默认值是:10MB -->
<param name="MaxFileSize" value="10KB" />
<!-- 设置日志输出的样式 -->`
<layout class=".">
<!-- 日志输出格式 -->
<param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" />
</layout>
</appender>
<!-- 日志输出到文件,可以配置多久产生一个新的日志信息文件 -->
<appender name="dailyRollingAppender" class=".">
<!-- 文件文件全路径名 -->
<param name="File" value="/data/applogs/own/"/>
<param name="Append" value="true" />
<!-- 设置日志备份频率,默认:为每天一个日志文件 -->
<param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />
<!--每分钟一个备份-->
<!--<param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" />-->
<layout class=".">
<param name="ConversionPattern" value="[%p][%d{HH:mm:ss SSS}][%c]-[%m]%n"/>
</layout>
</appender>
<!--
1. 指定logger的设置,additivity是否遵循缺省的继承机制
2. 当additivity="false"时,root中的配置就失灵了,不遵循缺省的继承机制
3. 代码中使用("logTest")获得此输出器,且不会使用根输出器
-->
<logger name="logTest" additivity="false">
<level value ="INFO"/>
<appender-ref ref="dailyRollingAppender"/>
</logger>
<!-- 根logger的设置,若代码中未找到指定的logger,则会根据继承机制,使用根logger-->
<root>
<appender-ref ref="console"/>
<appender-ref ref="fileAppender"/>
<appender-ref ref="rollingAppender"/>
<appender-ref ref="dailyRollingAppender"/>
</root>
</log4j:configuration>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "">
<log4j:configuration xmlns:log4j="/log4j/">
<!-- Appenders 日志信息输出目的地 -->
<!-- ConsoleAppender -->
<!-- 每个ConsoleAppender都有一个target,表示它的输出目的地。 -->
<!-- 它可以是,标准输出设备(缓冲显示屏) -->
<!-- 或者是,标准错误设备(不缓冲显示屏) -->
<appender name="console" class=".">
<param name="Target" value="" />
<layout class=".">
<param name="ConversionPattern" value="%d %-5p: %c - %m%n" />
</layout>
</appender>
<!-- RollingFileAppender 回滚文件 -->
<!-- Append true,默认每次启动系统,日志继续输出到原来的文件,而不是清空了再来 -->
<!-- MaxFileSize 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到.1文件 -->
<!-- MaxBackupIndex 最多20个 -->
<!-- PatternLayout 控制日志输出的格式化,参考上面的那些符合说明,自己怼自己想要的格式。 -->
<!-- filter 级别范围过滤器 -->
<!-- levelMin levelMax 范围 -->
<appender name="StreamOperateFile" class=".">
<param name="File" value="f:/ezLog/" />
<param name="Append" value="true"/>
<param name="MaxFileSize" value="10MB"/>
<param name="MaxBackupIndex" value="20"/>
<layout class=".">
<param name="ConversionPattern" value="%m%n" />
</layout>
<filter class=".">
<param name="levelMin" value="INFO" />
<param name="levelMax" value="INFO" />
<param name="AcceptOnMatch" value="true" />
</filter>
</appender>
<!-- 同上 回滚文件,有2个的原因就是演示,把不同的日志输出到不同的文件 -->
<appender name="File" class=".">
<param name="File" value="f:/ezLog/" />
<param name="Append" value="true"/>
<param name="MaxFileSize" value="10MB"/>
<param name="MaxBackupIndex" value="20"/>
<layout class=".">
<param name="ConversionPattern" value="%d %-5p: %c - %m%n" />
</layout>
</appender>
<!-- 下面这些就是根据 这些路径来控制对应包下的文件的日志输出级别,基本上都是报错了,才输出日志-->
<logger name="">
<level value="error" />
</logger>
<logger name="">
<level value="error" />
</logger>
<logger name="">
<level value="error" />
</logger>
<logger name="">
<level value="error" />
</logger>
<logger name="">
<level value="error" />
</logger>
<logger name="">
<level value="debug" />
</logger>
<logger name="">
<level value="error" />
</logger>
<!-- 这个就是自定义的一个logger -->
<!-- 输出级别是info级别及以上的日志,不要怕,StreamOperateFile已经过滤,只输出info级别的日志 -->
<!-- additivity 这个默认是true,即继承父类 root logger -->
<!-- 也就是说,你的这个日志也会在root的logger里面输出的,我这里配置false,就是不继承,各走各的。 -->
<!-- appender-ref 也就是说这个logger的输出目的地是哪里,ref就是关联到上面声明的一个file,一个console -->
<logger name="StreamOperateFile" additivity="false">
<level value="info" />
<appender-ref ref="StreamOperateFile" />
<appender-ref ref="console" />
</logger>
<!-- 传说中的根logger -->
<!-- 输出级别是info级别及以上的日志,下面的ref关联的两个appender没有filter设置,所以,info及以上的日志都是会输出到这2个appender的 -->
<root>
<priority value="info" />
<appender-ref ref="console" />
<appender-ref ref="File" />
</root>
</log4j:configuration>
中的标签最终都会解析成包中对应的java类
4. 中的标签与配置类解读
4.1 5种输出方式Appender
.:滚动文件,自动记录最新日志
.:控制台打印
.:文件记录
. :每天产生一个日志文件
.: 将日志信息以流格式发送到任意指定的地
4.2 日记记录的优先级priority
优先级由高到低分为 OFF ,FATAL ,ERROR ,WARN ,INFO ,DEBUG ,ALL。
Log4j建议只使用FATAL ,ERROR ,WARN ,INFO ,DEBUG这五个级别。
4.3 layout标签中的格式说明
layout标签中的格式参数都以%开始,后面不同的参数代表不同的格式化信息(参数按字母表顺序列出):
%c : 输出所属类的全名,可在修改为 %C{Num} ,Num类名输出的维(如:"",%C{2}将输出)
%d : 输出日志时间其格式为 %d{yyyy-MM-dd HH:mm:ss,SSS},可指定格式 如 %d{HH:mm:ss}
%l : 输出日志事件发生位置,包括类目名、发生线程,在代码中的行数
%n : 换行符
%m : 输出代码指定信息,如info(“message”),输出message
%p : 输出优先级,即 FATAL ,ERROR 等
%r: 输出从启动到显示该log信息所耗费的毫秒数
%t: 输出产生该日志事件的线程名
4.4 xml declaration and DTD
xml配置文件的头部包括两个部分:xml声明和DTD声明。头部的格式如下:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM
"/log4j/1.2/apidocs/org/apache/log4j/xml/doc-files/">
注意:log4j老版本的第二行声名为:
<!DOCTYPE log4j:configuration SYSTEM "">
log4j:configuration (root element)
appender [* child] : 一个appender子元素定义一个日志输出目的地
logger [* child] : 一个logger子元素定义一个日志写出器
root [? child] : root子元素定义了root logger
appender
appender元素定义一个日志输出目的地。
name [#REQUIRED attribute] : 定义appender的名字,以便被后文引用
class [#REQUIRED attribute] : 定义appender对象所属的类的全名
param [* child] : 创建appender对象时传递给类构造方法的参数
layout [? child] : 该appender使用的layout对象
layout
layout元素定义与某一个appender相联系的日志格式化器。
class [#REQUIRED attribute] : 定义layout对象所属的类的全名
param [* child] : 创建layout对象时传递给类构造方法的参数
logger
logger元素定义一个日志输出器。
name [#REQUIRED attribute] : 定义logger的名字,以便被后文引用
additivity [#ENUM attribute] : 取值为"true"(默认)或者"false",是否继承父logger的属性
level [? child] : 定义该logger的日志级别
appender-ref [* child] : 定义该logger的输出目的地
root
root元素定义根日志输出器root logger。
param [* child] : 创建root logger对象时传递给类构造方法的参数
level [? child] : 定义root logger的日志级别
appender-ref [* child] : 定义root logger的输出目的地
level
level元素定义logger对象的日志级别。
class [#IMPLIED attribute] : 定义level对象所属的类,默认情况下是".类
value [#REQUIRED attribute] : 为level对象赋值。可能的取值从小到大依次为"all"、"debug"、"info"、"warn"、"error"、"fatal"和"off"。当值为"off"时表示没有任何日志信息被输出
param [* child] : 创建level对象时传递给类构造方法的参数
appender-ref
appender-ref元素引用一个appender元素的名字,为logger对象增加一个appender。
ref [#REQUIRED attribute] : 一个appender元素的名字的引用
appender-ref元素没有子元素
param
param元素在创建对象时为类的构造方法提供参数。它可以成为appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。
name and value [#REQUIRED attributes] : 提供参数的一组名值对
param元素没有子元素
4.5 在xml文件中配置appender和layout
创建不同的Appender对象或者不同的Layout对象要调用不同的构造方法。可以使用param子元素来设定不同的参数值。
4.6 创建ConsoleAppender对象
ConsoleAppender的构造方法不接受其它的参数。
<appender name="myConsole" class=".">
<layout class=".">
<param name="ConversionPattern" value="[%d{dd HH:mm:ss,SSS\} %-5p] [%t] %c{2\} - %m%n"/>
</layout>
<!--过滤器设置输出的级别-->
<filter class=".">
<param name="levelMin" value="debug" />
<param name="levelMax" value="warn" />
<param name="AcceptOnMatch" value="true" />
</filter>
</appender>
4.7 创建FileAppender对象
可以为FileAppender类的构造方法传递两个参数:File表示日志文件名;Append表示如文件已存在,是否把日志追加到文件尾部,可能取值为"true"和"false"(默认)。
<appender name="myFile" class=".">
<param name="File" value="D:/dubbo/logs/provider/rollingLog/" />
<!-- 设置是否在重新启动服务时,在原有日志的基础添加新日志 -->
<param name="Append" value="true" />
<param name="MaxBackupIndex" value="10" />
<layout class=".">
<param name="ConversionPattern" value="%p (%c:%L)- %m%n" />
</layout>
</appender>
4.8 创建RollingFileAppender对象
除了File和Append以外,还可以为RollingFileAppender类的构造方法传递两个参数:MaxBackupIndex备份日志文件的个数(默认是1个);MaxFileSize表示日志文件允许的最大字节数(默认是10M)。
<appender name="activexAppender" class=".">
<param name="File" value="D:/dubbo/logs/provider/dailyLog/" />
<param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />
<layout class=".">
<param name="ConversionPattern" value="[%d{MMdd HH:mm:ss SSS\} %-5p] [%t] %c{3\} - %m%n" />
</layout>
</appender>
4.9 创建PatternLayout对象
可以为PatternLayout类的构造方法传递参数ConversionPattern。
<layout class=".">
<param name="ConversionPattern" value="[%d{dd HH:mm:ss,SSS\} %-5p] [%t] %c{2\} - %m%n"/>
</layout>
参考文章:/blog/347340
/weizhxa/p/