学习log4j日志文件之利器

（一）如何使用Log4j？

1、 Log4j是什么？
Log4j可以帮助调试（有时候debug是发挥不了作 用的）和分析，要下载和了解更详细的内容，还是访问其官方网站吧： http://jakarta.apache.org/log4j 。

2、Log4j的概念
   Log4j中有三个主要的组件，它们分别是 Logger、Appender和Layout，Log4j 允许开发人员定义多个Logger，每个Logger拥有自己的名字，Logger之间通过名字来表明隶属关系。有一个Logger称为Root，它永远 存在，且不能通过名字检索或引用，可以通过Logger.getRootLogger()方法获得，其它Logger通过 Logger.getLogger(String name)方法。
   Appender则是用来指明将所有的log信息存放到什么地方，Log4j中支持多种appender，如 console、files、GUI components、NT Event Loggers等，一个Logger可以拥有多个Appender，也就是你既可以将Log信息输出到屏幕，同时存储到一个文件中。
   Layout的作用是控制Log信息的输出方式，也就是格式化输出的信息。
   Log4j中将要输出的Log信息定义了5种级别，依次为DEBUG、INFO、WARN、ERROR和FATAL，当输出时，只有级别高过配置中规定的 级别的信息才能真正的输出，这样就很方便的来配置不同情况下要输出的内容，而不需要更改代码，这点实在是方便啊。

3、Log4j的配置文件
虽然可以不用配置文件，而在程序中实现配置，但这种方法在如今的系统开发中显然是不可取的，能采用配置文件的地方一定一定要用配置文件。Log4j支持两 种格式的配置文件：XML格式和Java的property格式，本人更喜欢后者，首先看一个简单的例子吧，如下：

log4j.rootLogger=debug, stdout, R
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log
log4j.appender.R.MaxFileSize= 100KB

# Keep one backup file
log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n         

首先，是设置root，格式为 log4j.rootLogger=[level],appenderName, ...，其中level就是设置需要输出信息的级别，后面是appender的输出的目的地，appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。 配置日志信息输出目的地Appender，其语法为
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
...
log4j.appender.appenderName.option = valueN
Log4j提供的appender有以下几种：
org.apache.log4j.ConsoleAppender（控制台）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生新文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
配置日志信息的格式（布局），其语法为：
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
....
log4j.appender.appenderName.layout.option = valueN
Log4j提供的layout有以下几种：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： %m 输出代码中指定的消息

　　 %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目，通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符，Windows平台为“\r\n”，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)

4、Log4j在程序中的使用
要在自己的程序中使用Log4j，首先需要将commons-logging.jar和logging-log4j-1.2.9.jar导入到构建路径 中。然后再将log4j.properties放到src根目录下。这样就可以在程序中使用log4j了。在类中使用log4j， 首先声明一个静态变量 Logger logger=Logger.getLog("classname")；现在就可以使用了，用法如下：logger.debug("debug message")或者logger.info("info message")，看下面一个小例子：

import com.foo.Bar;
import org.apache.log4j.Logger;
   import org.apache.log4j.PropertyConfigurator;
   public class MyApp {
static Logger logger = Logger.getLogger(MyApp.class.getName());
   public static void main(String[] args) {
    // BasicConfigurator replaced with PropertyConfigurator.
     PropertyConfigurator.configure(args[0]);
      logger.info("Entering application.");
      Bar bar = new Bar();
      bar.doIt();
      logger.info("Exiting application.");
    }
   }

2008-01-11 00:00

log4j，字面意思就是针对j（Java）的日志。
log4j，可以记录显示Java程序运行的每一步的数据，相当于System.out.print，不过，它是以一个日志文件显示所标识的运行信息，不用在java运行显示台上看输出信息，比较方面。
log4j，记录的数据，可以作为判断程序运行状态的重要依据，更多的应是查找程序运行BUG的重要依据，特别是程序已发布，不能做单步调试的情况下，它的优越性就突显出来了。
引用一个对log4j的功能比较专业的描述：

1、监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；
2、跟踪代码运行时轨迹，作为日后审计的依据；
3、担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。

以前偶尔的用过几次，但一次没形成习惯和一套良好的应用机制，自咎主要原因是对log4j掌握的还是不够，亟待提升。

今天就花时间找些资源研究研究。

在网上搜到一些文章，首先看的是IBM中国网站上的一篇技术文章（http://www-128.ibm.com/developerworks/cn/java/l-log4j/index.html）讲得比较基础，也很详细，对log4j的使用讲得全面而贴切，甚利于初次学习，发表日期是2002/6/19（有点早）。

1、去网站（http://logging.apache.org/log4j/docs/download.html）下载log4j的jar包，直接下载log4j-1.2.13版链接：http://mirror.vmmatrix.net/apache/logging/log4j/1.2.13/logging-log4j-1.2.13.zip；
2、解开log4j.jar文件放到web应用程序的WEB-INF/lib下面；
3、编写文件名为log4j.properties 配置文件到java源文件的根目录中；
4、在自己的程序中构建日志记录器；
5、利用记录器标识要输入的信息。

第二步如果是在java的一般应用程序中应用log4j，则在环境变量CLASSPATH中添加一个指向log4j.jar的值。
第三步把命名为log4j.properties的log4j配置文件放在java源文件目录中是一个简洁的办法，可以在程序中自定义的指定log4j的配置文件，配置文件名称和存放路径都可自定义。

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：
BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面引用的是使用Java特性文件做为配置文件的方法（不用XML解析器）：

配置根Logger，其语法为：
log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。
appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
配置日志信息输出目的地Appender，其语法为
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN其中，Log4j提供的appender有以下几种：
org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
配置日志信息的格式（布局），其语法为：
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN其中，Log4j提供的layout有以下几种：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

下面是一个log4j配置文件的例子（内容不含前面的行号）：

1log4j.rootLogger=INFO, A1 , R
2
3log4j.appender.A1=org.apache.log4j.ConsoleAppender
4log4j.appender.A1.layout=org.apache.log4j.PatternLayout
5log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n
6
7log4j.appender.R=org.apache.log4j.RollingFileAppender
8log4j.appender.R.File=$TOMCAT_HOME/logs/log4j.log
9##将$TOMCAT_HOME换成tomcat的安装目录,也可以指定一个存在的任意目录
10log4j.appender.R.MaxFileSize=100KB
11log4j.appender.R.MaxBackupIndex=1
12log4j.appender.R.layout=org.apache.log4j.PatternLayout
13log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

第1行的值INFO，表示输出INFO级以上的日志，如果设成OFF则表示不输出，A1和R是自定义的两种输出方式（可以自定义n种输出方式），其详细内容在后面有定义；
第3行定义A1是输出到控制台；
第7行定义R是输出到文件，并且控制文件在指定大小，超过指定大小自动按指定形式创建一个新名称的日志文件；

一般是以指定格式的文本输出日志，输出比较快捷，也可以定义HTML格式的日志输出，阅读方便，但稍微有点慢。

现在，可以象使用System.out.println一样标识程序输出信息了看一个在程序中应用log4j的简单例子。

import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.SimpleLayout;
import org.apache.log4j.FileAppender;
public class simpandfile {
    //获取log4j日志记录器
   static Logger logger = Logger.getLogger(simpandfile.class);
   public static void main(String args[]) {
       //新建一个日志输出样式
       SimpleLayout layout = new SimpleLayout();

       FileAppender appender = null;
      try {
           //定义输出文件
          appender = new FileAppender(layout,"output1.txt",false);
       } catch(Exception e) {}

       logger.addAppender(appender);
       //设置日志输出等级为DEBUG
       logger.setLevel((Level) Level.DEBUG);
      //以各种等级标识输出信息
       logger.debug("Here is some DEBUG");
       logger.info("Here is some INFO");
       logger.warn("Here is some WARN");
       logger.error("Here is some ERROR");
       logger.fatal("Here is some FATAL");
    }
}

(二)再学习log4j:

如果定义了log4j的输出配置文件，在程序中获取日志记录器后就可以直接标识日志输出信息。

[***]　在判断DEBUG/INFO级别的信息是否要加入日志文件前，记录器提供isDebugEnabled()/isInfoEnabled()方法判断当前级别是否激活，这样处理减少日志处理信息时再判断当前级别是否激活消耗的资源，提高运行性能。

补加：

刚发现log4e（http://log4e.jayefem.de/index.php/Download）这个eclipse的插件，它实现的功能是鼠标点击几下，就可以自动生产log标识，免去手敲的体力。
至于怎么用，就很简单了，跟它的插件一样安装，装完后，在eclipse的编辑区右键菜单中会多一个log4e项，所有操作都在这里了。

学习永远没有止境，我只是接触了一下这个工具，拥有日志的功能，记录程序的运行过程，如果程序出问题了或者是程序崩溃了，可以从日志文件找出问题所在，当然了，这也不是绝对的。要养成良好的习惯，多用，多想，才能编出好的程序。我还学习了java程序开发的四成结构，虽说都是皮毛，只是用一个小小的图书管理系统搞了一下，但毕竟是学习了一些，在以后的学习中慢慢积累吧！