我们先来看一个简单的例子，它是一个用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 ) {}
}
}
2.2.2.
服务器程序
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语句，显然需要做更多的工作。
>>>> 3 . Log4j日志管理系统简单使用说明
<<<<
通常，我们都提供一个名为
log4j.properties的文件，在第一次调用到Log4J时，Log4J会在类路径（../web-inf/class/当然也可以放到其它任何目录，只要该目录被包含到类路径中即可）中定位这个文件，并读入这个文件完成的配置。这个配置文件告诉Log4J以什么样的格式、把什么样的信息、输出到什么地方。
Log4j有三个主要的组件：Loggers(记录器)，Appenders
(输出源)和Layouts(布局)，这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松的记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。下面对三个组件分别进行说明：
1、
Loggers
Loggers组件在此系统中被分为五个级别：DEBUG、INFO、WARN、ERROR和FATAL。这五个级别是有顺序的，DEBUG
< INFO < WARN < ERROR <
FATAL，分别用来指定这条日志信息的重要程度,明白这一点很重要，这里Log4j有一个规则：假设Loggers级别为P，如果在Loggers中发生了一个级别Q比P高，则可以启动，否则屏蔽掉。
假设你定义的级别是info，那么error和warn的日志可以显示而比他低的debug信息就不显示了。
Java程序举例来说：
//建立Logger的一个实例，命名为“com.foo”
Logger logger
= Logger.getLogger("com.foo");
//"com.foo"是实例进行命名，也可以任意
//设置logger的级别。通常不在程序中设置logger的级别。一般在配置文件中设置。
logger.setLevel(Level.INFO);
Logger
barlogger = Logger.getLogger("com.foo.Bar");
//下面这个请求可用，因为WARN >=
INFO
logger.warn("Low fuel level.");
//下面这个请求不可用，因为DEBUG <
INFO
logger.debug("Starting search for nearest gas
station.");
//命名为“com.foo.bar”的实例barlogger会继承实例“com.foo”的级别。因此，下面这个请求可用，因为INFO
>= INFO
barlogger.info("Located nearest gas
station.");
//下面这个请求不可用，因为DEBUG < INFO
barlogger.debug("Exiting gas
station
search");
这里“是否可用”的意思是能否输出Logger信息。
在对Logger实例进行命名时，没有限制，可以取任意自己感兴趣的名字。一般情况下建议以类的所在位置来命名Logger实例，这是目前来讲比较有效的Logger命名方式。这样可以使得每个类建立自己的日志信息，便于管理。比如：
static
Logger logger =
Logger.getLogger(ClientWithLog4j.class.getName());
2、Appenders
禁用与使用日志请求只是Log4j其中的一个小小的地方，Log4j日志系统允许把日志输出到不同的地方，如控制台（Console）、文件（Files）、根据天数或者文件大小产生新的文件、以流的形式发送到其它地方等等。
其语法表示为：
org.apache.log4j.ConsoleAppender（控制台）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
配置时使用方式为：
log4j.appender.appenderName
=
fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1
= value1
…
log4j.appender.appenderName.option =
valueN
这样就为日志的输出提供了相当大的便利。
3、Layouts 有时用户希望根据自己的喜好格式化自己的日志输出。Log4j可以在Appenders的后面附加Layouts来完成这个功能。Layouts提供了四种日志输出样式，如根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式等等。
其语法表示为：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
配置时使用方式为：
log4j.appender.appenderName.layout
=fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1
= value1
…
log4j.appender.appenderName.layout.option = valueN
log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender
//指定以文件的方式输出日志
log4j.appender.ROLLING_FILE.Threshold=ERROR
log4j.appender.ROLLING_FILE.File=rolling.log
//文件位置,也可以用变量${java.home}、rolling.log
log4j.appender.ROLLING_FILE.Append=true
log4j.appender.ROLLING_FILE.MaxFileSize=10KB
//文件最大尺寸
log4j.appender.ROLLING_FILE.MaxBackupIndex=1
//备份数
log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework]
%d - %c -%-4r [%t] %-5p %c %x - %m%n
LOG4J的配置之简单使它遍及于越来越多的应用中了：Log4J配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。择其一二使用就够用了，
