log4j,日志操作方法

log4j软件包下载地址:http://www.apache.org/dist/jakarta/log4j/jakarta-log4j-1.2.8.zip
   我们用System.out.println (文中称SOP,不是Service Oriented Programming,是System.out.println) 主要在三种情况下:

一、输出文本到stdout,作为输出结果;

二、显示调试信息,用来Debug;

三、显示信息,让管理员观赏

第一种情况,没得说,是SOP的老本行,不服不行。让他就继续干吧。

第二、三种情况,就不该SOP管,让他管也管不好。如果我调试用SOP来显示信息,一旦哪天我决定不要显示这些烦人的东西了,怎么办? 好办啊,一个文件一个文件找,一行一行找,把SOP给Comment起来不就完了,多方便啊。可是哪天我又要显示这些调试信息了,又怎么办? 第二天我又不要了,下个月我又要了... ... 我们程序员闲得慌吗? 可有人就是认为我们很闲,你的老板可能就是一个。我的朋友5bug是个天才,他说有办法,就是每个SOP前加一个 if 来判断是否显示。天才啊!

说起来又是一个类库,在http://logging.apache.org/site/binindex.cgi这里下载。然后就把那个log4j1.2.8.jar从"dist/lib"目录下copy到我的项目LogTest的"lib"目录下 (真烦,copy文件是很烦人的操作,需要一定的技术)。然后,我就写了个简单的class (复杂的我不会写) 来调用log4j的东东。(在文章最后是关于log4j的参数配置说明

import org.apache.log4j.*;
import org.apache.log4j.SimpleLayout;

public class testLog{

static Logger logger = Logger.getLogger(LogTest.class.getName());

public static void main(String[] args) {

PropertyConfigurator pc = new PropertyConfigurator();

pc.configure("config/log4j.properties");//(其中config是你保存log4j.properties的目录)

logger.debug("Debug ...");

logger.info("Info ...");

logger.warn("Warn ...");

logger.error("Error ...");

}

}

没什么新鲜,就是个Logger。那"static Logger logger = Logger.getLogger(LogTest.class.getName());" 就是创建一个属於LogTest类的Logger对象,创建时要告知Logger你当前的Class是什么,所以就有了"LogTest.class.getName()"这奇怪的东东。

logger.debug就是输出debug的信息

logger.info就是输出提示信息

logger.warn就是显示警告信息

logger.error就是显示错误信息

log是什么? Log是个很深奥的古希腊名词,不贬义,也不褒义。说简单了,就是"日志",就是你要写什么就写什么,要写哪里就是哪里。不同与SOP,log4j可以让你把要写的东西分成4级 (其实有更多级,你可以自己定义,比如叫: 三级++),这些级别叫优先权 (Priority),这里四个优先权就是debug, info, warn, 和error,优先权从低到高,log4j能让你控制显示哪些优先权的信息。log4j也让你要写哪就哪,可以是屏幕,可以是一个文件,甚至是一个Email,一个XML,一个Socket,等等。这些控制都在一个小文件里,叫log4j.properties (其实你可以用其它名字,这里是默认名)。这个文件在工程目录下。以下是log4j.properties的内容:

#### Use one appender to log to console

log4j.rootCategory=DEBUG, stdout

#### Appender writes to console

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern=%5p(%F:%L) - %m%n

就是说我要显示所有优先权等於和高于Debug的信息,所以上面那个Class会显示Debug ...,Info ...,Warn ...,Error ...所有信息。

"stdout"表示我定义了一个输出端,叫stdout (随便什么名字都好)。

下面的三行说,这个stdout输出端其实是标准输出Console,也就是屏幕。输出的格式是Pattern。转换方式是%5p(%F:%L) - %m%n,即前五格用来显示优先权,再显示当前的文件名,加当前的行数。最后是logger.debug()或logger.info()或logger.warn()或logger.error()里的信息。%n表示回车空行。

运行程序,最后输出的是:

DEBUG(LogTest.java:9) - Debug ...

INFO(LogTest.java:10) - Info ...

WARN(LogTest.java:11) - Warn ...

ERROR(LogTest.java:12) - Error ...

搞了半天,最后就输出这么个东西? 对啊。有人就说了,"还不如System.out.println呢"。不过你看看,你做了些什么。

一、下载了log4j,copy类库到工程的lib目录

二、写一个log4j.properties文件 (4行)

三、在Class里加了"static Logger logger = Logger.getLogger(LogTest.class.getName());"一句话

四、用logger.xxx来输出信息。

完了。你得到的若干好处是:

一、在log4j.properties文件里把"log4j.rootCategory=DEBUG, stdout"改写成"log4j.rootCategory=OFF, stdout",这样所有的log信息都不会显示了;

二、在log4j.properties文件里把"log4j.rootCategory=DEBUG, stdout"改写成"log4j.rootCategory=INFO, stdout",这样只显示INFO, WARN, ERROR的log信息,而DEBUG信息不会被显示;

三、在log4j.properties文件里把"log4j.rootCategory=DEBUG, stdout"改写成"log4j.rootCategory=DEBUG, stdout, R",再加上下面三句话:

log4j.appender.R=org.apache.log4j.RollingFileAppender

log4j.appender.R.File=log.txt

log4j.appender.R.MaxFileSize=100KB

log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.PatternLayout

log4j.appender.R.layout.ConversionPattern=%d{yyyy MMM dd HH:mm:ss} %-5p%c - %m%n

这样,你的log信息不光显示在屏幕上,而且将被保存在一个叫"log.txt"的文件里,文件最大为100KB。如果文件大小超过100KB,文件会被备份成"log.txt.1",新的"log.txt"继续记录log信息。

你可以改变log4j.properties,而不需重新编译就可以控制log信息是否显示、log信息的输出端类型、输出方式、输出格式,等等。你上面的四步工作带来这么多好处,我还要System.out.println来显示log信息吗? 不需要了。

以下是我LogTest项目的目录结构:

build.xml文件的内容:

name="Log4j Test" default="build" basedir="."> name="app.home" value="${basedir}" /> name="app.src" value="${app.home}/src" />

 

name="app.bin" value="${app.home}/bin" />

 

name="app.lib" value="${app.home}/lib" />

 

 

id="classpath">

 

dir="${app.lib}">

 

name="**/*.jar" />

 

 

 

location="${app.home}"/>

 

location="${app.bin}"/>

 

 

 

name="init">

 

dir="${app.bin}"/>

 

 

 

name="build" depends="init" description="compile the source " >

 

srcdir="${app.src}" destdir="${app.bin}">

 

refid="classpath"/>

 

 

 

 

name="run" description="run">

 

classname="LogTest" dir="${app.bin}" fork="true">

 

refid="classpath"/>

 

 

 

 

name="clean" description="clean up" >

 

dir="${app.bin}" />

 

 

总共四个文件,一个用来测试的LogTest类,一个build.xml ANT文件,一个log4j.properties配制文件,一个log4j-1.2.8.jar类库。

log4j的功能有很多,doodoofish这里就不详细介绍了,以下是参考文献:

  • Don't Use System.out.println! Use Log4j by Vipan Singla

     

     

  • Build Flexible Logs With log4j by Vikram Goyal

     

     

  • log4j by Ashley J.S Mills, University Of Birmingham

     

     

  • Add logging to your Java Applications by Kevin Brown

     

     

  • How does the Java logging API stack up against log4j? by Kevin Brown

     

     

  • OpenSymphony Logging Primer

     

    log4j的参数配置说明
     
    Log4j由三个重要的组件构成:日志信息的优先级,日志信息的输出目的地,日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、INFO、DEBUG,分别用来指定这条日志信息的重要程度;日志信息的输出目的地指定了日志将打印到控制台还是文件中;而输出格式则控制了日志信息的显示内容。

      一、定义配置文件

      其实您也可以完全不使用配置文件,而是在代码中配置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就是指B日志信息输出到哪个地方。您可以同时指定多个输出目的地。

      2.配置日志信息输出目的地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(将日志信息以流格式发送到任意指定的地方)

      3.配置日志信息的格式(布局),其语法为:

      log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
      log4j.appender.appenderName.layout.option1 = value1
      …
      log4j.appender.appenderName.layout.option = valueN

      其中,Log4j提供的layout有以e几种:
      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)

      二、在代码中使用Log4j

      1.得到记录器

      使用Log4j,第一步就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:

      public static Logger getLogger( String name)

      通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。Name一般取本类的名字,比如:

      static Logger logger = Logger.getLogger ( ServerWithLog4j.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 ) ;

  •  

    你可能感兴趣的:(java,log4j,object,String,Class,logging)