Log4J使用详解

本文转自：http://blog.csdn.net/java_pengjin/article/details/6179095

　　背景

　　在应用程序中添加日志记录总的来说基于三个目的：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；跟踪代码运行时轨迹，作为日后审计的依据；担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。
　　
　　最普通的做法就是在代码中嵌入许多的打印语句，这些打印语句可以输出到控制台或文件中，比较好的做法就是构造一个日志操作类来封装此类操作，而不是让一系列的打印语句充斥了代码的主体。
　　

　　 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来实现它的日志功能。这样，大家就可以清楚地比较出前后两个代码的差别。
　　

　　不使用Log4j　　

　　客户程序

　　

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 ) {}　　　　}　　}

服务器程序

　　

   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 ) ;　　　　　　　　}　　　　　　}　　　　}　　}

　   迁移到Log4j　　

　　客户程序

   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 ) {}　　　　}　　}

　　服务器程序

   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 ) ;　　　　　　　　}　　　　　　}　　　　}　　}

　　

　 配置文件　　

　 客户程序配置文件　　

　　

   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

　　服务器程序配置文件　　

   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

　　

　　比较

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

Log4j日志管理系统简单使用说明

通常，我们都提供一个名为 log4j.properties的文件或log4j.xml文件，在第一次调用到Log4J时，Log4J会在类路径（../web-inf/class/当然也可以放到其它任何目录，只要该目录被包含到类路径中即可）中定位这个文件，并读入这个文件完成的配置。这个配置文件告诉Log4J以什么样的格式、把什么样的信息、输出到什么地方。
　　Log4j有三个主要的组件：Loggers(记录器)，Appenders(输出源)和Layouts(布局)，记录器可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松的记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。下面对三个组件分别进行说明：
　　

　　Loggers

　 　Loggers组件在此系统中被分为七个级别：ALL、DEBUG、INFO、WARN、ERROR和FATAL、OFF。这五个级别是有顺序的，ALL<DEBUG < INFO < WARN < ERROR < FATAL<OFF，分别用来指定这条日志信息的重要程度,明白这一点很重要，这里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());

　　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
　　这样就为日志的输出提供了相当大的便利。　　

　　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的配置 　　　

　　以上是从原理方面说明Log4j的使用方法，在具体Java编程使用Log4j可以参照以下示例：
　　
　　1、 建立Logger实例：
　　语法表示：public static Logger getLogger( String name)
　　实际使用：static Logger logger = Logger.getLogger(ServerWithLog4j.class.getName ()) ;
　　
　　2、 读取配置文件：
　　获得了Logger的实例之后，接下来将配置Log4j使用环境：
　　语法表示：
　　BasicConfigurator.configure()：自动快速地使用缺省Log4j环境。
　　PropertyConfigurator.configure(String configFilename)：读取使用Java的特性文件编写的配置文件。
　　DOMConfigurator.configure(String filename)：读取XML形式的配置文件。
　　实际使用：
       PropertyConfigurator.configure("ServerWithLog4j.properties");
　　
　　3、 插入日志信息
　　完成了以上连个步骤以后，下面就可以按日志的不同级别插入到你要记录日志的任何地方了。
　　语法表示：
　　Logger.debug(Object message);//调试信息
　　Logger.info(Object message);//一般信息
　　Logger.warn(Object message);//警告信息
　　Logger.error(Object message);//错误信息
　　Logger.fatal(Object message);//致命错误信息

　　实际使用：logger.info("ServerSocket before accept: " + server);
　　

　 配置过程 

在实际编程时，要使Log4j真正在系统中运行事先还要对配置文件进行定义。定义步骤就是对Logger、Appender及Layout的分别使用。
Log4j支持两种配置文件格式，一种是XML格式的文件，一种是java properties（key=value）【Java特性文件（键=值）】。下面我们介绍使用Java特性文件做为配置文件的方法
   具体如下：
　　1、配置根Logger，其语法为：
　　log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
       level : 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。
       appenderName:就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
   例如：log4j.rootLogger＝info,A1,B2,C3
　　
　　2、配置日志信息输出目的地，其语法为：
　　log4j.appender.appenderName = fully.qualified.name.of.appender.class  //
　　"fully.qualified.name.of.appender.class" 可以指定下面五个目的地中的一个：
        1.org.apache.log4j.ConsoleAppender（控制台）
          2.org.apache.log4j.FileAppender（文件）
          3.org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
          4.org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
          5.org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

1.ConsoleAppender选项
                    Threshold=WARN:指定日志消息的输出最低层次。
                    ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
                    Target=System.err：默认情况下是：System.out,指定输出控制台
 2.FileAppender 选项
                    Threshold=WARN:指定日志消息的输出最低层次。
                    ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
                    File=mylog.txt:指定消息输出到mylog.txt文件。
                    Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
3.DailyRollingFileAppender 选项
                    Threshold=WARN:指定日志消息的输出最低层次。
                    ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
                    File=mylog.txt:指定消息输出到mylog.txt文件。
                    Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
                    DatePattern='.'yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下：
                    1)'.'yyyy-MM: 每月
                    2)'.'yyyy-ww: 每周 
                    3)'.'yyyy-MM-dd: 每天
                    4)'.'yyyy-MM-dd-a: 每天两次
                    5)'.'yyyy-MM-dd-HH: 每小时
                    6)'.'yyyy-MM-dd-HH-mm: 每分钟
4.RollingFileAppender 选项
                    Threshold=WARN:指定日志消息的输出最低层次。
                    ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
                    File=mylog.txt:指定消息输出到mylog.txt文件。
                    Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
                    MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。
                    MaxBackupIndex=2:指定可以产生的滚动文件的最大数。

实际应用：
log4j.appender.A1=org.apache.log4j.ConsoleAppender //这里指定了日志输出的第一个位置A1是控制台ConsoleAppender
　　
　　3、配置日志信息的格式，其语法为：
　　A. log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
            "fully.qualified.name.of.layout.class" 可以指定下面4个格式中的一个：
            1.org.apache.log4j.HTMLLayout（以HTML表格形式布局），
　　       2.org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
　　       3.org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
　　       4.org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
           1.HTMLLayout 选项
                      LocationInfo=true:默认值是false,输出java文件名称和行号
                      Title=my app file: 默认值是 Log4J Log Messages.
            2.PatternLayout 选项
                      ConversionPattern=%m%n :指定怎样格式化指定的消息。
            3.XMLLayout  选项
                      LocationInfo=true:默认值是false,输出java文件和行号
   实际应用：
   　　log4j.appender.A1.layout=org.apache.log4j.PatternLayout

       B. log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
           这里需要说明的就是日志信息格式中几个符号所代表的含义：
　　         －X号: X信息输出时左对齐；
                   %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
                   %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
                   %r: 输出自应用启动到输出该log信息耗费的毫秒数
                   %c: 输出日志信息所属的类目，通常就是所在类的全名
                   %t: 输出产生该日志事件的线程名
                   %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)
                   %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
                   %%: 输出一个"%"字符
                   %F: 输出日志消息产生时所在的文件名称
                   %L: 输出代码中的行号
                   %m: 输出代码中指定的消息,产生的日志具体信息
                   %n: 输出一个回车换行符，Windows平台为"/r/n"，Unix平台为"/n"输出日志信息换行
            可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
                     1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。
                     2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。
                     3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
                     4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边交远销出的字符截掉。

　　这里上面三个步骤是对前面Log4j组件说明的一个简化；下面给出一个具体配置例子，在程序中可以参照执行：
　　log4j.rootLogger=INFO,A1，B2
　　log4j.appender.A1=org.apache.log4j.ConsoleAppender
　　log4j.appender.A1.layout=org.apache.log4j.PatternLayout
　　log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
 　　根据上面的日志格式，某一个程序的输出结果如下：
　　 0　  INFO　2003-06-13 13:23:46968 ClientWithLog4j Client socket: Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]
        16　DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says: 'Java server with log4j, Fri Jun 13 13:23:46 CST 2003'
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j GOOD
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Command 'HELLO' not understood.'
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j HELP
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Vocabulary: HELP QUIT'
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j QUIT
 
      4. # 当输出信息于回滚文件时

          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的配置之简单使它遍及于越来越多的应用中了：Log4J配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。择其一二使用就够用了，

 log4j.rootLogger=DEBUG,CONSOLE,A1,im 
 log4j.addivity.org.apache=true

 # 应用于控制台

 log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender 
 log4j.appender.Threshold=DEBUG 
 log4j.appender.CONSOLE.Target=System.out 
 log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
 #log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n

 #应用于文件

 log4j.appender.FILE=org.apache.log4j.FileAppender 
 log4j.appender.FILE.File=file.log 
 log4j.appender.FILE.Append=false 
 log4j.appender.FILE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
 # Use this layout for LogFactor 5 analysis

 # 应用于文件回滚

 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       //true:添加  false:覆盖
 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

 #应用于socket 
 log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender 
 log4j.appender.SOCKET.RemoteHost=localhost 
 log4j.appender.SOCKET.Port=5001 
 log4j.appender.SOCKET.LocationInfo=true 
 # Set up for Log Facter 5 
 log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout 
 log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n

 # Log Factor 5 Appender 
 log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender 
 log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000

 # 发送日志给邮件

 log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender 
 log4j.appender.MAIL.Threshold=FATAL 
 log4j.appender.MAIL.BufferSize=10 
 log4j.appender.MAIL.From=[e-mail] 
 log4j.appender.MAIL.SMTPHost=www.wusetu.com 
 log4j.appender.MAIL.Subject=Log4J Message 
 log4j.appender.MAIL.To=[e-mail] 
 log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout 
 log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 # 用于数据库 
 log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender 
 log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test 
 log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver 
 log4j.appender.DATABASE.user=root 
 log4j.appender.DATABASE.password= 
 log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n') 
 log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender 
 log4j.appender.A1.File=SampleMessages.log4j 
 log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j' 
 log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout

 #自定义Appender

 log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender

 log4j.appender.im.host = mail.cybercorlin.net 
 log4j.appender.im.username = username 
 log4j.appender.im.password = password 
 log4j.appender.im.recipient = [e-mail]

 log4j.appender.im.layout=org.apache.log4j.PatternLayout 
 log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

log4j.xml配置

<?xml version="1.0" encoding="UTF-8"?>     <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">             <log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/' >                 <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">             <layout class="org.apache.log4j.PatternLayout">                 <param name="ConversionPattern" value="[%d{dd HH:mm:ss,SSS/} %-5p] [%t] %c{2/} - %m%n" />             </layout>             <!--过滤器设置输出的级别-->             <filter class="org.apache.log4j.varia.LevelRangeFilter">                 <param name="levelMin" value="debug" />                 <param name="levelMax" value="warn" />                 <param name="AcceptOnMatch" value="true" />             </filter>         </appender>              <appender name="myFile" class="org.apache.log4j.RollingFileAppender">                <param name="File" value="D:/output.log" /><!-- 设置日志输出文件名 -->             <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->             <param name="Append" value="true" />             <param name="MaxBackupIndex" value="10" />             <layout class="org.apache.log4j.PatternLayout">                 <param name="ConversionPattern" value="%p (%c:%L)- %m%n" />             </layout>         </appender>                <appender name="activexAppender" class="org.apache.log4j.DailyRollingFileAppender">             <param name="File" value="E:/activex.log" />               <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />               <layout class="org.apache.log4j.PatternLayout">              <param name="ConversionPattern"                   value="[%d{MMdd HH:mm:ss SSS/} %-5p] [%t] %c{3/} - %m%n" />             </layout>           </appender>                 <!-- 指定logger的设置，additivity指示是否遵循缺省的继承机制-->         <logger name="com.runway.bssp.activeXdemo" additivity="false">             <priority value ="info"/>               <appender-ref ref="activexAppender" />           </logger>              <!-- 根logger的设置-->         <root>             <priority value ="debug"/>             <appender-ref ref="myConsole"/>             <appender-ref ref="myFile"/>            </root>     </log4j:configuration>

(1). 输出方式appender一般有5种： 
             org.apache.log4j.RollingFileAppender(滚动文件，自动记录最新日志) 
             org.apache.log4j.ConsoleAppender (控制台)  
             org.apache.log4j.FileAppender (文件) 
             org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件) 
             org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方) 
(2). 日记记录的优先级priority，优先级由高到低分为 
            OFF ,FATAL ,ERROR ,WARN ,INFO ,DEBUG ,ALL。 
            Log4j建议只使用FATAL ,ERROR ,WARN ,INFO ,DEBUG这五个级别。 



(3). 格式说明layout中的参数都以%开始，后面不同的参数代表不同的格式化信息（参数按字母表顺序列出）： 
                %c        输出所属类的全名，可在修改为 %d{Num} ,Num类名输出的维（如："org.apache.elathen.ClassName",%C{2}将输出elathen.ClassName） 
                %d       输出日志时间其格式为 %d{yyyy-MM-dd HH:mm:ss,SSS}，可指定格式 如 %d{HH:mm:ss} 
                %l        输出日志事件发生位置，包括类目名、发生线程，在代码中的行数 
                %n       换行符 
                %m      输出代码指定信息，如info(“message”),输出message 
                %p       输出优先级，即 FATAL ,ERROR 等 
                %r        输出从启动到显示该log信息所耗费的毫秒数 
                %t        输出产生该日志事件的线程名

 

xml declaration and DTD

xml配置文件的头部包括两个部分：xml声明和DTD声明。头部的格式如下：

 

<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"><h3 style="color: rgb(51, 51, 51); font-family: Arial; font-size: 14px; line-height: 26px;">          <span style="font-size: 12px;"><span style="white-space:pre"></span>log4j:configuration (root element)</span></h3>

• xmlns:log4j [#FIXED attribute] : 定义log4j的名字空间，取定值"http://jakarta.apache.org/log4j/"
• appender [* child] : 一个appender子元素定义一个日志输出目的地
• logger [* child] : 一个logger子元素定义一个日志写出器
• root [? child] : root子元素定义了root logger

appender

appender元素定义一个日志输出目的地。

• name [#REQUIRED attribute] : 定义appender的名字，以便被后文引用
• class [#REQUIRED attribute] : 定义appender对象所属的类的全名
• param [* child] : 创建appender对象时传递给类构造方法的参数
• layout [? child] : 该appender使用的layout对象

fileter

filter设置过滤

class:过滤所属类全名

param：过滤参数

<filter class="org.apache.log4j.varia.LevelRangeFilter">   <param name="LevelMin" value="INFO" />   <param name="LevelMax" value="ERROR" /></filter>

 

layout

layout元素定义与某一个appender相联系的日志格式化器。

  class [#REQUIRED attribute] : 定义layout对象所属的类的全名

param [* child] : 创建layout对象时传递给类构造方法的参数

logger

logger元素定义一个日志输出器。

  name[#REQUIRED attribute] : 定义logger的名字，以便被后文引用

additivity[#ENUM attribute] : 取值为"true"（默认）或者"false"，是否继承父logger的属性

level[? child] : 定义该logger的日志级别

appender-ref [* child] : 定义该logger的输出目的地

root

root元素定义根日志输出器root logger。

param [* child] : 创建root logger对象时传递给类构造方法的参数

level [? child] : 定义root logger的日志级别

appender-ref [* child] : 定义root logger的输出目的地

level

level元素定义logger对象的日志级别。

class [#IMPLIED attribute] : 定义level对象所属的类，默认情况下是"org.apache.log4j.Level类

value [#REQUIRED attribute] : 为level对象赋值。可能的取值从小到大依次为"all"、"debug"、"info"、"warn"、"error"、"fatal"和"off"。当值为"off"时表示没有任何日志信息被输出

param [* child] : 创建level对象时传递给类构造方法的参数

appender-ref

appender-ref元素引用一个appender元素的名字，为logger对象增加一个appender。

ref[#REQUIRED attribute] : 一个appender元素的名字的引用

appender-ref元素没有子元素

param

param元素在创建对象时为类的构造方法提供参数。它可以成为appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。name and value [#REQUIRED attributes] : 提供参数的一组名值对

param元素没有子元素

在xml文件中配置appender和layout

创建不同的Appender对象或者不同的Layout对象要调用不同的构造方法。可以使用param子元素来设定不同的参数值。

创建ConsoleAppender对象

ConsoleAppender的构造方法不接受其它的参数。

 

... ... ... ...<appender name="console.log" class="org.apache.log4j.ConsoleAppender">  <layout ... >    ... ...  </layout></appender>... ... ... ...          <span style="font-family: Arial; background-color: rgb(255, 255, 255);"> </span>

创建FileAppender对象

可以为FileAppender类的构造方法传递两个参数：File表示日志文件名；Append表示如文件已存在，是否把日志追加到文件尾部，可能取值为"true"和"false"（默认）。

 

... ... ... ...<appender name="file.log" class="org.apache.log4j.FileAppender">  <param name="File" value="/tmp/log.txt" />  <param name="Append" value="false" />  <layout ... >    ... ...  </layout></appender>... ... ... ...          

创建RollingFileAppender对象

除了File和Append以外，还可以为RollingFileAppender类的构造方法传递两个参数：MaxBackupIndex备份日志文件的个数（默认是1个）；MaxFileSize表示日志文件允许的最大字节数（默认是10M）。

 

... ... ... ...<appender name="rollingFile.log" class="org.apache.log4j.RollingFileAppender">  <param name="File" value="/tmp/rollingLog.txt" />  <param name="Append" value="false" />  <param name="MaxBackupIndex" value="2" />  <param name="MaxFileSize" value="1024" />  <layout ... >    ... ...  </layout></appender>... ... ... ...          

创建PatternLayout对象

可以为PatternLayout类的构造方法传递参数ConversionPattern。

 

... ... ... ...<layout class="org.apache.log4j.PatternLayout>  <param name="Conversion" value="%d [%t] %p - %m%n" /></layout>... ... ... ...