Log4j除了可以记录程序运行日志信息外还有一重要的功能就是用来 显示调试信息。程序员经常会遇到脱离java ide环境调试程序的情况，这时大多数人会选择使用System.out.println语句输出某个变量值的方法进行调试。这样会带来一个非常麻烦的问题：一旦哪天程序员决定不要显示这些System.out.println的东西了就只能一行行的把这些垃圾语句注释掉。若哪天又需调试变量值，则只能再一行行去掉这些注释恢复System.out.println语句。使用log4j可以很好的处理类似情况。

log4j使用方法

下面介绍的是log4j一些理论方面的知识，读者觉得枯燥的话可以跳过本节直接阅读第三节实例部分。

　　1、定义配置文件

　  首先使用配置文件将使我们的应用程序更加灵活配置log日志输出方式包括输出优先级、输出目的地、输出格式。Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件log4j.properties（键=值）。下面将介绍使用log4j.properties文件作为配置文件的方法：

　　 ① 配置根Logger，其语法为：0

　　log4j.rootLogger = [ level ] , appenderName, appenderName, …

　　其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。 appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。

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

　 ③ 配置日志信息的格式（布局），其语法为：

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

　　其中， Log4j提供的layout有以下几种：
　　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)

　　2、在代码中使用Log4j

　　 ① 得到记录器

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

　　public static Logger getLogger( String name)

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

　　static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

　　 ② 读取配置文件

　　当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：

BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。
　　PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。

例：PropertyConfigurator.configure (".\\src\\log4j.properties")
　　DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

　　 ③ 插入记录信息（格式化日志信息）

　　当上两个必要步骤执行完毕，就可轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

　　 Logger.debug ( Object message ) ;
　　Logger.info ( Object message ) ;
　　Logger.warn ( Object message ) ;
　　Logger.error ( Object message ) ;

log4j范例程序

下面将使用一个最简单的范例程序来进一步说明log4j的使用方法。程序代码如下：

import org.apache.log4j.*;

public class LogTest {

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

    public static void main(String[] args) {

        PropertyConfigurator.configure ( “.\\src\ log4j.properties ”) ；

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

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

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

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

    }

}

程序说明：

① static Logger logger = Logger.getLogger(LogTest.class.getName()); 就是创建一个属于 LogTest 类的 Logger 对象，创建时要告知 Logger 你当前的 Class 是什么。

② PropertyConfigurator.configure ( “ log4j.properties ”) 就是说使用当前工程目录下的 src 文件夹中的 log4j.properties 文件作为配置文件。若将 log4j.properties 放在工程根目录下也可不写此句，程序会自动找到配置文件。

③ logger.debug 就是输出 debug 的信息， logger.info 就是输出提示信息， logger.warn 就是显示警告信息， logger.error 就是显示错误信息。

下面是配置文件 log4j.properties 的内容：

log4j.rootCategory=DEBUG, stdout ， R

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

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

程序说明：

① log4j.rootCategory=DEBUG, stdout ， R

就是说我要显示所有优先权等於和高于 Debug的信息。
"stdout"， ”R” 表示我定义了两个输出端 ( 随便什么名字都好 ) 。

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

③ 再加上下面六行则 log 信息不光显示在屏幕上，而且将被保存在一个叫 "log.txt" 的文件里，文件最大为 100KB 。如果文件大小超过 100KB ，文件会被备份成 "log.txt.1" ，新的 "log.txt" 继续记录 log 信息。

接下来我们可以改变 log4j.properties ，而不需重新编译就可以控制 log 信息是否显示、 log 信息的输出端类型、输出方式、输出格式，等等。举例如下：

① 在 log4j.properties 文件里把 "log4j.rootCategory=DEBUG,stdout,R" 改写成 "log4j.rootCategory=OFF, stdout,R" ，这样所有的 log信息都不会显示了；解决了本文开始提出的问题。
② 在 log4j.properties 文件里把 "log4j.rootCategory=DEBUG,stdout,R" 改写成 "log4j.rootCategory=INFO, stdout,R" ，这样只显示 INFO, WARN, ERROR 的 log 信息，而 DEBUG 信息不会被显示；

在web程序中使用log4j注意问题

1、    由于jsp或servlet在执行状态时没有当前路径概念，所有使用 PropertyConfigurator.configure （ String ）语句找 log4j.properties 文件时要给出相对于当前 jsp 或 servlet 的路径转化成为一个绝对的文件系统路径。方法是使用 servletcontext.getrealpath(string) 语句。例：

//得到当前jsp路径

String prefix =  getServletContext().getRealPath( "/");

//读取 log4j.properties

PropertyConfigurator.configure(prefix+ "\\WEB-INF\\log4j.properties");

2、相应的log4j.properties设置某个属性时也要在程序中设置绝对路径。例：

log4j.appender.R.File属性设置日志文件存放位置。我们可以用读写.properties配置文件的方法进行灵活设置。

（2）跟踪代码运行进轨迹，作为日后审计的依据。

（3）担当集成开发环境中的调试器，向文件或控制台打印代码的调试信息。

　　Apache能用日志包（Commons Logging Package）是Apache的一个开放源代码项目，它提供了一组通用的日志接口，用户可以自由地选择实现日志接口的第三方软件。通用日志包目前支持以下日志实现：

• Log4J日志器（http://jakarta.apache.org/log4j）
• JDK1.4 Logging日志器(JDK1.4自带)
• SimpleLog日志器(把日志消息输出到标准系统错误流System.err)
• NoOpLog(不输出任何日志信息)

通用日志包中的两个常用接口：LogFactory和Log，分别介绍如下：

• Log接口

通用日志包把消息分为6个级别：FATAL、ERROR、WARN、INFO、DEBUG和TRACE。其中FATAL级别最高，TRACE级别最低。Log接口提供输出不同级别消息的方法：

fatal(Object message)-------输出FATAL级别的消息。

error(Object message)-------输出ERROR级别的消息。

warn(Object message)-------输出WARN级别的消息。

info(Object message)-------输出INFO级别的消息。

debug(Object message)-------输出DEBUG级别的消息。

trace(Object message)-------输出TRACE级别的消息。

注：只有当输出日志的级别大于或等于为日志配置器配置的日志级别时，这个方法才会执行。

　　如何指定日志器的日志级别，不同的日志器实现会有不同的实现方案。

• LogFactory接口

LogFactory接口提供了获得日志器实例的两个静态方法：

public static Log getLog(String name) throws LogConfigurationException;

public static Log getLog(Class class) throws LogConfigurationException;

注：name参数作为日志器的名字；class参数指定类名作为日志器名字。

以下介绍最常用的一个日志实现--------Log4J

　　Log4j是Apache的一个开放源代码项目，它是一个日志操作包。通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。
此外，通过Log4j其他语言接口，您可以在C、C++、.Net、PL/SQL程序中使用Log4j，其语法和用法与在Java程序中一样，使得多语言分布式系统得到一个统一一致的日志组件模块。而且，通过使用各种第三方扩展，您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。

　　Log4J主要由三大组件构成：

• Logger：负责生成日志，并能根据配置的日志级别来决定什么日志消息应该被输出，什么日志消息应该被忽略。
• Appender：定义日志消息输出的目的地，指定日志消息应该被输出到什么地方，这些地方可以是控制台、文件和网络设备等。
• Layout：指定日志消息的输出格式。

　　这三个组件协同工作，使得开发者能够依据日志消息类别来输出日志，并能够在程序运行期间，控制日志消息的输出格式以及日志存放地点。

　　Log4J的配置

　　配置Log4J，需要分别配置它的Logger、Appender和Layout属性。配置文件一般为log4j.properties。当然也可以以XML文件来配置，这里介绍以属性文件配置。

• 配置Logger组件

Logger组件支持继承关系，所有的Logger组件都直接或间接继承rootLogger。配置rootLogger的语法为：

　　log4j.rootLogger=[priority]，appenderName，appenderName，......

priority是如前所述的日志级别；

appenderName指定Appender组件，用户可以同时指定多个Appender组件，以与逗号分隔。

• 配置Appender组件

配置日志消息输出目的地Appender，语法为：

　　log4j.appender.appenderName=<appender的完整类名>

　　log4j.appender.appenderName.option1=value1

　　log4j.appender.appenderName.option2=value2

　　...

Log4J共有以下几种Appender:

　　org.apache.log4j.ConsoleAppender(控制台)

　　org.apache.log4j.FileAppender(文件)

　　org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)

　　org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)

　　org.apache.log4j.WriterAppender(将日志消息以流格式发送到任意指定的地方)

• 配置Layout组件

语法：

　　　log4j.appender.appenderName.layout=<layout的完整类名>

　　　log4j.appender.appenderName.layout.option1=value1

　　　log4j.appender.appenderName.layout.option2=value2

　　　...

Log4J提供以下几种Layout：

　　org.apache.log4j.HTMLLayout(以HTML表格形式布局)

　　org.apache.log4j.PatternLayout(可以灵活地指定布局模式)

　　org.apache.log4j.SimpleLayout(包含日志消息的级别和信息字符串)

　　org.apache.log4j.TTCCLayout(包含日志产生的时间、线程和类别等信息)

通过设置PatternLayout的ConversionPattern属性来指定输出格式

ConversionPattern的格式如下表所示：

格式名 　　　　　含义
%c 　　　　　 输出日志信息所属的类的全名
%d　　　　　 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：

                            %d{yyy-MM-dd HH:mm:ss }，输出类似：2002-10-18- 22：10：28
%f 　　　　　 输出日志信息所属的类的类名
%l 　　　　　 输出日志事件的发生位置，即输出日志信息的语句处于它所在的类的第几行
%m 　　　　   输出代码中指定的信息，如log(message)中的message
%n 　　　　　输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n”
%p 　　　　　输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL。如果是调用debug()输出的，则为DEBUG，依此类推
%r 　　　　　输出自应用启动到输出该日志信息所耗费的毫秒数
%t 　　　　　输出产生该日志事件的线程名

示例：log4j.appender.file.layout=org.apache.log4j.PatternLayout

　　　log4j.appender.file.layout.ConversionPattern=%t %p- %m%n

Log4J对应用性能的影响

　　如果在程序运行中输出大量日志，显然会对应用的性能造成一定的影响。Log4J对性能的影响取决于以下因素：

• 日志输出目的地：输出到控制台的速度和输出到文件系统的速度是不一样的。
• 日志输出格式：格式简单，速度也更快。
• 日志级别：日志级别设置的越低，输出的日志内容越多，对性能的影响也越大。

												
														package log4j;

import java.util.* ;
import java.io.* ;
import java.net.* ;

// add for log4j: import some package
import org.apache.log4j.PropertyConfigurator ;
import org.apache.log4j.Logger ;
import org.apache.log4j.Level ;

/**
 *
 * <p> Server With Log4j </p>
 * <p> Description: a sample with log4j</p>
 * @version 1.0
 */
public class ServerWithLog4j {

    final static int SERVER_PORT = 8001 ; // this server's port

    /*
    add for log4j: class Logger is the central class in the log4j package.
    we can do most logging operations by Logger except configuration.
    getLogger(...): retrieve a logger by name, if not then create for it.
    */
    static Logger logger = Logger.getLogger 
	( ServerWithLog4j.class.getName () ) ;

    /**
     *
     * @param args
     */
    public static void main ( String args[]) {
        String clientRequest = null ;
        BufferedReader reader = null ;
        PrintWriter writer = null ;
        ServerSocket server = null ;
        Socket socket = null ;

        InputStream in = null ;
        OutputStream out = null ;

        /*
        add for log4j: class BasicConfigurator can quickly configure the package.
        print the information to console.
        */
        PropertyConfigurator.configure ( "ServerWithLog4j.properties" ) ;

        // add for log4j: set the level
//        logger.setLevel ( ( Level ) Level.DEBUG ) ;

        try{
            server = new ServerSocket ( SERVER_PORT ) ;

            // add for log4j: log a message with the info level
            logger.info ( "ServerSocket before accept: " + server ) ;

            // add for log4j: log a message with the info level
            logger.info ( "Java server with log4j, on-line!" ) ;

            // wait for client's connection
            socket = server.accept() ;

            // add for log4j: log a message with the info level
            logger.info ( "ServerSocket after accept: " + server ) ;

            in = socket.getInputStream() ;
            out = socket.getOutputStream() ;

        } catch ( IOException e ) {

            // add for log4j: log a message with the error level
            logger.error ( "Server constructor IOException: " + e ) ;
            System.exit ( 0 ) ;
        }
        reader = new BufferedReader ( new InputStreamReader ( in ) ) ;
        writer = new PrintWriter ( new OutputStreamWriter ( out ), true ) ;

        // send welcome string to client
        writer.println ( "Java server with log4j, " + new Date () ) ;

        while ( true ) {
            try {
                // read from client
                clientRequest = reader.readLine () ;

                // add for log4j: log a message with the debug level
                logger.debug ( "Client says: " + clientRequest ) ;

                if ( clientRequest.startsWith ( "HELP" ) ) {

                    // add for log4j: log a message with the debug level
                    logger.debug ( "OK!" ) ;

                    writer.println ( "Vocabulary: HELP QUIT" ) ;
                }
                else {
                    if ( clientRequest.startsWith ( "QUIT" ) ) {

                        // add for log4j: log a message with the debug level
                        logger.debug ( "OK!" ) ;

                        System.exit ( 0 ) ;
                    }
                    else {

                        // add for log4j: log a message with the warn level
                        logger.warn ( "Command '" 
						+ clientRequest + "' not understood." ) ;

                        writer.println ( "Command '"
						+ clientRequest + "' not understood." ) ;
                    }
                }
            } catch ( IOException e ) {

                // add for log4j: log a message with the error level
                logger.error( "IOException in Server " + e ) ;

                System.exit ( 0 ) ;
            }
        }
    }
}

												
										

2.2.3. 配置文件

2.2.3.1. 客户程序配置文件

												
														log4j.rootLogger=INFO, A1

log4j.appender.A1=org.apache.log4j.ConsoleAppender

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

log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n

												
										

2.2.3.2. 服务器程序配置文件

												
														log4j.rootLogger=INFO, A1

log4j.appender.A1=org.apache.log4j.ConsoleAppender

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

log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n

												
										

2.3. 比较

比较这两个应用可以看出，采用Log4j进行日志操作的整个过程相当简单明了，与直接使用System.out.println语句进行日志信息输出的方式相比，基本上没有增加代码量，同时能够清楚地理解每一条日志信息的重要程度。通过控制配置文件，我们还可以灵活地修改日志信息的格式，输出目的地等等方面，而单纯依靠System.out.println语句，显然需要做更多的工作。

下面我们将以前面使用Log4j的应用作为例子，详细讲解使用Log4j的主要步骤。

回页首

Log4j基本使用方法

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

3.1.定义配置文件

其实您也可以完全不使用配置文件，而是在代码中配置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就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
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有以下几种：
   org.apache.log4j.HTMLLayout（以HTML表格形式布局），
   org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
   org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
   org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

3.2.在代码中使用Log4j

下面将讲述在程序代码中怎样使用Log4j。

3.2.1.得到记录器

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

public static Logger getLogger( String name)，

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

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

3.2.2.读取配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：
BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

3.2.3.插入记录信息（格式化日志信息）

当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;

概述

1.1. 背景

在应用程序中添加日志记录总的来说基于三个目的：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；跟踪代码运行时轨迹，作为日后审计的依据；担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。

最普通的做法就是在代码中嵌入许多的打印语句，这些打印语句可以输出到控制台或文件中，比较好的做法就是构造一个日志操作类来封装此类操作，而不是让一系列的打印语句充斥了代码的主体。

1.2. Log4j简介

在强调可重用组件开发的今天，除了自己从头到尾开发一个可重用的日志操作类外，Apache为我们提供了一个强有力的日志操作包-Log4j。

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

此外，通过Log4j其他语言接口，您可以在C、C++、.Net、PL/SQL程序中使用Log4j，其语法和用法与在Java程序中一样，使得多语言分布式系统得到一个统一一致的日志组件模块。而且，通过使用各种第三方扩展，您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。

本文介绍的Log4j版本是1.2.3。作者试图通过一个简单的客户/服务器Java程序例子对比使用与不使用Log4j 1.2.3的差别，并详细讲解了在实践中最常使用Log4j的方法和步骤。在强调可重用组件开发的今天，相信Log4j将会给广大的设计开发人员带来方便。加入到Log4j的队伍来吧！

回页首

一个简单的例子

我们先来看一个简单的例子，它是一个用Java实现的客户/服务器网络程序。刚开始我们不使用Log4j，而是使用了一系列的打印语句，然后我们将使用Log4j来实现它的日志功能。这样，大家就可以清楚地比较出前后两个代码的差别。

2.1. 不使用Log4j

2.1.1. 客户程序

												
														package log4j ;

import java.io.* ;
import java.net.* ;

/**
 *
 * <p> Client Without Log4j </p>
 * <p> Description: a sample with log4j</p>
 * @version 1.0
 */
public class ClientWithoutLog4j {

    /**
     *
     * @param args
     */
    public static void main ( String args [] ) {

        String welcome = null;
        String response = null;
        BufferedReader reader = null;
        PrintWriter writer = null;
        InputStream in = null;
        OutputStream out = null;
        Socket client = null;

        try {
            client = new Socket ( "localhost", 8001 ) ;
            System.out.println ( "info: Client socket: " + client ) ;
            in = client.getInputStream () ;
            out = client.getOutputStream () ;
        } catch ( IOException e ) {
            System.out.println ( "error: IOException : " + e ) ;
            System.exit ( 0 ) ;
        }

        try{
            reader = new BufferedReader( new InputStreamReader ( in ) ) ;
            writer = new PrintWriter ( new OutputStreamWriter ( out ), true ) ;

            welcome = reader.readLine () ;
            System.out.println ( "debug: Server says: '" + welcome + "'" ) ;

            System.out.println ( "debug: HELLO" ) ;
            writer.println ( "HELLO" ) ;
            response = reader.readLine () ;
            System.out.println ( "debug: Server responds: '" + response + "'") ;

            System.out.println ( "debug: HELP" ) ;
            writer.println ( "HELP" ) ;
            response = reader.readLine () ;
            System.out.println ( "debug: Server responds: '" + response + "'" ) ;

            System.out.println ( "debug: QUIT" ) ;
            writer.println ( "QUIT" ) ;
        } catch ( IOException e ) {
            System.out.println ( "warn: IOException in client.in.readln()" ) ;
            System.out.println ( e ) ;
        }
        try{
            Thread.sleep ( 2000 ) ;
        } catch ( Exception ignored ) {}
    }
}

												
										

2.1.2. 服务器程序

												
														package log4j ;

import java.util.* ;
import java.io.* ;
import java.net.* ;

/**
 *
 * <p> Server Without Log4j </p>
 * <p> Description: a sample with log4j</p>
 * @version 1.0
 */
public class ServerWithoutLog4j {

    final static int SERVER_PORT = 8001 ; // this server's port

    /**
     *
     * @param args
     */
    public static void main ( String args [] ) {
        String clientRequest = null;
        BufferedReader reader = null;
        PrintWriter writer = null;
        ServerSocket server = null;
        Socket socket = null;
        InputStream in = null;
        OutputStream out = null;

        try {
            server = new ServerSocket ( SERVER_PORT ) ;
            System.out.println ( "info: ServerSocket before accept: " + server ) ;
            System.out.println ( "info: Java server without log4j, on-line!" ) ;

            // wait for client's connection
            socket = server.accept () ;
            System.out.println ( "info: ServerSocket after accept: " + server )  ;

            in = socket.getInputStream () ;
            out = socket.getOutputStream () ;

        } catch ( IOException e ) {
            System.out.println( "error: Server constructor IOException: " + e ) ;
            System.exit ( 0 ) ;
        }
        reader = new BufferedReader ( new InputStreamReader ( in ) ) ;
        writer = new PrintWriter ( new OutputStreamWriter ( out ) , true ) ;

        // send welcome string to client
        writer.println ( "Java server without log4j, " + new Date () ) ;

        while ( true ) {
            try {
                // read from client
                clientRequest = reader.readLine () ;
                System.out.println ( "debug: Client says: " + clientRequest ) ;
                if ( clientRequest.startsWith ( "HELP" ) ) {
                    System.out.println ( "debug: OK!" ) ;
                    writer.println ( "Vocabulary: HELP QUIT" ) ;
                }
                else {
                    if ( clientRequest.startsWith ( "QUIT" ) ) {
                        System.out.println ( "debug: OK!" ) ;
                        System.exit ( 0 ) ;
                    }
                    else{
                        System.out.println ( "warn: Command '" + 
						clientRequest + "' not understood." ) ;
                        writer.println ( "Command '" + clientRequest 
						+ "' not understood." ) ;
                    }
                }
            } catch ( IOException e ) {
                System.out.println ( "error: IOException in Server " + e ) ;
                System.exit ( 0 ) ;
            }
        }
    }
}

												
										

2.2. 迁移到Log4j

2.2.1. 客户程序

												
														package log4j ;

import java.io.* ;
import java.net.* ;

// add for log4j: import some package
import org.apache.log4j.PropertyConfigurator ;
import org.apache.log4j.Logger ;
import org.apache.log4j.Level ;

/**
 *
 * <p> Client With Log4j </p>
 * <p> Description: a sample with log4j</p>
 * @version 1.0
 */
public class ClientWithLog4j {

    /*
    add for log4j: class Logger is the central class in the log4j package.
    we can do most logging operations by Logger except configuration.
    getLogger(...): retrieve a logger by name, if not then create for it.
    */
    static Logger logger = Logger.getLogger 
	( ClientWithLog4j.class.getName () ) ;

    /**
     *
     * @param args : configuration file name
     */
    public static void main ( String args [] ) {

        String welcome = null ;
        String response = null ;
        BufferedReader reader = null ;
        PrintWriter writer = null ;
        InputStream in = null ;
        OutputStream out = null ;
        Socket client = null ;

        /*
        add for log4j: class BasicConfigurator can quickly configure the package.
        print the information to console.
        */
        PropertyConfigurator.configure ( "ClientWithLog4j.properties" ) ;

        // add for log4j: set the level
//        logger.setLevel ( ( Level ) Level.DEBUG ) ;

        try{
            client = new Socket( "localhost" , 8001 ) ;

            // add for log4j: log a message with the info level
            logger.info ( "Client socket: " + client ) ;

            in = client.getInputStream () ;
            out = client.getOutputStream () ;
        } catch ( IOException e ) {

            // add for log4j: log a message with the error level
            logger.error ( "IOException : " + e ) ;

            System.exit ( 0 ) ;
        }

        try{
            reader = new BufferedReader ( new InputStreamReader ( in ) ) ;
            writer = new PrintWriter ( new OutputStreamWriter ( out ), true ) ;

            welcome = reader.readLine () ;

            // add for log4j: log a message with the debug level
            logger.debug ( "Server says: '" + welcome + "'" ) ;

            // add for log4j: log a message with the debug level
            logger.debug ( "HELLO" ) ;

            writer.println ( "HELLO" ) ;
            response = reader.readLine () ;

            // add for log4j: log a message with the debug level
            logger.debug ( "Server responds: '" + response + "'" ) ;

            // add for log4j: log a message with the debug level
            logger.debug ( "HELP" ) ;

            writer.println ( "HELP" ) ;
            response = reader.readLine () ;

            // add for log4j: log a message with the debug level
            logger.debug ( "Server responds: '" + response + "'") ;

            // add for log4j: log a message with the debug level
            logger.debug ( "QUIT" ) ;

            writer.println ( "QUIT" ) ;
        } catch ( IOException e ) {

            // add for log4j: log a message with the warn level
            logger.warn ( "IOException in client.in.readln()" ) ;

            System.out.println ( e ) ;
        }
        try {
            Thread.sleep ( 2000 ) ;
        } catch ( Exception ignored ) {}
    }
}