LOG4J 文档学习笔记

LOG4J 文档学习笔记

1 入门实例

1.1 配置日志

1. 新建一个JAva工程，导入包log4j-1.2.17.jar
2. 在classpath创建并设置log4j.properties（src下或者resource中）

 ### 设置###
LOGDIR=E://logs
log4j.rootLogger = debug,stdout,D,E

### 输出信息到控制抬 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

### 输出DEBUG 级别以上的日志到=E://logs/error.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = ${LOGDIR}/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 输出ERROR 级别以上的日志到=E://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =${LOGDIR}/error.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

1.2 编写程序

package com.haoyutiangang;
import org.apache.log4j.Logger;
public class Test {
    private static Logger logger = Logger.getLogger(Test.class);  

    public static void main(String[] args) {  
        // 记录debug级别的信息  
        logger.debug("This is debug message.");  
        // 记录info级别的信息  
        logger.info("This is info message.");  
        // 记录error级别的信息  
        logger.error("This is error message.");  
    }  
}

1.3 查看运行结果

控制台和日志文件（略）

2 Log4j基本使用方法

Log4j由三个重要的组件构成：Loggers(记录器)，Appenders (输出源)和Layouts(布局)。这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。
Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件log4j.properties（键=值）。
下面将介绍使用log4j.properties文件作为配置文件的方法。

2.1 通用属性配置

可以在log4j.properties的顶端配置一些通用属性key=value（例如日志目录），下面用到时使用 ${key} 即可。

LOG_DIR=c:\logs 
...
log4j.appender.platform1.File=${LOG_DIR}/trace.log 

2.2 配置logger

Logger 负责处理日志记录的大部分操作。
其语法为：

log4j.logger.rootLogger = [ level ] , appenderName, appenderName, …
log4j.logger.com.test = [ level ] , appenderName, appenderName, …
log4j.logger.com.test.TestClass = [ level ] , appenderName, appenderName, …
log4j.logger.customName = [ level ] , appenderName, appenderName, …

1. rootLogger表示根Logger,其他类的logger都继承rootLogger
2. 包/类Logger都要写全名因为一级一级存在继承关系
3. 自定义Logger不参与包/类Logger的继承，但是也继承rootLogger

(1) level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。
(2) Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。
(3) ALL: 打印所有的日志，OFF：关闭所有的日志输出。
(4) appenderName就是指定具体的日志输出方式，可同时指定多个输出目的地。

2.3 配置Appender:日志信息输出目的地

Appender 负责控制日志记录操作的输出。
Log4j提供的appender有以下几种：

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

例如：log4j.appender.stdout=org.apache.log4j.ConsoleAppender
就是定义一个名为stdout的输出目的地，ConsoleAppender为控制台。
配置模式：

log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.optionN = valueN

这里的appenderName为在2.1里定义的，可任意起名。

2.3 配置Layout:日志信息布局方式

Layout 负责格式化Appender的输出。

Log4j提供的layout有以下几种：

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

配置模式：

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN

2.4 配置PatternLayout:输出格式化

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

ConversionPattern=%m%n //设定以怎样的格式显示消息。

打印参数如下：
%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这样的多客户多线程的应用中。
%%：输出一个”%”字符。

另外，还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如：
1) c：指定输出category的名称，最小的长度是20，如果category的名称长度小于20的话，默认的情况下右对齐。
2)%-20c：”-“号表示左对齐。
3)%.30c：指定输出category的名称，最大的长度是30，如果category的名称长度大于30的话，就会将左边多出的字符截掉，但小于30的话也不会补空格。

3 Log4j的java特性

Logger之间是具有java的继承特性的。Log4j有一个rootLogger，所有普通logger都默认继承rootLogger。而普通logger之间的继承关系是通过logger name来实现的。

例如，叫”com.foo.Bar”名字的logger就继承于叫”com.foo”名字的logger。就好像java中”java.util” 和”java.util.Vector”的关系一样。

而这些继承关系决定了logger的Level和Appender这两个属性的确定。

3.1 Level的确定

如果一个普通logger定义了Level，则其level就使用它定义的（例如：logger X），如果没有定义，就使用其父logger的（例如：logger X.Y）。

3.2 Appender的确定

AdditivityFlag: true/false 是否向上传递将日志输出到其父的Appender中。

 log4j.additivity.${loggername}=true/false

1. 如果一个普通logger定义Appender且其AdditivityFlag是true，则该logger的Appender包括其定义的Appender及其父logger定义的Appender。
2. 如果一个普通logger没有定义Appender，但其AdditivityFlag是true，则该logger的Appender为其父logger定义的Appender。
3. 如果一个普通logger定义了Appender，但其AdditivityFlag是false，则该logger的Appender只为其定义的Appender。

4 配置举例

4.1 输出到控制台

### 输出到控制台
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Threshold=warn //过滤级别，默认debug
log4j.appender.stdout.ImmediateFlush=true //表示所有消息都会被立即输出，设为false则不输出，默认值是true。 
log4j.appender.stdout.Target = System.err //默认值是System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n

4.2 输出到指定文件

### 输出到指定文件
log4j.appender.file=org.apache.log4j.FileAppender  
log4j.appender.file.Threshold=warn //过滤级别，默认debug
log4j.appender.file.ImmediateFlush=true //表示所有消息都会被立即输出，设为false则不输出，默认值是true。 
log4j.appender.file.Append=false //是否追加，默认是true,false时覆盖
log4j.appender.file.File=C:\\file.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout  
log4j.appender.file.layout.ConversionPattern=%d{yyyyMMdd HH:mm:ss} %p %l [%t] %m%n  

4.3 输出到按大小滚动的文件

### 输出到按大小滚动的文件
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.Threshold=warn //过滤级别，默认debug
log4j.appender.file.ImmediateFlush=true //表示所有消息都会被立即输出，设为false则不输出，默认值是true。
log4j.appender.file.Append=false //是否追加，默认是true,false时覆盖
log4j.appender.file.File=C:\\loging.log
log4j.appender.file.MaxFileSize=1MB //滚动阈值，后缀可以是KB, MB 或者GB
log4j.appender.file.MaxBackupIndex=2 //可滚动文件数，设为2则可以产生logging.log.1，logging.log.2两个滚动文件和一个logging.log文件
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

4.4 输出到按时间滚动的文件

### 输出到按时间滚动的文件
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=warn //过滤级别，默认debug
log4j.appender.dailyFile.ImmediateFlush=true //表示所有消息都会被立即输出，设为false则不输出，默认值是true。
log4j.appender.dailyFile.Append=true //是否追加，默认是true,false时覆盖
log4j.appender.dailyFile.File=C:\\logging.log
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd //当前日的日志文件名为logging.log，前一天的日志文件名为logging.log.yyyy-MM
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout  
log4j.appender.dailyFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p - %m%n

# 另外，也可以指定按月、周、天、时、分等来滚动日志文件，对应的格式如下：
# 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：每分钟 

参考文献

官方文档：http://logging.apache.org/log4j/1.2/manual.html
最详细的Log4j使用教程：http://blog.csdn.net/liweibin_/article/details/11984895
slf4j配置实例：http://www.codeceo.com/article/log4j-usage.html
Log4J日志配置详解:http://www.cnblogs.com/ITtangtang/p/3926665.html