有关tomcat的日志文件（二）

最新推荐文章于 2024-06-18 18:09:05 发布

erdfdretds

最新推荐文章于 2024-06-18 18:09:05 发布

阅读量613

点赞数

分类专栏： tomcat 日志文章标签： log4j Log4j 日志

本文链接：https://blog.csdn.net/sunshinec123/article/details/8453597

版权

tomcat 同时被 2 个专栏收录

2 篇文章 0 订阅

订阅专栏

日志

1 篇文章 0 订阅

订阅专栏

最近在测试一个系统，才想到要弄个测试文件，可以记录控制台的输出，问了下同学，她告诉我Log4j可以有这种效果，于是跑去官网上看了一圈，发现自己真是孤陋寡闻呀。。。。对于log4j的学习笔记整理如下。

http://logging.apache.org/log4j/1.2/manual.html

一、Log4j有三个主要的组成部分：

loggers, appenders, layouts

这三部分使得开发者可以根据message的类型和等级，来记录messages，并且控制在运行期间，这些消息如何形成，并且输出到哪里去。

1. Logger hierarchy(Logger 层)

（1）Logger中的一些基本方法：

[java]view plaincopy 
   
 package org.apache.log4j;  
   
   public class Logger {  
   
     // Creation & retrieval methods:  
     public static Logger getRootLogger();  
     public static Logger getLogger(String name);  
   
     // printing methods:  
     public void trace(Object message);  
     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(Level l, Object message);  
 }  

（2）可以给Loggers制定等级。可能的等级包括：

TRACE, DEBUG, INFO, WARN, ERROR, FATAL(均定义在org.aache.log4j.Level类中)

同时也可以通过继承Level类来自定义等级，但不推荐

如果某一logger并未制定等级，那么它就继承于他最近的被指定等级的父类。

记录日志是通过调用logger实例中的一个打印的方法来实现的。

Logger的等级：DEBUG<INFO<WARN<ERROR<FATAl

E.G.:

[java]view plaincopy 
   
 // get a logger instance named "com.foo"  
    Logger  logger = Logger.getLogger("com.foo");  
   
    // Now set its level. Normally you do not need to set the  
    // level of a logger programmatically. This is usually done  
    // in configuration files.  
    logger.setLevel(Level.INFO);  
   
    Logger barlogger = Logger.getLogger("com.foo.Bar");  
   
    // This request is enabled, because WARN >= INFO.  
    logger.warn("Low fuel level.");  
   
    // This request is disabled, because DEBUG < INFO.  
    logger.debug("Starting search for nearest gas station.");  
   
    // The logger instance barlogger, named "com.foo.Bar",  
    // will inherit its level from the logger named  
    // "com.foo" Thus, the following request is enabled  
    // because INFO >= INFO.  
    barlogger.info("Located nearest gas station.");  
   
    // This request is disabled, because DEBUG < INFO.  
    barlogger.debug("Exiting gas station search");  

（3）调用getLogger方法，使用同一名字，来创建的不同实例，返回同一logger object

eg:

[java]view plaincopy 
   
 Logger x = Logger.getLogger("wombat");  
 Logger y = Logger.getLogger("wombat");  

其中，x和y指向同一logger object

2. Appenders和Layouts

（1）appenders

Log4j允许将logging请求打印到不同的目的地之中。

在log4j中，输出的目的地叫做 appender。目前，appender可以是控制台（console），文件（files）, 图形界面化组件（GUI components）, 远程socket服务器（remote socket servers）,JAVA 消息服务（JMS）,NT事件记录器（NT Event Loggers）,远程UNIX系统日志进程。并且可以异步记录。

可同时制定将一个logger输出到不同的appender中。

添加appender的方法：addAppender方法

它将一个appender添加到制定的Logger上。对于某一指定的logger，每一个可用的logging request都会被提交到这一logger的所有appender中，以及更高层次中的appenders中。也就是说，appender同logger一起继承下来。但是也可以通过“setting the additivity flag”，将additivity flag这一属性变为false，来禁止这种继承关系。

如：loggerC的输出日志，会被写入C的所有appender中，并且也会被写入C的所有父类（包括父类的父类等）中的appender中。这就是所谓的"appender additivity"。但是如果C的一个父类P，将additivity flag设为flase, 那么C的输出就直接记录在C的所有appender中，输出到C的父类（包括P）的appender中，但是不会记录在P的父类中了；additivity flag默认为true.

（2）PatternLayout

用户常常希望定义输出内容的格式=>PatternLayout

例如：

如果定义PatternLayout为格式“%r [%t] %-5p %c -%m%n”,那么输出的内容将会是：

176 [main] INFO org.foo.Bar -Located nearest gas station

176:表示自从程序启动后到输出这句话的时间差，单位为milliseconds（毫秒）

[main]：发出logging请求的线程

INFO：log描述的等级

org.foo.Bar:处理该logging请求的logger名字

Located nearest gas station: "-"后面的内容是想要输出的信息

（3）没看懂。。。

Just as importantly, log4j will render the content of the log message according to user specified criteria. For example, if you frequently need to log Oranges, an object type used in your current project, then you can register an OrangeRenderer that will be invoked whenever an orange needs to be logged.

Object rendering follows the class hierarchy. For example, assuming oranges are fruits, if you register a FruitRenderer, all fruits including oranges will be rendered by theFruitRenderer, unless of course you registered an orange specific OrangeRenderer.

Object renderers have to implement the ObjectRendererinterface.

3. 配置

配置文件可以写成XML文件或是JAVA properties文件（KEY=VALUE）中。

例子如下，

（1）MyApp:使用BasicConfigurator

[java]view plaincopy 
   
 import com.foo.Bar;  
   
 <span style="color:#ff0000;"> // Import log4j classes.</span>  
  import org.apache.log4j.Logger;  
  import org.apache.log4j.BasicConfigurator;  
   
  public class MyApp {  
   
    // Define a static logger variable so that it references the  
    // Logger instance named "MyApp".  
    <span style="color:#ff0000;">static Logger logger = Logger.getLogger(MyApp.class);</span>  
   
    public static void main(String[] args) {  
   
      // Set up a simple configuration that logs on the console.  
      BasicConfigurator.configure();  
   
      logger.info("Entering application.");  
      Bar bar = new Bar();  
      bar.doIt();  
      logger.info("Exiting application.");  
    }  
  }  

Bar:

[java]view plaincopy 
   
 package com.foo;  
  import org.apache.log4j.Logger;  
   
  public class Bar {  
    static Logger logger = Logger.getLogger(Bar.class);  
   
    public void doIt() {  
      logger.debug("Did it again!");  
    }  
  }  

控制台输出：

0 [main] INFO com.test.MyApp - Entering application.
2 [main] DEBUG com.test.Bar - Did it again!
2 [main] INFO com.test.MyApp - Exiting application.

调用BasicConfigurator.configure方法，是创建了一个相对于简单的log4j setup。这种方法直接给root logger分配了一个consoleAppender；并且输出将采用 “%-4r [%t] %-5p %c %x - %m%n"类型的patternLayout。

默认情况下，root logger被设定为Level.DEBUG

使用BasicConfigurator.configure方法，只能是输出相同的Log信息。而使用PropertyConfigurator则可以使用配置文件log4j.properties.

（2）MyApp:(Bar类并未修改)使用PropertyConfigurator

[java]view plaincopy 
   
 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]);  
     //注意此处configure里面的参数是指配置文件的名字（包括路径）  
     //若为java web工程，那么应该放在WEB-INF/classes文件夹里面  
      PropertyConfigurator.configure(.\\src\\com\\foo\\log4j.properties);  
      logger.info("Entering application.");  
      Bar bar = new Bar();  
      bar.doIt();  
      logger.info("Exiting application.");  
    }  
  }  

添加log4j.properties配置文件：

[plain]view plaincopy 
   
 # Set root logger level to DEBUG and its only appender to A1.  
 log4j.rootLogger=DEBUG, A1  
   
 # A1 is set to be a ConsoleAppender.  
 log4j.appender.A1=org.apache.log4j.ConsoleAppender  
   
 # A1 uses PatternLayout.  
 log4j.appender.A1.layout=org.apache.log4j.PatternLayout  
 log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n  

也可以改变输出格式，并且设定想要输出的log等级

[plain]view plaincopy 
   
 log4j.rootLogger=DEBUG, A1  
 log4j.appender.A1=org.apache.log4j.ConsoleAppender  
 log4j.appender.A1.layout=org.apache.log4j.PatternLayout  
   
 # Print the date in ISO 8601 format  
 log4j.appender.A1.layout.ConversionPattern=%d [%t] %-5p %c - %m%n  
   
 # Print only messages of level WARN or above in the package com.foo.  
 log4j.logger.com.foo=WARN  

（3）使用多个appender

例如：

[java]view plaincopy 
   
 log4j.rootLogger=debug, stdout, R  
   
 //两个输出目的地：stdout和R，分别指定为控制台输出（ConsoleAppender），以及文件输出（RollingFileAppender）  
 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      //这一文件example.log当大小达到100KB时，自动roll over（重新存储？）  
                         //而当roll over发生时，之前的example.log自动存储为example.log.1  
 # 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  

4、默认初始化步骤

Log4j库对于运行环境没有要求。尤其是，没有默认的log4j appender。在某些设定良好的环境中，Logger类的静态初始器将会尝试自动的配置log4j。而java语言保证这一初始器在向内存中装载类时，仅且调用一次。注意：不同的类装载器可能会装载同一类的不同copy。而这些copy在JVM下被认为是无任何关联的。

所以在有一些环境（应用的准确入口点取决于运行环境）中的默认初始化是非常重要的。例如，同一应用可悲用为单一运行的应用，作为applet，或者作为一个web server中的servlet。

准确的默认初始化算法定义如下：

（1）将log4j.defaultInitOverride参数设为除false外的任何值，将导致log4j跳过初始化

（2）将resource字符串变量设为Log4j.configuration的值。这是在设定默认初始化文件。如果log4j.configuration没有定义，那么将resource字符串变量设为默认值：default value

（3）将resource变量转化成一个URL

（4）如果resource变量无法转化成一个URL（例如有MalformedURLException），

那么调用org.apache.log4j.helpers.Loader.getResource(resource,Logger.class)，

它会从classpath中搜索resource，并返回一个URL.

Note that the string "log4j.properties" constitutes a malformed URL.

See Loader.getResource(java.lang.String) for the list of searched locations.(没懂。。。。)

（5）如果仍然无法找到URL，那么放弃默认的初始化。否则，从URL中配置Log4j

可以使用PropertyConfigurator，来解析URL，并配置log4j；若URL是xml结尾的，那么要使用到DOMConfigurator。

也可以随机定义一个configurator，使用系统参数log4j.configuratorClass来指定configurator的类名。该类必须实现Configurator接口。

5. 例子

(1)使用servlet来初始化log4j

[java]view plaincopy 
   
 <span style="font-size:18px;">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) {  
   }  
 }</span>  

(2) 在web.xml里面配置

[java]view plaincopy 
   
 <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.lcf</param-value>  
     </init-param>  
   
     <load-on-startup>1</load-on-startup>  
   </servlet>  