`
CoderDream
  • 浏览: 478499 次
  • 性别: Icon_minigender_1
  • 来自: 武汉
社区版块
存档分类
最新评论

log4j详解与实战

log4jApacheDAOC#C 
阅读更多

log4j是一个非常强大的log记录软件，下面我们就来看看在项目中如何使log4j。

 

首先当然是得到log4j的jar档，推荐使用1.2.X版，下载地址：

http://logging.apache.org/log4j/1.2/download.html

 

我们先看一个最简单的示例：

【示例1】

项目结构：



【注：由于这里的多个项目公用一个jar档，我们可以创建一个专门放置jar档的Java工程，然后将jar档放到lib目录下。在要使用的工程中按图所示进行引用 】


Java代码： 

package com.coderdream.log4j;

import org.apache.log4j.Logger;

public class HelloLog4j {

	private static Logger logger = Logger.getLogger(HelloLog4j.class);

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		// System.out.println("This is println message.");
		
		// 记录debug级别的信息
		logger.debug("This is debug message.");
		// 记录info级别的信息
		logger.info("This is info message.");
		// 记录error级别的信息
		logger.error("This is error message.");
	}
}

  配置文件log4j.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

输出结果： 

[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 - 日志目的地，把格式化好的日志信息输出到指定的地方去
ConsoleAppender - 目的地为控制台的Appender
FileAppender - 目的地为文件的Appender
RollingFileAppender - 目的地为大小受限的文件的Appender
Layout - 日志格式化器，用来把程序员的logging request格式化成字符串
PatternLayout - 用指定的pattern格式化logging request的Layout


Log4j基本使用方法

　　Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显 示内容。

　　一、定义配置文件

　　其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用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.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（将日志信息以流格式发送到任意指定的地方）

　　3.配置日志信息的格式（布局），其语法为：

　　log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
　　log4j.appender.appenderName.layout.option1 = value1
　　…
　　log4j.appender.appenderName.layout.option = valueN

　　其中，Log4j提供的layout有以e几种：
　　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平台为“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)

　　二、在代码中使用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 ) ;

 

示例2～示例8

 

【示例2】 输出为文本文件或HTML文件

#设置级别：
log4j.rootLogger=debug,appender1

#输出到文件(这里默认为追加方式)
log4j.appender.appender1=org.apache.log4j.FileAppender
#设置文件输出路径
#【1】文本文件
#log4j.appender.appender1.File=c:/Log4JDemo02.log
#【2】HTML文件
log4j.appender.appender1.File=c:/Log4JDemo02.html
#设置文件输出样式
#log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout
log4j.appender.appender1.layout=org.apache.log4j.HTMLLayout

 

【 示例3】 输出为文本文件或HTML文件

#设置级别和多个目的地
log4j.rootLogger=debug,appender1,appender2

#输出到控制台
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#设置输出样式
log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout

#输出到文件(这里默认为追加方式)
log4j.appender.appender2=org.apache.log4j.FileAppender
#设置文件输出路径
#【1】文本文件
#log4j.appender.appender2.File=c:/Log4JDemo02.log
#【2】HTML文件
log4j.appender.appender2.File=c:/Log4JDemo02.html
#设置文件输出样式
#log4j.appender.appender2.layout=org.apache.log4j.TTCCLayout
log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout
 

【示例4】 SimpleLayout样式

#设置级别和目的地
log4j.rootLogger=debug,appender1

#输出到控制台
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#设置输出样式
log4j.appender.appender1.layout=org.apache.log4j.SimpleLayout

  输出结果： 

DEBUG - This is debug message.
INFO - This is info message.
ERROR - This is error message.
 

【示例5】 自定义样式

#设置级别和目的地
log4j.rootLogger=debug,appender1

#输出到控制台
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#设置输出样式
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
#自定义样式
# %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】 多目的地、自定义样式

#设置级别和目的地
log4j.rootLogger=debug,appender1,appender2

#输出到控制台
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#设置输出样式
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
#自定义样式
# %r 时间 0
# %t 方法名 main
# %p 优先级 DEBUG/INFO/ERROR
# %c 所属类的全名(包括包名)
# %l 发生的位置，在某个类的某行
# %m 输出代码中指定的讯息，如log(message)中的message
# %n 输出一个换行符号
log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n

#输出到文件(这里默认为追加方式)
log4j.appender.appender2=org.apache.log4j.FileAppender
#设置文件输出路径
#【1】文本文件
log4j.appender.appender2.File=c:/Log4JDemo06.log
#设置文件输出样式
log4j.appender.appender2.layout=org.apache.log4j.PatternLayout
log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n
 

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

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

package com.coderdream.log4jDao;

import org.apache.log4j.Logger;

public class HelloDao {
	private static Logger logger = Logger.getLogger(HelloDao.class);

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		// 记录debug级别的信息
		logger.debug("This is debug message from Dao.");
		// 记录info级别的信息
		logger.info("This is info message from Dao.");
		// 记录error级别的信息
		logger.error("This is error message from Dao.");
	}
}

      如果这个类作为基类，如J2EE中的BaseDao、BaseAction、BaseService等等，则我们可以将各层的日志信息分类输出到各个文件。

 

#省略根，只设置特定包的级别和目的地
log4j.logger.com.coderdream.log4j=debug,appender1
log4j.logger.com.coderdream.log4jDao=info,appender1,appender2

#输出到控制台
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#设置输出样式
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
#自定义样式
# %r 时间 0
# %t 方法名 main
# %p 优先级 DEBUG/INFO/ERROR
# %c 所属类的全名(包括包名)
# %l 发生的位置，在某个类的某行
# %m 输出代码中指定的讯息，如log(message)中的message
# %n 输出一个换行符号
log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n

#输出到文件(这里默认为追加方式)
log4j.appender.appender2=org.apache.log4j.FileAppender
#设置文件输出路径
#【1】文本文件
log4j.appender.appender2.File=c:/Log4JDemo07_Dao.log
#设置文件输出样式
log4j.appender.appender2.layout=org.apache.log4j.PatternLayout
log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n
 

【示例8】 log4j.xml的配置方式

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<appender name="appender1"
		class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="logfile08.html" />
		<param name="MaxFileSize" value="1MB" />
		<param name="MaxBackupIndex" value="5" />
		<layout class="org.apache.log4j.HTMLLayout">
		</layout>
	</appender>

	<root>
		<level value="debug" />
		<appender-ref ref="appender1" />
	</root>
</log4j:configuration>

 

为了提高效率，我们可以在写日志前增加判断：

// 记录debug级别的信息
if (logger.isDebugEnabled()) {
	logger.debug("This is debug message from Dao.");
}

// 记录info级别的信息
if (logger.isInfoEnabled()) {
	logger.info("This is info message from Dao.");
}

// 记录error级别的信息
logger.error("This is error message from Dao.");

参考资料：

1、log4j 详 解( 一)

2、log4j 详解(二)

3、Log4j基本使用方法

4、Log4j 用法(一)

5、log4j.properties 使用说明

6、Apache Log4j详解

7、log4j.xml配置详解

8、log4j.xml配置详解

  • 大小: 15.2 KB
  • 大小: 43.8 KB
  • 大小: 25.9 KB
  • log4jDemo.rar (374 KB)
  • 描述: 可直接导入eclipse中运行的8个项目的源代码
  • 下载次数: 8451
分享到：
| eclipse中创建一个专门存储jar档的工程， ...
评论
37 楼 greatwqs 2010-04-20  
基础讲到了,如果还要在自己的工程中运用顺手,还得javaeye一下...
36 楼 yongcau 2010-04-15  
学习了，楼主辛苦！！！
35 楼 橘子洲头 2010-04-06  
写得非常详细，谢谢了
34 楼 lkf520java 2010-03-18  
以前只知道log4j怎么用，一直都没深入了解。
看了LZ的文章，理解深刻多了
33 楼 xumiao900 2010-03-16  
写的很详细，收藏了。
32 楼 跳跃的心灵 2010-03-04  
很好，刚好我需要，嘿嘿
31 楼 Carterslam 2010-02-20  
强烈建议此帖升精
30 楼 gufenglian 2009-12-31  
好东东，收藏了
29 楼 zuozhengfeng 2009-12-31  
确实不错啊，收藏了
28 楼 CoderDream 2009-12-04  
jiabq 写道
首先谢谢楼主提供了一个好东西。但是我想这里面还有需要完善的地方，楼主这里提到过生成log文件，但是这些文件的名称是在properties文件里写死的，可以把它写成活的。比如说我可以自动建一个文件夹是当年的年份，然后再建一个当天的日期文件夹，或者直接就把当天的日期当作log文件的名称，这样生成的log很直观，容易查找。


这样设置一下就可以了： 
#输出到文件(这里默认为追加方式)
log4j.appender.appender4=org.apache.log4j.FileAppender
#设置文件输出路径 文本文件
log4j.appender.appender4.File=ImportExportService.log
#设置文件输出样式
log4j.appender.appender4.layout=org.apache.log4j.PatternLayout
log4j.appender.appender4.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n

27 楼 jiabq 2009-12-03  
首先谢谢楼主提供了一个好东西。但是我想这里面还有需要完善的地方，楼主这里提到过生成log文件，但是这些文件的名称是在properties文件里写死的，可以把它写成活的。比如说我可以自动建一个文件夹是当年的年份，然后再建一个当天的日期文件夹，或者直接就把当天的日期当作log文件的名称，这样生成的log很直观，容易查找。
26 楼 andey007518 2009-11-09  
写的很详细，一直在寻找这样的例子，呵呵，辛苦了LZ
25 楼 本来不想注册 2009-08-15  
感谢，收藏
24 楼 tigerliang 2009-07-15  
收藏了，呵呵。
23 楼 zhiblin 2009-06-22  
像这样的文章再多一点吧
22 楼 nything 2009-06-22  
相当不错！之前光会简单的使用 不会配置，这次得好好学学 吼吼
21 楼 phz50 2009-06-22  
非常感谢，写得非常详细，如果能介绍一下一般在什么情况下要输出日志就更好了
20 楼 chen4059 2009-06-17  
sogo1986 写道
加上点log4j写入数据库的就比较完美了

在大业务量log入库就是噩梦啊。直接写磁阵最好。
19 楼 chen4059 2009-06-17  
大家如何处理logger.isDebugEnabled()的效率问题？
18 楼 石建武 2009-05-22  
谢谢楼主了 。。看完，理解的又深了一点

// if the user has not specified the log4j.configuration
// property, we search first for the file "log4j.xml" and then
// "log4j.properties"
         if(configurationOptionStr == null) {
            url = Loader.getResource(DEFAULT_XML_CONFIGURATION_FILE);
if(url == null) {
url = Loader.getResource(DEFAULT_CONFIGURATION_FILE);
}

发现Log4j是默认的先加载xml格式的配置文件呢 。。。


我觉得应该是先读取了配置文件之后，再返回一个Logger吧？愚见，请lz指点



发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    Log4j详解与实战

    **Log4j详解与实战** Log4j是Java平台上的一个广泛应用的日志框架，由Apache软件基金会开发。它提供了一种灵活、强大的日志记录机制，使得开发者可以在应用程序中轻松地进行日志输出，便于调试、性能分析以及系统...

    Log4j 详解与实战

    ### Log4j 详解与实战 #### 一、Log4j 概述 Log4j 是 Apache 的一个开源项目，它是由 Java 编写的一款功能强大的日志记录工具。Log4j 具备灵活的日志配置能力，允许开发者在运行时动态地控制日志输出的等级、格式...

    log4j详解与实战 - 企业应用

    ### log4j详解与实战 - 企业应用 在软件开发过程中，日志记录是一项非常重要的功能，它能够帮助开发者追踪程序运行状态、诊断问题以及优化性能。而在众多日志框架中，Apache Log4j 是一个非常成熟且广泛使用的工具...

    Java资料 log4j详解与实战.txt

    在“log4j详解”部分，我们首先会了解到Log4j的核心概念，包括Logger、Appender、Layout和Level。Logger是记录日志的对象，它可以设置不同的级别（如DEBUG、INFO、WARN、ERROR和FATAL），以便控制不同级别的信息输出...

    Log4J 1.2.14 jar包和详细说明

    `log4j详解与实战 - 企业应用 - Java - JavaEye论坛.mht`则是一份详细的使用指南，可能包含了配置示例和实践案例。 首先，了解Log4J的核心组件至关重要。它主要由以下部分组成： 1. **Logger**: 这是日志记录的...

    Log4j将System.out搞到log4j中输出四

    在《Log4j将System.out搞到log4j中输出四》这篇博文中，作者可能详细讨论了这些步骤，并可能分享了一些实战经验。通过学习这篇博文，读者可以更深入地了解如何在实际项目中实现这一转换，提升日志管理的效率。 总结...

    spring-boot-starter-log4j2

    四、Log4j2配置详解 1. 日志级别：Log4j2支持TRACE、DEBUG、INFO、WARN、ERROR、FATAL和OFF七个级别。通过配置文件，可以设置全局日志级别，也可以针对特定类或包设置不同级别。 2. Appenders：Appender是日志输出...

    log4j2lib.rar

    《Java日志神器Log4j2详解及其应用》 在Java开发中，日志记录是一项不可或缺的任务，它有助于我们追踪程序运行状态、定位错误、优化性能。Log4j2是Apache组织提供的一款强大的日志框架，它在Log4j的基础上进行了...

    Pro Apache Log4j second edition

    - **日志级别**：详解Log4j支持的不同日志级别（如TRACE、DEBUG、INFO、WARN、ERROR、FATAL），并讨论如何根据实际情况选择合适的日志级别。 #### 2. Apache Log4j核心概念 - **Appenders**：介绍不同类型的...

    log4j2使用入门

    5. **布局与模式：** Log4j2支持多种布局，例如PatternLayout，允许自定义日志输出格式，如"%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"，这将输出时间戳、线程名、日志级别、logger名和消息...

    深入学习LOG4J

    **深入学习LOG4J** LOG4J是Java编程语言中广泛使用的日志记录框架，它为应用程序提供了灵活的日志记录功能。这篇深入的学习资料将帮助我们理解LOG4J的核心概念、配置方式以及如何在实际项目中有效利用它来优化调试...

    JBoss Log4j

    ### JBoss Log4j知识点详解 #### 一、引言 JBoss Log4j 是一个为 JBoss 应用服务器定制的日志记录解决方案。本文档旨在详细介绍如何在 JBoss 应用服务器中集成并利用 Log4j 进行日志记录。通过本章节的学习，您将...

    log4j the complete manual

    3. **配置详解**：log4j的配置文件通常是`log4j.properties`或`log4j.xml`，它定义了日志级别（如DEBUG、INFO、WARN、ERROR、FATAL）以及每个级别的输出目的地。手册会详细介绍如何配置这些设置以满足不同场景的需求...

Magicbox
Global site tag (gtag.js) - Google Analytics