Log4j 入门笔记.doc

详细讲解Java中log4j的使用方法
@2012/3/14 sunny

1、Log4j是什么？
Log4j可以帮助调试（有时候debug是发挥不了作 用的）和分析，要下载和了解更详细的内容，还是访问其官方网站吧： http://jakarta.apache.org/log4j .
Log4J是Apache的一个开放源代码项目(http://logging.apache.org/log4j/docs/)，它是一个日志操作包。通过使用Log4J,可以指定日志信息输出的目的地，控制每一条日志的输出格式，定义日志信息的级别。所有这些功能通过一个配置文件灵活进行配置。

2、Log4j的概念
Log4j中有三个主要的组件，它们分别是 Logger、Appender和Layout，Log4j 允许开发人员定义多个Logger，每个Logger拥有自己的名字，Logger之间通过名字来表明隶属关系。
有一个Logger称为Root，它永远存在，它是所有Logger组件的“祖先”,它永远存在，且不能通过名字检索或引用, 可以通过Logger.getRootLogger（）方法获得，其它Logger通过 Logger.getLogger（String name）方法。配置root Logger代码：
log4j.rootLogger=INFO,console
可在配置文件中方便地配置存在继承关系的Logger组件，凡是在符号“.”后面的组件都会成为在符号“.”前面的Logger组件的子类。Logger组件的继承关系：
       . 如果子类Logger组件没有定义日志级别，则将继承父类的日志级别;
       . 如果子类Logger组件定义了日志级别，就不会继承父类的日志级别;
       . 黙认情况下，子类Logger组件会继承父类所有的Appender，把它们加入到自己的Appener;
       . 如果把子类Logger组件的additivity标志设为false，那么它就不会继承父类Appender。additivity标志 默认值为false；
　　Appender则是用来指明将所有的log信息存放到什么地方，Log4j中支持多种appender，如 console、files、GUI components、NT Event Loggers等，一个Logger可以拥有多个Appender，也就是你既可以将Log信息输出到屏幕，同时存储到一个文件中。
Layout的作用是控制Log信息的输出方式，也就是格式化输出的信息。
一个Logger可以有多个Appender，也就是说日志信息可以同时输出到多个设备上，每个Appender对应一种Layout(示例见下图)。
              ↗  Appender1  →  Layout
     ／     
    Logger
     \  
              ↘  Appender2  →  Layout
Log4j中将要输出的Log信息定义了5种级别，由低到高依次为DEBUG、INFO、WARN、ERROR和FATAL，当输出时，只有级别高过配置中规定的 级别的信息才能真正的输出，这样就很方便的来配置不同情况下要输出的内容，而不需要更改代码，这点实在是方便啊。
 在写程序的时候，为了调试程序，我们会在很多出错的地方输出大量的日志信息。当程序调试完，不需要这些信息时，将程序中这些输出日志信息代码删除吗？这样费时费力，对于大型程序几乎不可行。通过对日志分级，假如不想输出WARN级别的日志信息，则Logger组件的级别调高即可，省时省心。

3、Log4j的配置文件
　　虽然可以不用配置文件，而在程序中实现配置，但这种方法在如今的系统开发中显然是不可取的，能采用配置文件的地方一定一定要用配置文件。Log4j支持两 种格式的配置文件：XML格式和Java property格式，本人更喜欢后者，首先看一个简单的例子吧，如下：

log4j.rootLogger=debug, stdout, R
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log
log4j.appender.R.MaxFileSize= 100KB

# Keep one backup file
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n
　　首先，是设置root，格式为 log4j.rootLogger=[level]，appenderName， ……，其中level就是设置需要输出信息的级别，后面是appender的输出的目的地，appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。 配置日志信息输出目的地Appender，其语法为
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
...
log4j.appender.appenderName.option = valueN
　　Log4j提供的appender有以下几种：
　　org.apache.log4j.ConsoleAppender（控制台）
　　org.apache.log4j.FileAppender（文件）
　　org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
　　org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生新文件）
　　org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
　　配置日志信息的格式（布局），其语法为：
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
....
log4j.appender.appenderName.layout.option = valueN
　　Log4j提供的layout有以下几种：
　　org.apache.log4j.HTMLLayout（以HTML表格形式布局），
　　org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
　　org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
　　org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
Log4J采用类似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）

4、Log4j在程序中的使用
　　要在自己的程序中使用Log4j，首先需要将commons-logging.jar和logging-log4j-1.2.9.jar导入到构建路径中。然后再将log4j.properties放到src根目录下。这样就可以在程序中使用log4j了。在类中使用log4j，首先声明一个静态变量 Logger logger=Logger.getLog（"classname"）；现在就可以使用了，用法如下：logger.debug（"debug message"）或者logger.info（"info message"），看下面一个小例子：
import com.foo.Bar;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
public class MyApp {
static Logger logger = Logger.getLogger(MyApp.class.getName());
public static void main(String[] args) {
// BasicConfigurator replaced with PropertyConfigurator.
PropertyConfigurator.configure(args[0]);
logger.info("Entering application.");
Bar bar = new Bar();
bar.doIt();
logger.info("Exiting application.");
}
}
Ref :
Ref:

5、Appender组件

Appender组件决定将日志信息输出到什么地方。支持以下目的地：
    . 控制台(Console);
    . 文件(File);
    . GUI组件(GUI component);
    . 套接口服务器(Remote socket server);
    . NT的事件记录器(NT Event Logger);
    . UNIX Syslog守护进程(Remote UNIX Syslog daemon);

    一个Logger可同时对应多个Appender，示例：myLogger配置二个Appender: 一个file, 一个是console：
    log4j.logger.myAppender=WARN,file,console
    log4j.appender.file=org.apache.log4j.RollingFileAppender
    log4j.appender.file.File=log.txt
log4j.apender.console=org.apache.log4j.ConsoleAppender

6、Layout组件
    Layout组件决定日志输出格式，有以下几种类型：
    . org.apache.log4j.HTMLLayout(以HTML表格形式布局);
    . org.apache.log4j.PatternLayout(可以灵活地指定布局模式);
    . org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串);
    . org.apache.log4j.TTCCLayout(包含日志产生的时间、线程和类别等信息);

    为名称为console的Appender配置SimpleLayout，代码如下：
    log4j.appender.console.layout=org.apache.log4j.SimpleLayout
    输出日志格式如下：
    WARN - This is a log message from the myLogger

    为名称为file的Appender配置PatternLayout，代码如下：
    log4j.appender.file.layout=org.apache.log4j.PatternLayout
    log4j.appender.file.layout.ConversionPattern=%t %p - %m%n
    输出日志格式如下：
    THREAD-1 WARN - This is a log message from the myLogger
    PatternLayout让开发者依照ConversionPattern定义输出格式。ConversionPattern中一些指定日志内容和格式的预定义符号说明如下：
符号         描述
    %r           自程序开始后消耗的毫秒数
    %t           表示日志记录请求生成的线程
    %p           表示日专语句的优先级
    %r           与日志请求相关的类别名称
    %c           日志信息所在的类名
    %m%n         表示日志信息的内容

7、Log4J的基本用法
    1. 定义配置文件
       Log4J支持二种配置文件格式：XML和Java属性文件(采用“键=值”形式)。以下为Java属性文件
       格式配置文件：

       . 配置Logger组件

         配置root Logger语法为：log4j.rootLogger=[priority],appenderName,appenderName,...
         配置自定义Logger组件语法为：log4j.logger.loggerName=[priority],appenderName,appenderName,...
         其中：priority为日志级别，可选值包括FATAL、ERROR、WARN、INFO、DEBUG、ALL；
appenderName指定Appender组件，可指定多个;        
       . 配置Appender组件
         配置日志信息输出目的地Appender, 语法为：
         log4j.appender.appenderName=fully.ualified.name.of.appender.class
         log4j.appender.appenderName.option1=value1
         ...
         log4j.appender.appenderName.optionN=valueN
         Log4J提供的Appender有以下几种：
         a. org.apache.log4j.ConsoleAppender(控制台);
         b. org.apache.log4j.FileAppender(文件);
         c. org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件);
         d. org.apache.log4j.RollingFileAppender(文件大小到指定尺寸产生一个新的文件);
         e. org.apache.log4j.WriteAppender(将日志信息以流格式发送到任意指定地方);
       . 配置Layout组件
         配置Layout组件语法为：
         log4j.appender.appenderName.layout=fully.ualified.name.of.appender.class
         log4j.appender.appenderName.layout.option1=value1
         ...
         log4j.appender.appenderName.layout.optionN=valueN
         下面为一配置文件示例，文件名为log4j.properties：
         ## LOGGERS ##
         #configure root logger
         log4j.rootLogger=INFO,console
         #define a logger named myLogger
         log4j.logger.myLogger=WARN
         #define a second logger that is a child to myLogger
         log4j.logger.myLogger.mySonLogger=,file
         ## APPENDERS ##
         #define an appender named console, which is set to be a ConsoleAppender
         log4j.appender.console=org.apache.log4j.ConsoleAppender
         # define an appender named file, which is set to be a RollingFileAppender
         log4j.appender.file=org.apache.log4j.FileAppender
         log4j.appender.file.File=log.txt
         ## LAYOUTS ##
         # assian a SimpleLayout to console appender
         log4j.appender.console.layout=org.apache.log4j.SimpleLayout
         # assian a PatternLayout to file appender
         log4j.appender.file.layout=org.apache.log4j.PatternLayout
         log4j.appender.file.layout.ConversionPattern=%t%p-%m%n

    2. 程序中使用Log4j
       . 获得日志记录器：
         获得rootLogger：Logger rootLogger=Logger.getRootLogger();
         获得自定义Logger：Logger myLogger = Logger.getLogger("log4j.logger.myLogger");
       . 读取日志记录器，配置Log4J环境;
         a. BasicConfigurator.configure(): 自动快速地使用默认Log4J环境;
         b. Property.configurator.configure(String configFilename): 读取使用Java属性格式的配置文件并配置Log4J环境；
         c. DOMConfigurator.configure(String filename): 读取XML形式的配置文件并配置LOG4J环境;
       . 输出日志信息;
         在程序代码中需要生成日志的地方，调用Logger的各种输出日志方法输出不同级别的日志，例如：

         myLogger.debug("Thie is a log message from the " + myLogger.getName());
         下面为一使用Log4J的程序，程序名为Test.java：
java 代码
1.  import org.apache.log4j.Logger;   
2.  import org.apache.log4j.PropertyConfigurator;   
3.     
4.  public class Test {   
5.   
6.    public static void main(String[] args) {   
7.      //Get an instance of the myLogger   
8.      Logger myLogger = Logger.getLogger("myLogger");   
9.       
10.      //Get an instance of the childLogger   
11.      Logger mySonLogger = Logger.getLogger("myLogger.mySonLogger");   
12.      //Load the proerties using the PropertyConfigurator   
13.      PropertyConfigurator.configure("log4j.properties");   
14.   
15.      //Log Messages using the Parent Logger   
16.      myLogger.debug("Thie is a log message from the " + myLogger.getName());   
17.      myLogger.info("Thie is a log message from the " + myLogger.getName());   
18.      myLogger.warn("Thie is a log message from the " +  myLogger.getName());   
19.      myLogger.error("Thie is a log message from the " + myLogger.getName());   
20.      myLogger.fatal("Thie is a log message from the " + myLogger.getName());   
21.   
22.      mySonLogger.debug("Thie is a log message from the " + mySonLogger.getName());   
23.      mySonLogger.info("Thie is a log message from the " + mySonLogger.getName());   
24.      mySonLogger.warn("Thie is a log message from the " +  mySonLogger.getName());   
25.      mySonLogger.error("Thie is a log message from the " + mySonLogger.getName());   
26.      mySonLogger.fatal("Thie is a log message from the " + mySonLogger.getName());   
27.    }   
28. }   
        程序运行结果为:
        WARN - Thie is a log message from the myLogger
        ERROR - Thie is a log message from the myLogger
        FATAL - Thie is a log message from the myLogger
        WARN - Thie is a log message from the myLogger.mySonLogger
        ERROR - Thie is a log message from the myLogger.mySonLogger
        FATAL - Thie is a log message from the myLogger.mySonLogger
        另在Test.class所在的目录下看到一个log.txt文件，内容如下：
        WARN - Thie is a log message from the myLogger.mySonLogger
        ERROR - Thie is a log message from the myLogger.mySonLogger
        FATAL - Thie is a log message from the myLogger.mySonLogger
        如将配置文件log4j.properties中语句
 log4j.logger.myLogger.mySonLogger=,file
 改为
 log4j.logger.myLogger.mySonLogger=,file,console
 再次运行程序，结果如下：
        WARN - Thie is a log message from the myLogger
        ERROR - Thie is a log message from the myLogger
        FATAL - Thie is a log message from the myLogger
        WARN - Thie is a log message from the myLogger.mySonLogger
        WARN - Thie is a log message from the myLogger.mySonLogger
        ERROR - Thie is a log message from the myLogger.mySonLogger
        ERROR - Thie is a log message from the myLogger.mySonLogger
        FATAL - Thie is a log message from the myLogger.mySonLogger         
        FATAL - Thie is a log message from the myLogger.mySonLogger
        mySonLogger的日志在控制台上输出了二次，这是因为mySonLogger继承了父类console Appender，
        本身又定义了一个console Appender, 因而有二个console Appender。
六、在web应用中使用Log4J
    创建一个Servlet，在它初始化方法中读取Log4J配置文件并配置Log4J环境，这个Servlet在Web应用启
    动时候被加载和初始化，然后就可在其它Web组件中获取Logger对象并输出日志。
    1. 创建用于配置Log4J环境的Servlet
java 代码
1. import javax.servlet.*;   
2. import javax.servlet.http.*;   
3. import java.io.*;   
4. import java.util.*;   
5.   
6. import org.apache.log4j.PropertyConfigurator;   
7.   
8. public class Log4JServlet extends HttpServlet {   
9.       public void init() throws ServletException {   
10.            String path = getServletContext().getRealPath("/");   
11.            //getInitParameter("propfile")方法从web.xml文件中读取Log4J配置文件的名字"profile"。   
12.            String propfile = path + getInitParameter("propfile");   
13.            PropertyConfigurator.configure(propfile);   
14.       }   
15. }   
16.   
      该Servlet在web.xml中的配置如下：
xml 代码
1. <servlet>  
2.   <servlet-name>log4jServlet</servlet-name>  
3.   <servlet-class>Log4JServlet</servlet-class>  
4.   <init-param>  
5.     <param-name>propfile</param-name>  
6.     <param-value>/WEB-INF/log4j.properties</param-value>  
7.   </init-param>  
8.   <load-on-startup>1</load-on-startup>  
9. </servlet>  
2. 在login.jsp中输出日志
       <%@page import="org.apache.log4j.Logger"%>
       <html>
         <head>
           <title>login</title>
         </head>
         <body>
           <%
             Logger myLogger = Logger.getLogger("myLogger");
             Logger mySonLogger = Logger.getLogger("myLogger.mySonLogger");
             myLogger.debug("Thie is a log message from the " + myLogger.getName());
             myLogger.info("Thie is a log message from the " + myLogger.getName());
             myLogger.warn("Thie is a log message from the " +  myLogger.getName());
             myLogger.error("Thie is a log message from the " + myLogger.getName());
             myLogger.fatal("Thie is a log message from the " + myLogger.getName());
             mySonLogger.debug("Thie is a log message from the " + mySonLogger.getName());
             mySonLogger.info("Thie is a log message from the " + mySonLogger.getName());
             mySonLogger.warn("Thie is a log message from the " +  mySonLogger.getName());
             mySonLogger.error("Thie is a log message from the " + mySonLogger.getName());
             mySonLogger.fatal("Thie is a log message from the " + mySonLogger.getName());
           %>
           <br>
             <form name="loginForm" method="post" action="dispatcher">
             username: <input type="text" name="username">
             <br>
             password: <input type="text" name="password">
             <br>
             <input type="submit" name="submit" value="submit">
           </form>
         </body>
       </html>