Log4j的使用

Log4j的使用

基本理论
       Log4j是一个聚集了许多作者劳动成果的开源软件项目。它允许开发人员以任意的粒度输出日志描述信息。它利用外部的配置文件，在运行时是完全可配置的。最厉害的是，log4j有一条平滑的学习曲线。
       Log4j由三个重要的组件构成：日志信息记录器(Logger)，日志信息输出目的地(Appender)和日志信息布局器(Layout)
日志信息记录器,供程序员输出日志信息;日志信息的输出目的地指定了日志将打印到控制台还是文件中等；而输出格式则控制了日志信息的显示格式。

一、 日志记录器：Logger
       Logger对象是用来取代System.out或者System.err的日志写出器，用来供程序员输出日志信息。
1、记录器层次及命名规则
       记录器按层次命名，命名规则类似于包的命名方式，大小写敏感，且名字之间具有继承的关系。例如，名称为"com.foo"的记录器是名称为"com.foo.Bar"的父。相似的有，"java"是"java.util"的父，是"java.util.Vector"的祖先。
 
2、记录器对象的获取或创建
       在记录器层次的顶端是根记录器(Root Logger)，注意两点：一是根记录器永远存在，二是不能通过名称获得。通过调用Logger类的静态方法public static Logger Logger.getRootLogger()获得根记录器，非根记录通过指定的名字(即将进行日志记录的类名)获得记录器：public static Logger Logger.getLogger(String name)或者public static Logger Logger.getLogger(Class clazz)获得（或者创建）一个named logger。后者相当于调用Logger.getLogger(clazz.getName())。
       在某对象中，用该对象所属的类为参数，调用Logger.getLogger(Class clazz)以获得logger被认为是目前所知的最理智的命名logger的方法。
       记录器logger的创建可以按照任意的顺序，即，父logger可以后于子logger被创建。log4j将自动维护logger的继承树。

3、记录器的级别
       记录器可以被设置级别，用来控制日志信息的输出。可能的级别按优先级从高到低有DEBUG, INFO, WARN, ERROR和FATAL，这些级别被定义在org.apache.log4j.Level类中。分别用来指定这条日志信息的重要程度。
       一般来讲，一个记录器应该定义一个日志记录级别，若日志请求的级别(打印方法决定一个日志请求的级别，这些打印方法是debug, info, warn, error, fatal和log) 大于或者等于日志记录器的级别，那么这个日志请求就是可行的，相反，请求将不能输出。一个没有被指定级别的日志记录器将从层次(hierarchy)中最近的父记录器继承(有指定级别则没有必要继承级别值)。为了保证所有的记录器最终可以继承一个级别，根记录器总是有一个被指定的记录器。

二、 日志信息输出目的地：Appender
       输出目的地包括：控制台、文件、GUI组件、远程套接字服务器(remote socket servers)、JMS、NT事件记录器(NT Event Loggers)和远程UNIX Syslog守护进程(remote UNIX Syslog daemons)等。它也可以异步地记录日志：
       ConsoleAppender - 目的地为控制台的Appender
       FileAppender - 目的地为文件的Appender
       RollingFileAppender - 目的地为限制大小的文件的Appender（回滚记录，可以指定备份份数）
       SocketAppender - 目的地为远程套接字的Appender
       SMTPAppender - 目的地为邮件发送服务器的Appender
       JDBCAppender - 目的地为数据库日志表的Appender
       一个日志记录器可以有多个输出目的地。可以使用Logger.addAppender(Appender app)为logger增加一个appender；可以使用Logger.removeAppender(Appender app)为logger移除一个appender。
默认情况下，logger的additive标志被设置为true，表示子logger将继承父logger的所有appenders。该选项可以被重新设置，表示子logger将不再继承父logger的appenders。
root logger拥有目标为system.out的consoleAppender，故默认情况下，所有的logger都将继承该appender。

三、 日志信息布局器：Layout
       每个appender都和一个layout相联系；layout的任务是将日志信息按用户指定的布局格式化，appender的任务是把layout格式化好的日志内容送往指定的目的地。
       Log4j提供的layout有以下几种：
              org.apache.log4j.HTMLLayout（以HTML表格形式布局），
              org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
              org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
              org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

       PatternLayout是Layout的一个子类，用来使用类似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)
 
       例如，带有"%r [%t] %-5p %c - %m%n"转换格式的PatternLayout布局器将输出和下面的内容类似。
              176 [main] INFO  org.foo.Bar - Located nearest gas station
       第一个字段"%r"是自从程序开始到目前花费的时间。第二个字段"[%t]"是发出日志请求的线程。第三个字段"%-5p"是日志语句的级别。第四个"%c"是和该日志请求关联的日志记录器的名称。紧接着"-"符号后面的"%m%n"是日志语句的输出消息并且换行。
 
四、配置：Configuration
       其实有了上面的知识，您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。
Log4j的环境是完全参数化的配置。Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用Java特性文件做为配置文件的方法：
       1. 配置根Logger，其语法为：
              log4j.rootLogger = [ level ] , appenderName, appenderName, …
       其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。
appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。

       2. 配置日志信息输出目的地Appender，其语法为
              log4j.appender.appenderName = fully.qualified.name.of.appender.class
              log4j.appender.appenderName.option1 = value1
              …
              log4j.appender.appenderName.option = valueN
 
       3. 配置日志信息的格式（布局），其语法为：
              log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
              log4j.appender.appenderName.layout.option1 = value1
              …
              log4j.appender.appenderName.layout.option = valueN
 
       一般的软件日志会将信息打印到控制台，同时输出到文件备查。即使您以后有特殊的目的地要求，也可以在不改变任何代码的情况下，仅通过修改配置文件就可以轻松地完成这项功能。先来看看一个较完整的配置文件 log4j.properties:

#### 使用两个 appenders, 一个记录日志到console,另一个到一个file
log4j. rootLogger=debug, stdout, R
# 对于您的Logger仅打印优先级高于等于 WARN 信息
log4j.logger.your.logger.name=WARN
#### 第一个appender 写到控制台 console
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
# 信息输出转换格式
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n
#### 第二个 appender 写到文件
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log
# 指定日志文件最大容量
log4j.appender.R.MaxFileSize=100KB
# 存档日志文件 (这里指定一个备份文件)
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n
 
       这个配置文件指定了两个输出源stdout和R。前者把日志信息输出到控制台，后者是一个回滚日志文件。最大的文件是100KB，当一个日志文件达到最大尺寸时，Log4J会自动把example.log重命名为example.log.1，然后重建一个新的example.log文件，依次循环记录。

应用：在代码中使用Log4J
一、通用步骤
1、获得记录器
其语法为：
public static Logger getLogger( String name)，
通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：
static Logger logger = Logger.getLogger ( TestLog4j.class.getName () ) ;
 
2、读取配置文件
当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：
BasicConfigurator.configure ()：自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。
 
3、插入日志记录语句
当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：
Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;
 
下面是个例子：
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
public class TestLog4j {
   static Logger logger = Logger.getLogger(TestLog4j.class);//First step
   public static void main(String args[]) {
      PropertyConfigurator.configure("log4j.properties");//Second step
      logger.debug("Here is some DEBUG");//Third step
      logger.info("Here is some INFO");
      logger.warn("Here is some WARN");
      logger.error("Here is some ERROR");
      logger.fatal("Here is some FATAL");
   }
}
 
二、WEB应用中使用
       在Web应用中，应该在哪儿对Log4J进行配置呢？首先要明确，Log4J必须在应用的其它代码执行前完成初始化。因为Servlet是在Web服务器启动时立即装入的，所以，在Web应用中一般使用一个专门的Servlet来完成Log4J的配置，并保证在web.xml的配置中，这个Servlet位于其它Servlet之前。下面是一个例子，代码如下：
1、初始化配置的servlet
package com.foo;
 
import org.apache.log4j.PropertyConfigurator;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.PrintWriter;
import java.io.IOException;
 
public class Log4jInit extends HttpServlet {
  public void init() {
    String prefix =  getServletContext().getRealPath("/");
    String file = getInitParameter("log4j-init-file");
    // if the log4j-init-file is not set, then no point in trying
    if(file != null) {
      PropertyConfigurator.configure(prefix+file);
    }
  }
 
  public void doGet(HttpServletRequest req, HttpServletResponse res) {
  }
}
 
2、在你的web应用程序的web.xml文件中定义下面servlet
<servlet>
    <servlet-name>log4j-init</servlet-name>
    <servlet-class>com.foo.Log4jInit</servlet-class>
    <init-param>
      <param-name>log4j-init-file</param-name>
      <param-value>WEB-INF/classes/log4j.properties</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
 
3、在需要使用log4j的地方获取Logger实例
    static Logger log = Logger.getLogger(TestLog4j.class);
注意事项
如何配置Log4j使系统每天生成一个日志文件，并且指定格式：
#log4j.properties

log4j.rootLogger=warn, A1

log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A1.file=F:/UserWorkSpace/jiangcm/Tomcat 5.0/logs/tomcat_log_
log4j.appender.A1.DatePattern=yyyy-MM-dd'.html'

原理：
Log4j的org.apache.log4j.DailyRollingFileAppender源码223行
scheduledFilename = fileName+sdf.format(new Date(file.lastModified()));
也就是说备份的日至文件都是文件名后面加上你所配的DatePattern格式化后的字符串。
生成的第一个日志文件格式如下：tomcat_log_，即只是A1.file中设置的名称；生成的第二个日志文件之后的文件命名才会加上所配的DatePattern格式化后的字符串。