log4j的使用与详细分析

一、什么是log4j?  http://logging.apache.org/log4j/（官方网站）

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

二、为什么使用log4j?

1、java中System.out.println(message) 太长，每次输入太麻烦，用log4j可以log.debug(message)，相对比较短
2、信息输出来源不确定，由于有太多的System.out.println()来自不同的class和方法，有时候都不知道这些"FlagMsg"是哪里来的，只好用"classA", "methodB"来区分，用了log4j，每个消息会自动附上发生的时间和来源，便于区分，比如，在你的class里面用log.info("I am form here") 便产生如下log:
[2011-08-04 20:34:42,828] INFO  testpkg.pkg1.TestLog run() – I am from here
3、自动添加/删除调试信息：开发的时候需要调试信息，安装到运行环境中又要删除部分调试信息（这可是体力活），一旦出错进行后期维护又需要调试信息了，可是这些调试信息已经从源代码中删掉了，又要再加，再删除，如此往复。有了log4j，所有信息分为不同级别，DEBUG<INFO<WARN<ERROR<FATAL 开发/调试时候需要DEBUG以上的信息，正式运行环境中需要INFO以上的信息，通过更改配置文件即可随时调整，无须再删除/添加了。
4、多日志目标。有条信息，即想要输出到屏幕，又想要写文件，还要发送邮件（比如严重的系统错误），在程序中，仍然是一句log.error(msg)搞定，至于log发送到什么地方，全由配置文件来决定，开发者不要关心文件如何写，邮件如何发的问题，留给log4j去解决把。
5、超强的免维护rolling file的log功能，如果开发个服务器应用，有什么问题往log里面写，万一几个月忘了清理log文件，弄不好log把硬盘撑满了。log4j提供超强的rolling file，可以指定log文件为 xxx.log ，大小500k，循环5个，如果超过了这个大小，则自动变成xxx.log.1 xxx.log.2 ... xxx.log.5 最老的log文件就自动删除，永远也不要担心log文件把硬盘撑爆了。
（以上理由同样适用于java se 1.4以上自带的logging）
6、用户众多，性能超群，数量众多的应用服务器比如jboss, springframework等等都使用了log4j，再次证明了它的价值。
7、apache logging还提供了log4net， log4cxx等，大部分功能都与log4j兼容如果你使用多种语言开发，可以因此受益。省去每种语言都学习一套类库。

 

三、如何使用log4j?

1、  在官网上下载到dom4j-1.2.X.jar包，并将其加入到项目project的lib下。

2、在project的src目录下建立一个名字为log4j.properties的配置文件：

、  根据自己需要配置属性（下面会详细介绍配置信息内容） 

4 、在需要输出日志的类中加入相关的代码：

   

定义属性：

 static Logger logger = Logger.getLogger(PointDipatchTest.class.getName());

    在相应的方法中用如下代码代替system.out.println(“message”)：

  if(logger.isInfoEnabled())
		    logger.info(message);
  } 

  

至此，四步完成对log4j的配置与使用！

四、log4j.properties配置文件中各属性揭秘：

1、 log4j.rootCategory=INFO, stdout , R

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

2、 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。

 

3、 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。

 

4、 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平台为“rn”，Unix平台为“n” %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921 %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。 [QC]是log信息的开头，可以为任意字符，一般为项目简称。

 

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

 

5、 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

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

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

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

7、 log4j.appender.R.layout=org.apache.log4j.PatternLayout与第4行相同。

8、 log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n 与第5行相同。

9、 log4j.logger.com. neusoft =DEBUG

指定com.neusoft包下的所有类的等级为DEBUG。可以把com.neusoft改为自己项目所用的包名。

10、 log4j.logger.com.opensymphony.oscache=ERROR

11、 log4j.logger.net.sf.navigator=ERROR

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

12、log4j.logger.org.apache.commons=ERROR

13、 log4j.logger.org.apache.struts=WARN

这两句是struts的包。

14、 log4j.logger.org.displaytag=ERROR

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

15、 log4j.logger.org.springframework=DEBUG

　此句为Spring的包。

16、 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN

17、 log4j.logger.org.hibernate=DEBUG

此两句是hibernate的包。

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

 

五、log4j的详细组成：

 

--Log4J组件的超

  Log4J提供了一个root Logger，它是所有Logger组件的“祖先”,它永远存在，且不能通过名字检索或引用，通过Logger.getRootLogger()方法取得它。配置root Logger代码： log4j.rootLogger=INFO,console

 

 

 

--LOG4J组件的继承性
可在配置文件中方便地配置存在继承关系的Logger组件，凡是在符号“.”后面的组件都会成为在符号“.”前面的Logger组件的子类。例如： log4j.apache.myLogger=WARN log4j.apache.myLogger.mySonLogger=,file

 

 

 Logger继承关系示例图
  root Logger: 日志级别=INFO  appender清单=console
  myLogger: 日志级别=WARN     appender清单=null
  mySonLogger: 日志级别=null  appender清单=file

 这三个Logger组件实际日志级别和Appender如下表：
  Logger组件          日志级别          Appender清单
  root Logger          INFO             console
  myLogger           WARN             console(继承)
  mySonLogger          WARN(继承)           file，console(继承

--LOG4J主要由三大组件组成：

  三大组件定义配置文件

  Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件log4j.properties（键=值）
1、记录器(Logger):决定什么日志信息应该被输出、什么日志信息应该被忽略；

  Logger组件是LOG4J的核心组件，它代表了Log4J的日志记录器，它能够对日志信息进行分类筛选。它由org.apache.log4j.Logger类实现
Logger组件提供的方法： package org.apache.log4j; public class Logger { // Creation & retrieval methods: public static Logger getRootLogger(); public static Logger getLogger(String name); // printing methods: public void debug(Object message); public void info(Object message); public void warn(Object message); public void error(Object message); public void fatal(Object message); // generic printing method public void log(Priority p, Object message); }

 

在配置文件中配置Logger组件：可在Log4J配置文件中配置自己的Logger组件，示例： log4j.logger.myLogger=WARN

 

 

  以上代码定义了一个Logger组件，名称为myLogger，日志级别为WARN 

 2、存放器(Appender): 指定日志信息应该输出到什么地方, 这些地方可以是控制台、文件、网络设备
3、布局管理器(Layout): 指定日志信息的输出格式

组件之间的关系：
 一个Logger可以有多个Appender，也就是说日志信息可以同时输出到多个设备上，每个Appender对应一种Layout

　1、配置根Logger

　Logger 负责处理日志记录的大部分操作。

　其语法为：

　log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，只有等于及高于这个级别的才进行处理，则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL:打印所有的日志，OFF：关闭所有的日志输出。 appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。

  

2、配置日志信息输出目的地 Appender

Appender 负责控制日志记录操作的输出。

　其语法为：这里的appenderName为在上面提到的，可任意起名。

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

 

　其中，Log4j提供的appender有以下几种：例如：log4j.appender.stdout=org.apache.log4j.ConsoleAppender

org.apache.log4j.ConsoleAppender（控制台）， org.apache.log4j.FileAppender（文件）， org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）， org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），可通过log4j.appender.R.MaxFileSize=100KB设置文件大小，还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。 org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

 

　定义一个名为stdout的输出目的地，ConsoleAppender为控制台。

3、配置日志信息的格式（布局）Layout

　Layout 负责格式化Appender的输出。

　其语法为：

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

 

　其中，Log4j提供的layout有以下几种：  格式化日志信息

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

 

 

  Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：日志级别
    记录器还有一个重要的属性，就是级别。（就象一个家庭中，成员间存在辈份关系，但不同的成员的身高可能不一样，且身高与辈份无关）程序员可以给不同的记录器赋以不同的级别，如果某个成员没有被明确值，就自动继承最近的一个有级别长辈的级别值。根记录器总有级别值。

 日志级别种类一共有五种，级别由高到低依次是：fatal、error、warn、info、debug。获得Logger

实例后，我们可调用以下方法之一输出日志信息：

 

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

 

 

注意：以上方法只有当它的级别大于或等于Logger组件配置的日志级别时才调用。以前面我们配置的myLogger为例，它的日志级别为WARN, 那么在程序中，它的warn()、error()、fatal()方法会被执行。对于log()方法，只有当它的参数Priority指定的日志级别大于或等于WARN时，它才会被执行。

  为什么需要对日志进行分级？
    在写程序的时候，为了调试程序，我们会在很多出错的地方输出大量的日志信息。当程序调试完，不需要这些信息时，将程序中这些输出日志信息代码删除吗？这样费时费力，对于大型程序几乎不可行。通过对日志分级，假如不想输出WARN级别的日志信息，则Logger组件的级别调高即可，省时省心。

 

Tips:

如果你用eclipse，有个免费的插件叫做log4e，可以自动帮你生成if(logger.isDebugEnabled()) {}这些代码，自动生成private static final Logger logger = org.apache.log4j.Logger.getLogger(本类名字.class);的定义，而且可以自动帮你把文件里的System.out.println()都替换成logger.debug()，减少你自己手写的部分，还是很方便的。