使用Log4j進行日志操作

2019-11-17 06:07:05

字體：大中小

來源：轉載

供稿：網友

內容：1. 概述 1.1. 背景 1.2. Log4j簡介2.一個簡單的例子 2.1. 不使用Log4j 2.2. 遷移到Log4j 2.3. 比較3. Log4j基本使用方法 3.1.定義配置文件 3.2.在代碼中使用Log4j參考資料關于作者相關內容：TCP/IP 介紹TCP/IP 介紹-->Also in the java zone:教學工具與產品代碼與組件所有文章實用技巧

葵貞祥 (chinesemars@hotmail.com)
2002 年 6 月

1. 概述

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的隊伍來吧！

2. 一個簡單的例子

我們先來看一個簡單的例子，它是一個用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 packageimport 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 ) {}    }}

2.2.2. 服務器程序

package log4j;import java.util.* ;import java.io.* ;import java.net.* ;// add for log4j: import some packageimport 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, A1log4j.appender.A1=org.apache.log4j.ConsoleAppenderlog4j.appender.A1.layout=org.apache.log4j.PatternLayoutlog4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n

2.2.3.2. 服務器程序配置文件

log4j.rootLogger=INFO, A1log4j.appender.A1=org.apache.log4j.ConsoleAppenderlog4j.appender.A1.layout=org.apache.log4j.PatternLayoutlog4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n

2.3. 比較

比較這兩個應用可以看出，采用Log4j進行日志操作的整個過程相當簡單明了，與直接使用System.out.println語句進行日志信息輸出的方式相比，基本上沒有增加代碼量，同時能夠清楚地理解每一條日志信息的重要程度。通過控制配置文件，我們還可以靈活地修改日志信息的格式，輸出目的地等等方面，而單純依靠System.out.println語句，顯然需要做更多的工作。

下面我們將以前面使用Log4j的應用作為例子，具體講解使用Log4j的主要步驟。

3. Log4j基本使用方法

Log4j由三個重要的組件構成：日志信息的優先級，日志信息的輸出目的地，日志信息的輸出格式。日志信息的優先級從高到低有ERROR、WARN、INFO、DEBUG，分別用來指定這條日志信息的重要程度；日志信息的輸出目的地指定了日志將打印到控制臺還是文件中；而輸出格式則控制了日志信息的顯示內容。

3.1.定義配置文件

其實您也可以完全不使用配置文件，而是在代碼中配置Log4j環境。但是，使用配置文件將使您的應用程序更加靈活。

Log4j支持兩種配置文件格式，一種是xml格式的文件，一種是Java特性文件（鍵=值）。下面我們介紹使用Java特性文件做為配置文件的方法：