`
Jameswsz
  • 浏览: 160091 次
  • 性别: Icon_minigender_1
  • 来自: 广州
社区版块
存档分类
最新评论

Log4J的使用

log4jApacheServletWeb应用服务器 
阅读更多

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 代码
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);   
}   

    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 代码
import org.apache.log4j.Logger;   
import org.apache.log4j.PropertyConfigurator;   
    
public class Test {   
  
   public static void main(String[] args) {   
     //Get an instance of the myLogger   
     Logger myLogger = Logger.getLogger("myLogger");   
      
     //Get an instance of the childLogger   
     Logger mySonLogger = Logger.getLogger("myLogger.mySonLogger");   
     //Load the proerties using the PropertyConfigurator   
     PropertyConfigurator.configure("log4j.properties");   
  
     //Log Messages using the Parent Logger   
     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());   
   }   
}   

        程序运行结果为:

        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 代码
import javax.servlet.*;   
import javax.servlet.http.*;   
import java.io.*;   
import java.util.*;   
  
import org.apache.log4j.PropertyConfigurator;   
  
public class Log4JServlet extends HttpServlet {   
      public void init() throws ServletException {   
           String path = getServletContext().getRealPath("/");   
           //getInitParameter("propfile")方法从web.xml文件中读取Log4J配置文件的名字"profile"。   
           String propfile = path + getInitParameter("propfile");   
           PropertyConfigurator.configure(propfile);   
      }   
}   
  

      该Servlet在web.xml中的配置如下：


xml 代码
<servlet>  
  <servlet-name>log4jServlet</servlet-name>  
  <servlet-class>Log4JServlet</servlet-class>  
  <init-param>  
    <param-name>propfile</param-name>  
    <param-value>/WEB-INF/log4j.properties</param-value>  
  </init-param>  
  <load-on-startup>1</load-on-startup>  
</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>
              
    3. 发布运行使用Log4J的web应用
       1) 将Log4J的JAR文件拷贝至目录：<WEB应用所在目录>/WEB-INF/lib
       2) 创建Log4J的配置文件log4j.properties, 存放目录为：<WEB应用所在目录>/WEB-INF。内容同前面配置文件示例。
       3) 编译Log4JServlet, 存放至目录： <WEB应用所在目录>/WEB-INF/classes
       4) 修改web.xml文件，加入以下内容：


xml 代码
<servlet>  
  <servlet-name>log4jServlet</servlet-name>  
  <servlet-class>Log4JServlet</servlet-class>  
  <init-param>  
    <param-name>profile</param-name>  
    <param-value>/WEB-INF/log4j.properties</param-value>  
  </init-param>  
  <load-on-startup>1</load-on-startup>  
</servlet>  


       5) 启动服务器，访问login.jsp页面，在服务器控制台上看到如下日志：
          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

          另在<WEB应用所在目录>/WEB-INF目录下看到一个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

分享到：
| MMC不能打开文件SQL Server Enterprise Ma ...
评论
发表评论

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

相关推荐

    log4j使用教程(详解)

    Log4j是一款广泛使用的开源日志框架，由Apache软件基金会开发。本文将深入探讨Log4j的基本概念、配置与使用方法。 1. **什么是Log4j** Log4j是一个基于Java的日志记录工具，它提供了灵活的控制来记录日志信息，...

    log4j使用详解 j2EE

    #### 四、在代码中使用Log4j 要在代码中使用Log4j，首先需要获取一个Logger实例。 - **语法**：`public static Logger getLogger(String name)` - **示例**： ```java import org.apache.log4j.Logger; ...

    Log4j使用实例

    ### Log4j 使用实例详解 #### 一、Log4j简介 Log4j 是一个开源的日志记录框架，由 Apache 软件基金会提供。它允许开发者根据需求配置日志等级，并灵活选择日志信息的输出方式。Log4j 的核心组件包括 Logger、...

    log4j使用详细方法

    **日志框架Log4j详解** Log4j是Apache组织提供的一款开源的日志记录工具，广泛应用于Java开发中。...通过阅读提供的"log4j使用方法"文档，你将能更深入地了解Log4j的配置和使用技巧，为你的开发工作带来便利。

    log4j使用详解log4j使用详解

    ### Log4j 使用详解 #### 一、Log4j简介 Log4j 是 Apache 的一个开源项目，通过使用 Log4j，开发者能够控制日志信息的输出等级及去向，从而更加灵活地处理日志信息。它具有强大的功能，简单的配置，并且能够支持...

    log4j使用笔记

    #### 四、log4j 配置详解 1. **配置文件**： - `log4j.properties` 或 `log4j.xml` 文件用于定义 log4j 的配置规则。 - 配置文件通常放置在项目的根目录或者类路径下。 - 如果未指定配置文件的位置，则 log4j 会...

    log4j.rar log4j使用方法

    标题“log4j.rar log4j使用方法”暗示了我们要讨论的是一个关于log4j日志框架的压缩包文件，其中包含了如何使用log4j的指导资料。log4j是Java编程语言中广泛使用的开源日志记录工具，它允许开发者灵活地控制日志信息...

    log4j使用配置方法及项目中的应用

    ### log4j使用配置方法及项目中的应用 #### 概述与背景 在软件开发过程中，日志记录是一项至关重要的任务，它不仅帮助开发者监控代码执行状态，还为后续的故障排查、性能优化和安全审计提供了关键信息。传统的做法...

    log4j使用简介.txt

    ### log4j 使用简介 #### 一、Log4j 概述 Log4j 是一个由 Apache 提供的开源项目，专门用于实现日志记录功能。它为开发者提供了灵活的日志记录方式，允许通过多种不同的格式来记录每一条日志信息，并且能够将这些...

    Log4j使用手册

    以下是Log4j的核心组成部分、使用方法以及日志分级的详细解释。 1. **LOG4J组成**： - **Logger**：是Log4j的核心，负责决定哪些日志信息应该被记录和哪些应该被忽略。它根据预定义的级别来过滤日志，由`org....

    Log4j使用教程

    ### 四、使用Log4j 在Java代码中，我们可以使用以下方式调用Log4j记录日志： ```java import org.apache.log4j.Logger; public class MyClass { private static final Logger logger = Logger.getLogger(MyClass...

    apache log4j使用大全

    Apache Log4j 是一个广泛使用的开源日志框架，它为Java应用程序提供了强大的日志记录功能。Log4j 的主要优点在于它的灵活性和可配置性，允许开发者根据需要调整日志的输出目的地、格式以及级别。 **配置Log4j** ...

    log4j使用实例.zip

    这个"log4j使用实例.zip"压缩包包含了关于如何在Java项目中配置和使用Log4j的示例代码，非常适合Java后端初学者学习。 首先，Log4j的核心组件包括Logger、Appender和Layout。Logger是日志信息的生产者，负责生成...

    log4j使用手册和API chm格式

    "Log4j使用手册和API"则明确指出了文档的核心内容，Log4j是一个广泛使用的Java日志库，它的API提供了丰富的日志记录功能，包括不同级别的日志输出（如DEBUG, INFO, WARN, ERROR等）、自定义日志格式、日志分发等。...

    Java Log4j使用详解

    #### 四、使用Log4j ##### 4.1 概述 Log4j是另一个非常流行的Java日志框架，由Apache基金会维护。它比JCL更加强大，支持更多的特性，比如多级日志记录、动态日志文件配置等。Log4j的核心优势在于其灵活性和强大的...

    log4j使用总结

    Log4j 建议只使用四个级别，优先级从高到低分别是 ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。 在配置文件中，我们可以定义多个日志信息输出目的地，例如...

    log4j 使用介绍

    【log4j 使用介绍】 log4j 是一个广泛使用的 Java 日志框架，它提供了一种高效、灵活的方式来记录应用程序中的事件。这篇介绍旨在帮助初学者理解 log4j 的核心概念和使用方法。 **1. 简介** 日志记录在软件开发中...

    最详细的Log4j使用教程

    Log4j是一个广泛使用的Java日志框架，由ApacheJakarta项目开发。它为开发者提供了灵活且功能丰富的日志记录机制，使应用程序中的日志管理变得简单。本教程将深入介绍如何使用Log4j进行日志记录，包括配置、基本用法...

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