log4j.properties和log4j.xml配置

转载

mob604756e72afd 2013-10-28 15:11:00

文章标签 apache java 配置文件 xml 默认值 文章分类 代码人生

>>>>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.* ;

　　/**

* Client Without Log4j

* Description: a sample with log4j

　　 * @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.* ;

　　/**

* Server Without Log4j

* Description: a sample with log4j

　　 * @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 ;

　　/**

* Client With Log4j

* Description: a sample with log4j

　　 * @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 () ;