Log4J与JBuilder、Eclipse配合使用指南

本文虽然短小但是对一般开发者已经够用,文中描写Log4JJbuilderEclipse的应用过程,及其简单明了,这是一个很好的起步,我相信。

1、概述

Log4JLog4家族的员,Log4家族包挂:看4之后的字母都知道这是给哪种环境而开发的API。其中我们要介绍的Log4j当然就是针对Java而开发的API了。

Log4家族

Log4C

适合C

Log4CPlus/Log4cpp

适合C++

Log4j

适合Java

Log4Net

适合DOTNet

Log4Perl

适合Perl

Log4PHP

适合PHP

Log4PLSQL

适合PL/SQL

Log4LS

适合LotusScript

Log4py/Log4p

适合python

qmmslog

适合Qt/C++ 平台

Log4r

适合Ruby

JDK1.4's util.logging framework

适合JDK1.4Util

我们省略了对Log4j的长篇大论,简要的概括它的作用:它是应用程序日志的输出接口,输出格式和输出位置自定,开发过程中可以使用,运行过程中也可以使用。日志类别主要有:

日志类别

DEBUG

调试信息

INFO 

一般信息

WARN

警告信息

ERROR

错误信息

FATAL

严重错误信息

也就是说你可以根据这些级别定义输出日志的类型。我们还是直接进入如何使用,不要讲太多的理论。

2、下载Log4J

下载地址是:http://logging.apache.org/site/binindex.cgi,目前可用最高版本是:

jakarta-log4j-1.2.8,根据不同平台有不同的包,比如windows平台:jakarta-log4j-1.2.8.zip,解压之后找到:jakarta-log4j-1.2.8/dist/lib目录下的log4j-1.2.8.jar文件,这就是我们要用的jar文件了,其他文件暂时搁置不动。把这个文件拷贝到指定位置,比如D:/Lib目录下。(待会我们会在应用程序工程中添加这个文件)。

3、在JBuilder创建一个应用

过程可以参考其他资料

4、添加log4j-1.2.8.jarJBuilder工程

4.1、建立“User Home”库(以JBuilder9试用版本为例子)

       点击菜单【Tools】-【Configure Libraries】开启库文件设计对话框,在树型目录中选中“User Home”,点击【New….】按钮,弹出配置对话框,在“Name”位置输入Log4jLIB,然后点击【Add….】按钮,通过目录树导航到log4j-1.2.8.jar所在的目录,比如d:/Lib目录,选中log4j-1.2.8.jar,点击3次【OK】回到JBuilder的主界面。这样你就建立了库文件关联了。让JBuilder可以使用Log4j的最新版本。其实在高级的JBuilder版本中已经包含了Log4j的库文件了,也就是这一步骤可以省略。

4.2、向工程添加库文件引用

       JBuilder的“Project”对话框中右击工程名称,在弹出的Pop菜单中选择“Properties”,开启工程属性对话框,选择【paths】标签-【Required Libraries】标签-【Add….】按钮,选择“Log4jLIB”,点击2次【OK】回到JBuilder的主界面,这样就完成了工程添加库文件引用。

5Log4j输出格式定义

       Log4j的格式定义是通过一个“.properties”文件定义的,该文件里面定义了很多关于数定格式和输出位置的元素,看看下面例子的.properties文件(例子中以Log4j.properties为名称)。切换log4j.rootLogger=debug, B1B1或是A1,以及注释不同位置,实现日志输出到文件还是控制台。把这个Log4j.properties文件放置工程的最上层目录(与.jpx文件在同一目录)。

Log4j.properties的内容:

log4j.rootLogger=debug, B1

#打印到文件

#log4j.appender.A1=org.apache.log4j.RollingFileAppender

#log4j.appender.A1.File=example.log

#log4j.appender.A1.MaxFileSize=100KB

#log4j.appender.A1.MaxBackupIndex=1

#log4j.appender.A1.layout=org.apache.log4j.PatternLayout

#log4j.appender.A1.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

 

#打印到控制台

log4j.appender.B1=org.apache.log4j.ConsoleAppender

log4j.appender.B1.layout=org.apache.log4j.PatternLayout

log4j.appender.B1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n

log4j.appender.B1.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

6、在Java类文件里使用Log4j

6.1Import需要的包文件

import org.apache.log4j.*;把这个语句放置在文件的Import位置。

6.2、定义Logger对象

static Logger logger = Logger.getLogger(Frame1.class.getName());在程序申明变量的地方定义这个对象,并且是静态对象。其中的Frame1是你当前类的名称。

6.3、装载属性文件

PropertyConfigurator.configure("Log4j.properties");jbInit()方法的开始填写这个语句,把属性文件装载过来。

6.4、任何地方可以使用

    在需要日志记录的地方输入类似以下的语句:

    logger.info("日志信息");

    logger.warn("日志信息");

    logger.debug("日志信息");

    logger.fatal("日志信息");

    logger.error("日志信息");

    比如:

private void jbInit() throws Exception  {

    PropertyConfigurator.configure("Log4j.properties");

  // logonuser是登陆系统的用户名称
    
logger.info(logonuser + "
初始化开始");

   ……………….
  
logger.info(logonuser + " 初始化结束");

}

 输出结果是:

INFO [AWT-EventQueue-0] (mainFrame.java:503) - Admin 初始化开始
INFO [AWT-EventQueue-0] (mainFrame.java:1013) - Admin  初始化结束

到这里我们就完成了Log4jJBuilder的应用过程,输出日志的格式是不是很整齐,输出到文件的测试一样的过程,只是在Log4j.properties改成:

 Log4j.properties的内容:

log4j.rootLogger=debug, A1

#打印到文件

log4j.appender.A1=org.apache.log4j.RollingFileAppender

log4j.appender.A1.File=example.log

log4j.appender.A1.MaxFileSize=100KB

log4j.appender.A1.MaxBackupIndex=1

log4j.appender.A1.layout=org.apache.log4j.PatternLayout

log4j.appender.A1.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

 

#打印到控制台

#log4j.appender.B1=org.apache.log4j.ConsoleAppender

#log4j.appender.B1.layout=org.apache.log4j.PatternLayout

#log4j.appender.B1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n

#log4j.appender.B1.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

Log4j会在与Log4j.properties同目录的地方创建example.log文件,并记录日志信息,当文件的尺寸大于100KB时,log4J会创建一个新的example.log文件,同时备份example.log文件。备份的文件个数取决于MaxBackupIndex属性。
接下来的篇节我们介绍Log4jEclipse上的应用过程

7、向Eclipse添加log4j-1.2.8.jar

7.1、新建Java项目时引入

       第一种情况是在新建java项目时第二步骤选择【库L-【添加外部JAR(X)-选择log4j-1.2.8.jar,点击【打开】回到新建工程第二步骤的界面,点击完成。这样就引入了需要的库文件了。

7.2、向已经存在工程添加log4j-1.2.8.jar

如果工程已经存在,通过右击工程名称-【属性】-【java构建路径】-【添加外部JAR(X)-选择log4j-1.2.8.jar,点击【打开】回到新建工程属性的界面-【确定】会到工程的界面。

7.3、导入Log4j.properties文件

       通过工程的导入功能,直接把Log4j.properties文件导入到与工程最高层的目录。其他步骤同6.16.4

7.4、一个普通的应用结构如下的内容:

/*

 * Created on 2004-10-10

 */

package com.log4j;

import org.apache.log4j.*;

 

/**

 * @author Jem.lee

 */

public class MyLogTest {

   

    static Logger logger = Logger.getLogger(MyLogTest.class.getName());

 

    public static void main(String[] args) {

        PropertyConfigurator.configure("Log4j.properties");

        MyLogTest.logger.info("测试信息开始");

        MyLogTest.logger.info("测试信息结束");

    }

}

 输出结果:

INFO [main] (MyLogTest.java:16) - 测试信息开始

INFO [main] (MyLogTest.java:17) - 测试信息结束

8、总结

使用Log4j可以实现日志的记录的输出工作,其实很多应用都会带一个日志管理模块,如何充分的利用日志也是系统一大特点,自行开发日志类功能和操作的方式可能好于Log4j,但是我相信绝大部分不可能,不如使用现成的API,效率提高了,规范整齐了,一切都好了。

你可能感兴趣的:(java,eclipse,log4j,import,JBuilder,log4net)