BlogJava-asdtiang-java study-随笔分类-java 日志学习

java log4j使用

asdtiang — Tue, 12 Jan 2010 09:22:00 GMT

log4j使用方法

1、定义配置文件

首先使用配置文件将使我们的应用程序更加灵活配置log日志输出方式包括输出优先级、输出目的地、输出格式。Log4j支持两种配置文件格式，一种是 XML格式的文件，一种是Java特性文件log4j.properties（键=值）。下面将介绍使用log4j.properties文件作为配置文件的方法：

①配置根Logger，其语法为：0

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采用类似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)

2、在代码中使用Log4j

①得到记录器

使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

public static Logger getLogger( String name)

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

②读取配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：

BasicConfigurator.configure ()：自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。

例：PropertyConfigurator.configure(".\\src\\log4j.properties")
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

③插入记录信息（格式化日志信息）

当上两个必要步骤执行完毕，就可轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;

log4j范例程序

下面将使用一个最简单的范例程序来进一步说明log4j的使用方法。程序代码如下：

import org.apache.log4j.*;

public class LogTest {

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

public static void main(String[] args) {

PropertyConfigurator.configure ( “.\\src\log4j.properties”)；

logger.debug("Debug ...");

logger.info("Info ...");

logger.warn("Warn ...");

logger.error("Error ...");

}

}

程序说明：

① static Logger logger = Logger.getLogger(LogTest.class.getName());就是创建一个属于LogTest类的Logger对象，创建时要告知Logger你当前的Class是什么。

② PropertyConfigurator.configure ( “log4j.properties”)就是说使用当前工程目录下的src文件夹中的log4j.properties文件作为配置文件。若将 log4j.properties放在工程根目录下也可不写此句，程序会自动找到配置文件。

③ logger.debug就是输出debug的信息，logger.info就是输出提示信息，logger.warn就是显示警告信息，logger.error就是显示错误信息。

下面是配置文件log4j.properties的内容：

log4j.rootCategory=DEBUG, stdout，R

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

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

log4j.appender.stdout.layout.ConversionPattern=%5p (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender

log4j.appender.R.File=log.txt

log4j.appender.R.MaxFileSize=100KB

log4j.appender.R.MaxBackupIndex=1

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

log4j.appender.R.layout.ConversionPattern=%d{yyyy MMM dd HH:mm:ss} %-5p %c - %m%n

程序说明：

① log4j.rootCategory=DEBUG, stdout，R

就是说我要显示所有优先权等於和高于Debug的信息。
"stdout"，”R”表示我定义了两个输出端(随便什么名字都好)。

②下面的三行说stdout输出端其实是标准输出Console，也就是屏幕。输出的格式是PatternLayout。转换方式是%5p (%F:%L) - %m%n，即前五格用来显示优先权，再显示当前的文件名，加当前的行数。最后是logger.debug()或logger.info()或 logger.warn()或logger.error()里的信息。%n表示回车空行。

③再加上下面六行则log信息不光显示在屏幕上，而且将被保存在一个叫"log.txt"的文件里，文件最大为100KB。如果文件大小超过100KB，文件会被备份成"log.txt.1"，新的"log.txt"继续记录log信息。

接下来我们可以改变log4j.properties，而不需重新编译就可以控制log信息是否显示、log信息的输出端类型、输出方式、输出格式，等等。举例如下：

①在log4j.properties文件里把"log4j.rootCategory=DEBUG,stdout,R"改写成"log4j.rootCategory=OFF, stdout,R"，这样所有的log信息都不会显示了；解决了本文开始提出的问题。
②在log4j.properties文件里把"log4j.rootCategory=DEBUG,stdout,R"改写成"log4j.rootCategory=INFO, stdout,R"，这样只显示INFO, WARN, ERROR的log信息，而DEBUG信息不会被显示；

在web程序中使用log4j注意问题

1、由于jsp或servlet在执行状态时没有当前路径概念，所有使用PropertyConfigurator.configure（String）语句找log4j.properties文件时要给出相对于当前jsp或servlet的路径转化成为一个绝对的文件系统路径。方法是使用 servletcontext.getrealpath(string)语句。例：

//得到当前jsp路径

String prefix = getServletContext().getRealPath("/");

//读取log4j.properties

PropertyConfigurator.configure(prefix+"\\WEB-INF\\log4j.properties");

2、相应的log4j.properties设置某个属性时也要在程序中设置绝对路径。例：

log4j.appender.R.File属性设置日志文件存放位置。我们可以用读写.properties配置文件的方法进行灵活设置。

asdtiang 2010-01-12 17:22 发表评论

JAVA 日志系统简介--转

asdtiang — Tue, 12 Jan 2010 09:21:00 GMT

日志，源于log，有航海日志的意思。指记录海员记录每天的行程，生活及发生的事件。在软件开发领域，用来监控代码中变量变化，跟踪代码运行的轨迹，在开发环境中担当调试器作用，向控制台或文件输出信息。

几乎所有的软件开发语言（平台）都有自己的日志系统，java，.net，ruby，php等。在java领域，存在大量的日志组件，open-open收录了21个日志组件。

从功能上讲，这些可以分为三类，一是日志工具类，它实现了日志的记录，格式化和级别的划分，代表为 logback，simplelog。二是日志系统，提供了完整的框架功能并实现了日志记录。代表为jul（jdk提供的日志框架），log4j（apache开源项目）。三是抽象整合类，它提供了一组接口，完成日志功能，通过包装其他日志工具或系统来工作jcl（apache开源组件），slf4j。

从历史上讲，log4j出现最早，Ceki Gülcü是其创造者。自java1.4开始，jdk提供了java.util.logging 类库，提供了一个完整的日志框架，在设计上要比log4j要更清晰。这个时候，除此之外，还有一些其他日志组件，java领域从来不缺少轮子，总是有人在发明轮子，轮子多了，就会产生混乱，就会有人站出来，要一统江湖，于是，jcl，apache一个开源的日志组件诞生了，它提供了一组日志系统的接口，通过对 log4j，jul和simplelog进行包装，提供日志功能。这样，开发的时候，只需要使用jcl，通过配置，灵活选择底层实现。这样，对于开发人员来说，开发更简单了些。看起来一切太平了，可Ceki Gülcü认为，应该有一个更好的日志框架。log4j经过这么久的发展，已经成为了一个巨人，亦伤痕累累，从外面看，经典，庄重，强壮，从内部看，却有着一根根的飞线（ThinkPad），充满了代码的坏味道。或许他没有勇气来改造这个巨人，离开也许是最好的选择，于是，出来，创建了slf4j，来取代jcl，创建了logback，来取代log4j。目前，log4j和jul应用最为广泛，slf4j作为新兴的抽象层，整合logback，以其简洁，快速，正被越来越多的顶级项目使用。

代表日志组件简要介绍。

Log4j，历史悠久，应用广泛，被移植到多种语言及平台，功能强大，在众多的日志框架中，仍占据着主导地位。

Jul，jdk提供的日志框架，设计精良，和jdk紧密结合，控制灵活，使用简单。

Jcl，提供了日志的抽象层，可以整合多种实现。但有classloader问题。

Slf4j，提供了jcl的超集，避免了classloader问题。

Logback，可靠，通用，快速，灵活的java日志工具（官方描述）。

项目选择思考。

如果是单一的项目，如桌面应用，采用jul，免配置，控制灵活。

如果是web开发，宜采用 log4j，因为系统已经有了很多的配置文件，不在乎多一个，而且log4j可以脱离任何组件，不像jul，和jvm紧密结合在一起。

如果是多项目整合开发，宜采用 slf4j，一是它可以整合其他遗留日志组件，二是其提供的抽象层，为将来的开发提供了灵活性。

参考资料：

1．IBM developerworks对 log4j的介绍。链接

2．Java开源日志组件列表。链接

3．Slf4j官方网站。链接

4．Logback官方网站。链接

5．Log4j官方网站。链接

6．Jcl官方网站。链接

7．Sun官方网站。链接

8．一个jcl的中文说明。链接

asdtiang 2010-01-12 17:21 发表评论