Log4j的使用方法

第一次使用log4j,总结一下,留作纪念

1.案例一:测试

主方法:   

 

private static Logger logger = Logger.getLogger(HelloLog4j.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");    	}

 

 

 

 

配置文件:(log4j.properties)    

    log4j.rootLogger=debug,appender1

    log4j.appender.appender1=org.apache.log4j.ConsoleAppender

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

实验结果:(控制台输出)   

 [main] DEBUG com.itheima.test.HelloLog4j - This is debug message.   

 [main] INFO com.itheima.test.HelloLog4j - This is info message    

[main] ERROR com.itheima.test.HelloLog4j - This is error messade    

2.Log4j的构成

​ 通过配置文件可知,我们需要配置3个方面的内容:

​ 1.根目录(级别和目的地)

​ 2.目的地(控制台,文件等等)

​ 3.输出样式

​ Log4j的文件结构:

 

Logger - 日志写出器，供程序员输出日志信息

Appender - 日志目的地，把格式化好的日志信息输出到指定的地方去

ConsoleAppender - 目的地为控制台的Appender

FileAppender - 目的地为文件的Appender

RollingFileAppender - 目的地为大小受限的文件的Appender

Layout - 日志格式化器，用来把程序员的logging request格式化成字符串

PatternLayout - 用指定的pattern格式化logging request的Layout

 

3.Log4j的使用方法

Log4j的优先级别从高到低:ERROR,WARN,INFO.DEBUG

3.1 properties配置文件详解

2种配置方法:xml或者 properties文件

下面以properties配置文件为主:

(1) 配置根 Logger:

语法:log4j.rootLogger = level,appendarName1,appendarName2......

Level 是日志记录的优先级,ALL<DEBUG<INFO<WARN<ERROR<FATAL<OFF输出时按优先级从高到低输出

(2) 配置日志信息输出目的地Appendar

log4j.appender.appenderName =Log4j提供的appender类

log4j.appender.appenderName.属性名= 属性值

log4j.appender.appenderName.属性名= 属性值

目的地可以有多个,以逗号分割

目的地代码:

org.apache.log4j.ConsoleAppender（控制台），

org.apache.log4j.FileAppender（文件），

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），

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

目的地属性值介绍:

a) ConsoleAppender选项

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

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

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

 

b) FileAppender选项

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

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

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

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

 

c) DailyRollingFileAppender选项

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

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

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

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

DatePattern=''.''yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。

当然也可以指定按月、周、天、时和分。即对应的格式如下：

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: 每分钟

 

d) 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:指定可以产生的滚动文件的最大数。

(3)  配置日志信息的格式(布局)

log4j.appender.appenderName.layout = Log4j提供的layout类

log4j.appender.appenderName.layout.属性= 值

log4j.appender.appenderName.layout.属性= 值

 

提供的布局:

org.apache.log4j.HTMLLayout（以HTML表格形式布局），

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

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

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

 

1) HTMLLayout选项

LocationInfo=true:默认值是false,输出java文件名称和行号

Title=my app file: 默认值是 Log4J Log Messages.

 

2) PatternLayout选项

ConversionPattern=%m%n :指定怎样格式化指定的消息。

 

3) XMLLayout选项

LocationInfo=true:默认值是false,输出java文件和行号

 

3.2 xml配置文件详解 

xml格式的log4j配置文件需要使用org.apache.log4j.html.DOMConfigurator.configure()方法来读入

对xml文件的语法定义可以在log4j的发布包中找到：org/apache/log4j/xml/log4j.dtd。

 

3.2.1 头部配置文件

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

 

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

 

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

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

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

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

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

 

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

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

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

 

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

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

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

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

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

 

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

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

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

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

 

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对象时传递给类构造方法的参数

 

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

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

appender-ref元素没有子元素

 

param元素在创建对象时为类的构造方法提供参数。

它可以成为appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。

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

param元素没有子元素

 

在xml文件中配置appender和layout

创建不同的Appender对象或者不同的Layout对象要调用不同的构造方法。可以使用param子元素来设定不同的参数值。

 

创建ConsoleAppender对象

ConsoleAppender的构造方法不接受其它的参数。

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

<layout ... >

... ...

</layout>

</appender>

创建FileAppender对象 

可以为FileAppender类的构造方法传递两个参数：File表示日志文件名；Append表示如文件已存在，是否把日志追加到文件尾部，可能取值为"true"和"false"（默认）。<appender name="file.log" class="org.apache.log4j.FileAppender">

<param name="File" value="/tmp/log.txt" />

<param name="Append" value="false" />

<layout ... >

... ...

</layout>

</appender>

创建RollingFileAppender对象

除了File和Append以外，还可以为RollingFileAppender类的构造方法传递两个参数：MaxBackupIndex备份日志文件的个数（默认是1个）；MaxFileSize表示日志文件允许的最大字节数（默认是10M）。 :.

<appender

name="rollingFile.log" class="org.apache.log4j.RollingFileAppender">

<param name="File" value="/tmp/rollingLog.txt" />

<param name="Append" value="false" />

<param name="MaxBackupIndex" value="2" />

<param name="MaxFileSize" value="1024" />

<layout ... >

... ...

</layout>

</appender>

创建PatternLayout对象

可以为PatternLayout类的构造方法传递参数ConversionPattern。 :.

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

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

</layout>

 

4.Log4j的代码使用

4.1. 得到记录器

使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

public static Logger getLogger( String name)

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

4.2.读取配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：

BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。

PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。

DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

 

4.3.插入记录信息（格式化日志信息）

当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

Logger.debug ( Object message ) ;

Logger.info ( Object message ) ;

Logger.warn ( Object message ) ;

Logger.error ( Object message ) ;

4.4. 注意事项

Logger的命名规则

Logger由一个String类的名字识别，logger的名字是大小写敏感的，且名字之间具有继承的关系，子名有父名作为前缀，用点号.分隔。如：x.y是x.y.z的父亲。

 

5. Properties文件实例说明

文件内容如下：

 

1 log4j.rootCategory=INFO, stdout , R23 log4j.appender.stdout=org.apache.log4j.ConsoleAppender4 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout5 log4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m%n67 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender8 log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log9 log4j.appender.R.layout=org.apache.log4j.PatternLayout10 log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n1112 log4j.logger.com.neusoft=DEBUG13 log4j.logger.com.opensymphony.oscache=ERROR14 log4j.logger.net.sf.navigator=ERROR15 log4j.logger.org.apache.commons=ERROR16 log4j.logger.org.apache.struts=WARN17 log4j.logger.org.displaytag=ERROR18 log4j.logger.org.springframework=DEBUG19 log4j.logger.com.ibatis.db=WARN20 log4j.logger.org.apache.velocity=FATAL2122 log4j.logger.com.canoo.webtest=WARN2324 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN25 log4j.logger.org.hibernate=DEBUG26 log4j.logger.org.logicalcobwebs=WARN1 log4j.rootLogger=INFO, stdout , R

 

 

 

 

 

此句为将等级为INFO的日志信息输出到stdout和R这两个目的地，stdout和R的定义在下面的代码，可以任意起名。等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置OFF则不打出任何信息，如果配置为INFO这样只显示INFO, WARN, ERROR的log信息，而DEBUG信息不会被显示，具体讲解可参照第三部分定义配置文件中的logger。

 

3 log4j.appender.stdout=org.apache.log4j.ConsoleAppender

此句为定义名为stdout的输出端是哪种类型，可以是

org.apache.log4j.ConsoleAppender（控制台）

org.apache.log4j.FileAppender（文件）

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），

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

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

具体讲解可参照第三部分定义配置文件中的Appender。

 

4 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

此句为定义名为stdout的输出端的layout是哪种类型，可以是

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

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

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

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

具体讲解可参照第三部分定义配置文件中的Layout。

 

5 log4j.appender.stdout.layout.ConversionPattern= [QC] %p [%t] %C.%M(%L) | %m%n

如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern，打印参数如下：

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

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

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

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

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

%n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n” 

%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式

比如：%d{yyyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921

%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。

[QC]是log信息的开头，可以为任意字符，一般为项目简称。

输出的信息

[TS] DEBUG [main] AbstractBeanFactory.getBean(189) | Returning cached instance of singleton bean 'MyAutoProxy'

具体讲解可参照第三部分定义配置文件中的格式化日志信息。

7 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

此句与第3行一样。定义名为R的输出端的类型为每天产生一个日志文件。

 

8 log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log

此句为定义名为R的输出端的文件名为D:\\Tomcat 5.5\\logs\\qc.log可以自行修改。

 

9 log4j.appender.R.layout=org.apache.log4j.PatternLayout

与第4行相同。

 

10 log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

与第5行相同。

 

12 log4j.logger.com.neusoft=DEBUG

指定com.neusoft包下的所有类的等级为DEBUG。

可以把com.neusoft改为自己项目所用的包名。

 

13 log4j.logger.com.opensymphony.oscache=ERROR

14 log4j.logger.net.sf.navigator=ERROR

这两句是把这两个包下出现的错误的等级设为ERROR，如果项目中没有配置EHCache，则不需要这两句。

 

15 log4j.logger.org.apache.commons=ERROR

16 log4j.logger.org.apache.struts=WARN

这两句是struts的包。

 

17 log4j.logger.org.displaytag=ERROR

这句是displaytag的包。（QC问题列表页面所用）

 

18 log4j.logger.org.springframework=DEBUG

此句为Spring的包。

 

24 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN

25 log4j.logger.org.hibernate=DEBUG

此两句是hibernate的包。

以上这些包的设置可根据项目的实际情况而自行定制。