Log4j

Logger - 日志写出器 ，供程序员输出日志信息 
Appender - 日志目的地 ，把格式化好的日志信息输出到指定的地方去 
Layout - 日志格式化器 ，用来把程序员的 logging request 格式化成字符串

Log4j 基本使用方法 
　　 Log4j 由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式 。日志信息的优先级从高到低有 ERROR 、 WARN 、 INFO 、 DEBUG ，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。 
1 、定义配置文件 
　　    其实您也可以完全不使用配置文件，而是在代码中配置 Log4j 环境。但是，使用配置文件将使您的应用程序更加灵活。 Log4j 支持两种配置文件格式，一种是 XML 格式的文件，一种是 Java 特性文件（键 = 值 properties 文件）。下面我们介绍使用 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 有以下几种： 
　　        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 （将日志信息以流格式发送到任意指定的地方）

　　 3) 配置日志信息的格式（布局），其语法为： 
　　　　  log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
　　　　  其中， Log4j 提供的 layout 有以 e 几种： 
　　        1.org.apache.log4j.HTMLLayout （以 HTML 表格形式布局）， 
　　        2.org.apache.log4j.PatternLayout （可以灵活地指定布局模式）， 
　　        3.org.apache.log4j.SimpleLayout （包含日志信息的级别和信息字符串）， 
　　        4.org.apache.log4j.TTCCLayout （包含日志产生的时间、线程、类别等等信息） 
　　 　　Log4J 采用类似 C 语言中的 printf 函数的打印格式格式化日志信息，打印参数如下： %m 输出代码中指定的消息 
　　 　　%p 输出优先级，即 DEBUG ， INFO ， WARN ， ERROR ， FATAL
　　 　　%r 输出自应用启动到输出该 log 信息耗费的毫秒数 
　　 　　%c 输出所属的类目，通常就是所在类的全名 
　　 　　%t 输出产生该日志事件的线程名 
　　　　 %n 输出一个回车换行符， Windows 平台为 “rn” ， 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 
　　 1. 得到记录器 
　　 　　使用 Log4j ，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为： 
　　 　　public static Logger getLogger( String name) 
　　　　 通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。 Name 一般取本类的名字，比如： 
　　　　 static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) 
　　 2. 读取配置文件 
　　　　 当获得了日志记录器之后，第二步将配置 Log4j 环境，其语法为： 
　　　　 BasicConfigurator.configure () ： 自动快速地使用缺省 Log4j 环境。 
　　 　　PropertyConfigurator.configure ( String configFilename) ：读取使用 Java 的特性文件编写的配置文件。 
　　 　　DOMConfigurator.configure ( String filename ) ：读取 XML 形式的配置文件。 
　 　 3. 插入记录信息（格式化日志信息） 
　　　　 当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下： 
　　　　 Logger.debug ( Object message ) ;
　　 　　Logger.info ( Object message ) ;
　　　　 Logger.warn ( Object message ) ;
　　 　　Logger.error ( Object message ) ;  

3. 示例 1 ～示例 7

【示例 1 】 输出为文本文件或 HTML 文件

Porperties 代码

1. # 设置级别：   
2. log4j.rootLogger=debug,appender1    
3. log4j.appender.appender1=org.apache.log4j.FileAppender  
4. # 设置文件输出路径   
5. log4j.appender.appender1.File=c:/Log4JDemo02.html  
6. # 设置文件输出样式   
7. log4j.appender.appender1.layout=org.apac he.log4j.HTMLLayout  

【 示例 2 】 输出为文本文件或HTML 文件

Properties 代码

1. # 设置级别和多个目的地   
2. log4j.rootLogger=debug,appender1,appender2    
3. # 输出到控制台   
4. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
5. log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout    
6. # 输出到文件 ( 这里默认为追加方式 )  
7. log4j.appender.appender2=org.apache.log4j.FileAppender  
8. log4j.appender.appender2.File=c:/Log4JDemo02.html  
9. log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout  

 【 示例 3 】 SimpleLayout 样式

Properties 代码

1. # 设置级别和目的地   
2. log4j.rootLogger=debug,appender1    
3. # 输出到控制台   
4. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
5. # 设置输出样式   
6. log4j.appender.appender1.layout=org.apache.log4j.SimpleLayout  

控制台代码

       DEBUG - This is debug message.

       INFO - This is info message.

       ERROR - This is error message.

 【示例4 】 自定义样式

Java 代码

1. # 设置级别和目的地   
2. log4j.rootLogger=debug,appender1    
3. # 输出到控制台   
4. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
5. # 设置输出样式   
6. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
7. # 自定义样式   
8. log4j.appender.appender1.layout.ConversionPattern =%r [%t] [%p] - %c -%l -%m%n  

　　# 自定义样式

　　# %r 时间 0

　　# %t 方法名 main

　　# %p 优先级 DEBUG/INFO/ERROR

　　# %c 所属类的全名 ( 包括包名 )

　　# %l 发生的位置，在某个类的某行

　　# %m 输出代码中指定的讯息，如 log(message) 中的 message

　　# %n 输出一个换行

　　log4j.appender.appender1.layout.ConversionPattern =%r [%t] [%p] - %c -%l -%m%n 输出结果：

控制台代码

　　0 [main] [DEBUG] - com.coderdream.log4j.HelloLog4j -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:16 ) -This is debug message.

　　31 [main] [INFO] - com.coderdream.log4j.HelloLog4j -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:18 ) -This is info message.

　　31 [main] [ERROR] - com.coderdream.log4j.HelloLog4j -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:20 ) -This is error message.

【示例5 】 多目的地、自定义样式

Properties 代码

1. # 设置级别和目的地   
2. log4j.rootLogger=debug,appender1,appender2    
3. # 输出到控制台   
4. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
5. # 设置输出样式   
6. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
7. log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
8. # 输出到文件 ( 这里默认为追加方式 )  
9. log4j.appender.appender2=org.apache.log4j.FileAppender  
10. # 设置文件输出路径   
11. log4j.appender.appender2.File=c:/Log4JDemo06.log  
12. # 设置文件输出样式   
13. log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
14. log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  

【示例 6 】 【企业应用】设置 特定包的级别和目的地

先增加一个包，新建一个类：

Java 代码

1. package com.coderdream.log4jDao;    
2. import org.apache.log4j.Logger;    
3. public class HelloDao {  
4.     private static Logger logger = Logger.getLogger(HelloDao.class);  
5.     public static void main(String[] args) {  
6.         //  记录 debug 级别的信息   
7.         logger.debug("This is debug message from Dao.");  
8.         //  记录 info 级别的信息   
9.         logger.info("This is info message from Dao.");  
10.         //  记录 error 级别的信息   
11.         logger.error("This is error message from Dao.");  
12.     }  
13. }  

      如果这个类作为基类，如 J2EE 中的 BaseDao 、 BaseAction 、 BaseService 等等，则我们可以将各层的日志信息分类输出到各个文件。

Properties 代码

1. # 省略根，只设置特定包的级别和目的地    
2. log4j.logger.com.coderdream.log4j =debug,appender1  
3. log4j.logger.com.coderdream.log4jDao =info,appender1,appender2    
4. # 输出到控制台   
5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
6. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
7. log4j.appender.appender1.layout.ConversionPattern =[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
8. # 输出到文件 ( 这里默认为追加方式 )  
9. log4j.appender.appender2=org.apache.log4j.FileAppender  
10. log4j.appender.appender2.File=c:/Log4JDemo07_Dao.log  
11.  log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
12. log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n   

补充：

1.java 中的应用

　           Logger.debug(Object message);// 调试信息 
　　        Logger.info(Object message);// 一般信息 
　　        Logger.warn(Object message);// 警告信息 
　　        Logger.error(Object message);// 错误信息 
　　        Logger.fatal(Object message);// 致命错误信息

2. # 当输出信息于回滚文件时

           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  　　

3. 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 
　　 www.wuset.com ">log4j.appender.MAIL.From=web@www.wuset.com 
　　 log4j.appender.MAIL.SMTPHost=www.wusetu.com 
　　 log4j.appender.MAIL.Subject=Log4J Message 
　　 www.wusetu.com ">log4j.appender.MAIL.To=web@www.wusetu.com 
　　 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 = corlin@cybercorlin.net

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