CSDN博客

img doodoofish

让System.out.println回家种田

发表于2004/4/29 21:02:00  2742人阅读

分类: Java

让System.out.println回家种田,换句话说,就是该干嘛干嘛去。

您可能在想: System.out.println几乎在每个Java程序里都有那么几行,如何让他老人家回家种田呢? 我们怎么能少了这么重要的革命同志呢?

doodoofish这里要说的是"该干嘛干嘛去",不是System.out.println管的就别让他管。想想,我们用System.out.println (文中称SOP,不是Service Oriented Programming,是System.out.println) 主要在三种情况下:

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

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

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

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

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

我比较笨,比郭靖还笨。我就没想到这个法子,一直没想出来,直到上10个星期,看到一篇介绍Log4J的文章。一开始看不懂 (我比较笨) ,倒过来看一遍总算懂了。

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

import org.apache.log4j.*;

public class LogTest {

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

    public static void main(String[] args) {

        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文件的内容:

<project name="Log4j Test" default="build" basedir=".">

    <property name="app.home" value="${basedir}" />

    <property name="app.src" value="${app.home}/src" />

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

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

    <path id="classpath">

        <fileset dir="${app.lib}">

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

        </fileset>

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

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

    </path>

    <target name="init">

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

    </target>

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

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

            <classpath refid="classpath"/>

        </javac>

    </target>

    <target name="run" description="run">

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

            <classpath refid="classpath"/>

        </java>

    </target>

    <target name="clean" description="clean up" >

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

    </target>

</project>

总共四个文件,一个用来测试的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 FAQ at jGuru

     

  • 0 0

    相关博文

    我的热门文章

    img
    取 消
    img