log4j—— 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. 一个简单的实例

我们需要配置 3 个方面的内容：

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

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

3 、输出样式。

log4j.rootLogger=DEBUG,std,file
#debug是一个输出级别，std和file表示输出的控制器，可以定义多个，std设置为控制台输出，file设置为文件输出
log4j.appender.std=org.apache.log4j.ConsoleAppender
#追加器，在log4j的依赖中org.apache.log4j包下有许多appender供我们选择，将日志进行输出，这里选择ConsoleAppender，表示将日志输出到控制台
log4j.appender.std.layout=org.apache.log4j.SimpleLayout
#同样这里定义输出日志的布局方式，具体可以在org.apache.log4j包下查看，这里使用简单的布局


log4j.appender.file=org.apache.log4j.FileAppender
#设置文件输出
log4j.appender.file.File=d:/mybatis.log
#输出的文件路径
#log4j.appender.file.layout=org.apache.log4j.SimpleLayout
log4j.appender.file.layout=org.apache.log4j.PatternLayout
#自定义的输出格式
log4j.appender.file.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n

 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)