`

Log4J使用完全手册(转)

log4jApacheServletWebXML 
阅读更多

Log4J是Apache的一个开放源代码项目(http://logging.apache.org/log4j/docs/)，它是一个日志操作包。通过使用Log4J,可以指定日志信息输出的目的地，控制每一条日志的输出格式，定义日志信息的级别。所有这些功能通过一个配置文件灵活进行配置。

一、LOG4J组成

    LOG4J主要由三大组件组成：
    . Logger: 决定什么日志信息应该被输出、什么日志信息应该被忽略；
    . Appender: 指定日志信息应该输出到什么地方, 这些地方可以是控制台、文件、网络设备；
    . Layout: 指定日志信息的输出格式；

    一个Logger可以有多个Appender，也就是说日志信息可以同时输出到多个设备上，每个Appender对应
    一种Layout(示例见下图)。

              ↗  Appender1  →  Layout
     ／     
    Logger
     ﹨  
              ↘  Appender2  →  Layout


二、Logger组件

    1. Logger组件提供的方法：

       Logger组件是LOG4J的核心组件，它代表了Log4J的日志记录器，它能够对日志信息进行分类筛选。它由org.apache.log4j.Logger类实现，提供了如下方法：

 

java 代码
  1. package org.apache.log4j;   
  2.   
  3. public class Logger {   
  4.   
  5.            // Creation & retrieval methods:   
  6.            public static Logger getRootLogger();   
  7.            public static Logger getLogger(String name);   
  8.   
  9.            // printing methods:   
  10.            public void debug(Object message);   
  11.            public void info(Object message);   
  12.            public void warn(Object message);   
  13.            public void error(Object message);   
  14.            public void fatal(Object message);   
  15.       
  16.            // generic printing method:   
  17.            public void log(Priority p, Object message);   
  18. }   

    2. 在配置文件中配置Logger组件

       可在Log4J配置文件中配置自己的Logger组件，示例：

       log4j.logger.myLogger=WARN

       以上代码定义了一个Logger组件，名称为myLogger，日志级别为WARN。
  
    3. 日志级别种类：

       一共有五种，级别由高到低依次是：fatal、error、warn、info、debug。获得Logger实例后，我们可调用以下方法之一输出日志信息：

       public void debug(Object message);          //输出debug级别的日志信息；
       public void info(Object message);           //输出info级别的日志信息；
       public void warn(Object message);           //输出warn级别的日志信息；
       public void error(Object message);          //输出error级别的日志信息；
       public void fatal(Object message);          //输出fatal级别的日志信息；
       public void log(Priority p, Object message);//输出参数Priority指定级别的日志信息；

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

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

    5. Logger组件的继承性

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

       log4j.rootLogger=INFO,console

       可在配置文件中方便地配置存在继承关系的Logger组件，凡是在符号“.”后面的组件都会成为在符号“.”前面的Logger组件的子类。例如：

       log4j.apache.myLogger=WARN
       log4j.apache.myLogger.mySonLogger=,file

       以上代码中, mySonLogger是myLogger的子类Logger组件。Logger组件的继承关系：
       . 如果子类Logger组件没有定义日志级别，则将继承父类的日志级别;
       . 如果子类Logger组件定义了日志级别，就不会继承父类的日志级别;
       . 黙认情况下，子类Logger组件会继承父类所有的Appender，把它们加入到自己的Appener;
       . 如果把子类Logger组件的additivity标志设为false，那么它就不会继承父类Appender。additivity标志 默认值为false；

       以上配置的三个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(继承)
       
三、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

四、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         表示日志信息的内容

五、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></
    分享到：
    | Openfire插件开发人员指南
    评论
    发表评论

    您还没有登录,请您登录后再发表评论

相关推荐

    Log4J使用完全手册

    Log4J是一个广泛使用的日志记录框架，源自Apache开源组织，它允许开发者在应用程序中方便地管理和记录日志信息。Log4J的核心组件包括Logger、Appender和Layout，这三个部分协同工作，使得日志管理变得灵活且高效。 ...

    Log4J完全使用手册

    ### Log4J完全使用手册 #### 一、Log4J简介与重要性 Log4J是一种广泛应用于Java应用程序中的日志记录工具。它为开发者提供了一种方便且强大的方式来控制程序的日志输出，这对于软件开发过程中的调试、错误追踪以及...

    【转】log4j使用完全手册

    《log4j使用完全手册》是一本详细的指南，旨在帮助开发者深入理解和有效利用log4j这一广泛使用的日志记录框架。log4j是Apache软件基金会的一个项目，它为Java应用程序提供了一个灵活的日志系统，允许开发者调整日志...

    log4j使用完全手册.rar

    《log4j使用完全手册》是一份详细的指南，专为Java EE项目的日志记录提供解决方案。日志在软件开发中扮演着至关重要的角色，它帮助开发者追踪程序运行状态，定位错误，以及进行性能分析。而Log4j作为Java平台上的一...

    log4j使用完全手册

    ### log4j使用完全手册 #### 一、Log4j简介与基本概念 Log4j是Apache的一个开源项目，用于实现日志记录功能。通过它，开发者可以方便地控制日志输出的位置、格式以及级别等。Log4j的核心组件包括Logger、Appender...

    Log4j完全手册WORD版

    《Log4j完全手册》是Java开发者不可或缺的...总的来说，《Log4j完全手册》是Java开发者理解和应用Log4j的权威指南，涵盖了Log4j的核心概念、配置、API使用以及最佳实践，对于优化日志管理和提升开发效率有着重要作用。

    log4j完全手册

    《Log4j完全手册》是一本详尽阐述Log4j日志框架的指南，它针对Java开发者，提供了全面的配置信息和深入的参数解析。Log4j是Apache软件基金会的一个项目，是Java平台上广泛使用的日志记录工具，因其灵活性、可配置性...

    log4j完全参考手册

    ### log4j完全参考手册知识点概述 #### 一、log4j概况介绍 **log4j**是一款由Apache Software Foundation开发的开源日志组件，它能够帮助开发者在应用程序中记录日志信息。作为一款功能强大的日志框架，log4j支持...

    log4j-users-guide 用户手册

    ### Log4j 2.0 用户手册：详细解析 #### 1.1 欢迎使用 Log4j 2! ##### 1.1.1 引言 几乎每一个大型应用程序都包含自己的日志记录或追踪 API。根据这一规则，E.U.SEMPER 项目在早期决定开发自己的追踪 API。这是在 ...

    Log4j2手册阅读随笔(Log4j2新特性)

    Apache Log4j2 是一个广泛使用的Java日志...通过这些内容，手册为开发者提供了使用Log4j2进行全面的日志管理所需要的知识。无论是初学者还是有经验的开发者，都能够从中获取到对Log4j2深入了解和运用所需的丰富信息。

    [Online]log4j_The_Complete_Manual.zip

    《log4j完全手册》是Java开发者不可或缺的参考资料，它深入介绍了如何在Java应用程序中使用log4j这一广泛使用的日志记录框架。log4j是Apache软件基金会开发的一个开源项目，旨在提供灵活且高效的日志记录解决方案。...

    收藏Log4j文档

    《Log4j完全手册》是Java开发者不可或缺的参考资料，它由Ceki Gülcü编写，是Log4j框架的权威指南。Log4j是Apache软件基金会的一个开源项目，主要用于日志记录，它提供了灵活的日志配置，使得开发者可以方便地控制...

    log4j the complete manual

    《log4j完全手册》是Java开发者不可或缺的参考资料，它详细介绍了如何在Java应用程序中使用log4j这一广泛使用的日志记录框架。log4j是由Apache软件基金会开发的一个开源项目，旨在提供灵活、高效和可扩展的日志记录...

    log4c开发手册

    Log4C的设计灵感来源于Java平台上的Apache Log4J项目，但其完全采用C语言编写，以满足那些希望在资源受限或不支持虚拟机的系统上使用高效日志功能的需求。该库的核心特性包括： - **动态配置**：Log4C支持通过外部...

    Slf4j-1.5.8

    7. **文档和示例**：压缩包可能还包括用户手册、API文档以及演示如何使用SLF4J的示例代码，这对于学习和理解SLF4J的工作原理非常有帮助。 在实际应用中，SLF4J的使用通常包括以下步骤： 1. 引入slf4j-api.jar依赖...

    JSP 数据库系统开发完全手册

    通过Apache Log4j或其他日志系统收集服务器日志，提取出访问量、停留时间、来源等信息，再用SQL查询对数据进行统计和分析。 4. **邮件群发**: 邮件群发功能需要整合JavaMail API，该API允许开发者发送邮件、设置...

    书本源码--JavaWeb 实战开发完全学习手册

    Java Web实战开发完全学习手册》共分15章，全面系统地介绍了JavaWeb相关的知识，主要包括JavaWeb开发基础、HTML与CSS网页开发基础、JavaScript基础、JSP基本语法、JSP隐式对象、JDBC技术应用、Servlet技术应用、...

Magicbox
Global site tag (gtag.js) - Google Analytics