【Log4J】Log4j记录日志配置

                                Log4j记录日志配置

一、log4j简介

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务 器、NT的事件记录器、UNIXSyslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

 

二、配置文件解析

结构图：

目录层次关系：

1、Appender 为日志输出目的地，Log4j提供的appender有以下几种：

org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方） 

2、Layout：日志输出格式，Log4j提供的layout有以下几种：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

打印参数: Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，如下:

　  %m   输出代码中指定的消息
　　%p   输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL 
　　%r   输出自应用启动到输出该log信息耗费的毫秒数 
　　%c   输出所属的类目，通常就是所在类的全名 
　　%t   输出产生该日志事件的线程名 
　　%n   输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n” 
　　%d   输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss, SSS}，输出类似：2002年10月18日  22 ： 10 ： 28 ， 921  
　　%l   输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java: 10) 

三、具体配置步骤

1、引入jar包

在maven的pom.xml中引入jar包：

<dependency>
           <groupId>log4j</groupId>
           <artifactId>log4j</artifactId>
           <version>1.2.16</version>
</dependency>

2、在web.xml中定义监听器及相关路径

<!-- log4j配置 -->
    <context-param>
        <param-name>log4jConfigLocation</param-name>
        <param-value>classpath:config/log4j.xml</param-value>
    </context-param>
    <context-param> 
    <param-name>webAppRootKey</param-name> 
    <param-value>webApp.root</param-value> 
    </context-param>
    <listener>
<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener>

log4jConfigLocation定义了log4j的配置文件位置。

webAppRootKey元素指定了该项目的根目录，在以后使用${webApp.root}时即代表项目根目录。

 

3、在log4j.xml中配置

<?xml version="1.0"encoding="UTF-8" ?>
<!DOCTYPE log4j:configurationSYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="LOG_FILE"class="org.apache.log4j.RollingFileAppender">
    <param name="File"value="${webApp.root}/WEB-INF/logs/test.log"/>
    <param name="Append"value="true"/>
    <param name="MaxFileSize"value="30000KB"/>
    <param name="MaxBackupIndex"value="10"/>
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern"value="[%t][%d][%r][%p][ %l] %n    %m%n"/>
    </layout>
    <filter class="org.apache.log4j.varia.LevelRangeFilter">  
        <param name="LevelMin"value="DEBUG" />  
        <param name="LevelMax"value="ERROR" />  
    </filter>
</appender>
<!-- [组件日志] --> 
   <logger name="com.test"additivity="false">  
      <appender-ref ref="LOG_FILE"/> 
   </logger> 
<root>      
        <priority value="error"/>       
        <appender-ref ref="LOG_FILE"/>   
</root>
</log4j:configuration>

（1）Appender的class属性代表输出方式，RollingFileAppender是指满足一定大小后重新生成新的日志文件。Param中的FILE参数定义了输出路径，Append参数决定日志是否追加，MaxFileSize设定了一个日志文件的大小，MaBackupIndex设置日志文件的最大数量 。

（2）Layout元素设置日志输出格式，[%t][%d][%r][%p][ %l] %n %m%n格式样例为：

[main][2015-08-1414:35:01,468][0][ERROR] [com.test.TestDemo.main (TestDemo.java:46)]

log error..

filter:过滤器设置输出的级别。

（3）logger与root元素

"root"：是所有logger的父类。

"additivity": 是否继承父类, false表示不继承 。

Logger的name属性一定要注意取名，在代码中我们一般使用以下方法获取logger对象：

Logger log= Logger.getLogger(T.class);

同时我们也可以使用：

Logger log= Logger.getLogger(“name”);//name为配置文件中logger的name属性的值。

Logger获取logger对象的原理：

首先根据参数名去寻找logger，如果没有匹配的那么则获取其父类，比如我想获取

Com.my.dao.test的logger，但是配置文件中没有name为其的logger，那么就会去寻找是否有命名为com.my.dao的logger，同理一级级向上如果连com都没有那么直接使用root元素定义的logger。

  如果additivity="true",代表该logger继承root。如果root和该logger的配置有重复的话就会输出两次日志信息。

4、使用方式

private static finalLogger log = Logger.getLogger(T.class);

log.error("查询错误..",e);

 

四、配置文件元素详解

1、 log4j:configuration (root element)

--xmlns:log4j[#FIXED attribute] : 定义log4j的名字空间，取定值"http://jakarta.apache.org/log4j/"

--appender [* child] : 一个appender子元素定义一个日志输出目的地

--logger [* child] : 一个logger子元素定义一个日志写出器

--root [? child] : root子元素定义了root logger

 

2、 appender

appender元素定义一个日志输出目的地。

--name [#REQUIRED attribute] : 定义appender的名字，以便被后文引用

--class [#REQUIRED attribute] : 定义appender对象所属的类的全名

--param [* child] : 创建appender对象时传递给类构造方法的参数

--layout [? child] : 该appender使用的layout对象

 

3、 layout

layout元素定义与某一个appender相联系的日志格式化器。

--class [#REQUIRED attribute] : 定义layout对象所属的类的全名

--param [* child] : 创建layout对象时传递给类构造方法的参数

4、 logger

logger元素定义一个日志输出器。

--name [#REQUIRED attribute] : 定义logger的名字，以便被后文引用

--additivity [#ENUM attribute] : 取值为"true"（默认）或者"false"，是否继承父logger的属性

--level [? child] : 定义该logger的日志级别

--appender-ref [* child] : 定义该logger的输出目的地

 

5、 root

root元素定义根日志输出器root logger。

--param [* child] : 创建root logger对象时传递给类构造方法的参数

--level [? child] : 定义root logger的日志级别

--appender-ref [* child] : 定义root logger的输出目的地

 

6、 level

level元素定义logger对象的日志级别。 

--class [#IMPLIED attribute] : 定义level对象所属的类，默认情况下是"org.apache.log4j.Level类

--value [#REQUIRED attribute] : 为level对象赋值。可能的取值从小到大依次为"all"、"debug"、"info"、"warn"、"error"、"fatal"和"off"。当值为"off"时表示没有任何日志信息被输出

--param [* child] : 创建level对象时传递给类构造方法的参数

 

7、 appender-ref

appender-ref元素引用一个appender元素的名字，为logger对象增加一个appender。

--ref [#REQUIRED attribute] : 一个appender元素的名字的引用

--appender-ref元素没有子元素

 

8、 param

param元素在创建对象时为类的构造方法提供参数。它可以成为appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。

--name and value [#REQUIRED attributes] : 提供参数的一组名值对

--param元素没有子元素