【转】org.apache.log4j.Logger 详解

org.apache.log4j.Logger 详解

1. 概述

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

http://logging.apache.org/log4j/ 官网地址

1.2. Log4j 简介

       　在强调可重用组件开发的今天，除了自己从头到尾开发一个可重用的日志操作类外， Apache 为我们提供了一个强有力的日志操作包 -Log4j 。　　 
　　 Log4j 是 Apache 的一个开放源代码项目，通过使用 Log4j ，我们可以控制日志信息输送的目的地是控制台、文件、 GUI 组件、甚至是套接口服 务器、 NT 的事件记录器、 UNIX Syslog 守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就 是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。　　 
　　此外，通过 Log4j 其他语言接口，您可以在 C 、 C+ + 、 .Net 、 PL/SQL 程序中使用 Log4j ，其语法和用法与在 Java 程序中一样，使得多语言分布式系统得到一个统一一致的日志组件模块。而且，通 过使用各种第三方扩展，您可以很方便地将 Log4j 集成到 J2EE 、 JINI 甚至是 SNMP 应用中。

2. 一个简单的实例

  项目结构：

Java 代码：

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

配置文件 log4j.properties:

Properties 代码

# 可以设置级别： debug>info>error  

#debug ：显示 debug 、 info 、 error  

#info ：显示 info 、 error  

#error ：只 error  

# 也就是说只显示比大于等于当前级别的信息

log4j.rootLogger=debug,appender1  

#log4j.rootLogger=info,appender1  

#log4j.rootLogger=error,appender1    

# 输出到控制台   

log4j.appender.appender1=org.apache.log4j.ConsoleAppender  

# 样式为 TTCCLayout  

log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  

输出结果：

Console 代码

[main] DEBUG com.coderdream.log4j.HelloLog4j - This is debug message.  

[main] INFO com.coderdream.log4j.HelloLog4j - This is info message.  

[main] ERROR com.coderdream.log4j.HelloLog4j - This is error message.  

通过配置文件可知，我们需要配置 3 个方面的内容：

1 、根目录（级别和目的地）；

2 、目的地（控制台、文件等等）；

3 、输出样式。

下面我们来看看Log4J 的类图： 

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

2 . 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 就是指 B 日志信息输出到哪个地方。您可以同时指定多个输出目的地。

　　 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. 示例 2 ～示例 8

【示例 2 】 输出为文本文件或 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  

【 示例3 】 输出为文本文件或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  

【 示例 4 】 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.

【示例5 】 自定义样式

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.

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

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  

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

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

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