Log4j 基本配置使用详解

log4j简介:

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

log4j定义配置文件

日志信息的优先级,从高到低有:OFF (关闭),FATAL (致命),ERROR(错误) ,WARN(警告) ,INFO(信息) ,DEBUG(调试) ,ALL(打开所有的日志,我的理解与DEBUG级别好像没有什么区别得)。Log4j建议只使用FATAL ,ERROR ,WARN ,INFO ,DEBUG这五个级别。

Log4j的配置文件支持两种方式:properties与xml方式,这两种方法写法不一样,但是所表示的意义都是一样的。

Properties配置

Xml配置

配置文件加载方式

org.apache.log4j.PropertyConfigurator.configure*

org.apache.log4j.xml.DOMConfigurator.configureAndWatch

日志名称的配置及输出方式

#配置以log4j.apaender开头,后边跟上配置的名字,等号后边是日志的输出类(即日志的输出方式),将在后边介绍日志的输出类。

log4j.appender.logName1=org.apache.log4j.ConsoleAppender

log4j.appender.logName1.option1=XXX

...

log4j.appender.logName1.optionN=XXX

<?xmlversion="1.0"encoding="UTF-8"?>

<!DOCTYPElog4j:configuration PUBLIC"-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd">

<log4j:configuration>

<!-- name为配置的名字,class为日志的输出类(即日志的输出方式) -->

<appender name="logName1" class="org.apache.log4j.ConsoleAppender">

<param name="option1" value="XXX"/>

...

<param name="optionN" value="XXX"/>

</appender>

</log4j:configuration>

外边的xml根节点都是固定的形式,log4j的所有配置都写在log4j:configuartion根节点的里边,后边的将不再写该根节点配置信息。

日志的输出方式常用的有以下几种:

org.apache.log4j.ConsoleAppender----控制台

org.apache.log4j.FileAppender----指定的文件中

org.apache.log4j.DailyRollingFileAppender----按天生成指定的文件。

org.apache.log4j.RollingFileAppender ----按配置的文件大小生记录到指定的文件中(文件到达一定的大小,自动备份,新建一份)

各种输出方式的选项如下:

1.ConsoleAppender 选项

Threshold=WARN 指定日志消息的输出最低层次

ImmediateFlush=true默认值是true,意谓着所有的消息都会被立即输出

Target=System.err 默认情况下是:System.out,指定输出控制台

2.FileAppender 选项

Threshold=WARN指定日志消息的输出最低层次。

ImmediateFlush=true默认值是true,意谓着所有的消息都会被立即输出。

File=mylog.txt指定消息输出到mylog.txt文件。

Append=false 默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。

3.DailyRollingFileAppender 选项

Threshold=WARN指定日志消息的输出最低层次

ImmediateFlush=true默认值是true,意谓着所有的消息都会被立即输出

File=mylog.txt指定消息输出到mylog.txt文件

Append=false默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容

DatePattern='.'yyyy-ww 每周滚动一次文件,即每周产生一个新的文件。当然也可以指定按月、周、天、时和分

即对应的格式如下:

'.'yyyy-MM: 每月

'.'yyyy-ww: 每周

'.'yyyy-MM-dd: 每天

'.'yyyy-MM-dd-a: 每天两次

'.'yyyy-MM-dd-HH: 每小时

'.'yyyy-MM-dd-HH-mm: 每分钟

4.RollingFileAppender 选项

Threshold=WARN:指定日志消息的输出最低层次

ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出

File=mylog.txt:指定消息输出到mylog.txt文件

Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容

MaxFileSize=100KB:后缀可以是KB,MB或者是GB.在日志文件到达该大小时,将会自动滚动,即将原来的内容移到mylog.log.1文件

MaxBackupIndex=2: 指定可以产生的滚动文件的最大数

日志的布局方式

log4j.appender.appenderName.layout=packages.layoutClasslog4j.appender.f.layout.ConversionPattern=%d %r %l %t [%p] - %m%n

<appendername="fileLog"class="org.apache.log4j.DailyRollingFileAppender">

<paramname="file"value="logs/a.log"/>

<paramname="threshold"value="warm"/>

<layout class="org.apache.log4j.PatternLayout">

<param name="ConversionPattern" value="%d %r %l %t [%p] - %m%n"/>

</layout>

</appender>

Log4j提供的layout常用的有以下几种:

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

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

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

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

例如:

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

配置格式化信息,其语法为:

log4j.appender.appenderName.layout.ConversionPattern=XXXXXXXXX

log4j提供的打印参数如下:

-X号:X信息输出时左对齐;

%p:输出日志信息优先级,即DEBUG,INFO,WARN,ERROR,FATAL,

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

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

%c:输出日志信息所属的类目,通常就是所在类的全名

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

%l:输出日志事件的发生位置,相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.java:10)

%x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像javaservlets这样的多客户多线程的应用中。

%%:输出一个"%"字符

%F:输出日志消息产生时所在的文件名称

%L:输出代码中的行号

%m:输出代码中指定的消息,产生的日志具体信息

%n:输出一个回车换行符,Windows平台为"\r\n",Unix平台为"\n"输出日志信息换行

可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如:

1)%20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,默认的情况下右对齐。

2)%-20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,"-"号指定左对齐。

3)%.30c:指定输出category的名称,最大的宽度是30,如果category的名称大于30的话,就会将左边多出的字符截掉,但小于30的话也不会有空格。

4)%20.30c:如果category的名称小于20就补空格,并且右对齐,如果其名称长于30字符,就从左边交远销出的字符截掉。

例如:

log4j.appender. CONSOLE.layout.ConversionPattern=%d{yyyyMMdd-HH:mm:ss} %t %c %m%n

根配置方式

#配置log4j根节点信息,第一个是日志输出级别,可以根据上边的几个日志的优先级来设置修改;后边是该根节点使用的日志配置名字,可以配置多个,以逗号分隔;

#这里可能会看到rootCategory,它与rootLogger是相等的,前者是以前老版本的写法,后者是新版本的写法

log4j.rootLogger=debug[,logName1[,logName2]...]

<root>

<level value="warn"/><!--日志级别,原则同左边 -->

<appender-ref ref="logName1"/>

<appender-ref ref="logName2"/><!--这里可以配置多个引用 -->

</root>