JAVA log4j的简单使用

笔者在学习spring3的过程中接触到了log4j的使用，笔者通过log4j获得的日志信息很好的把握住了程序运行时的控制信息的输出，因此笔者通过结合自己的经验和查阅网上的相关资料整理了一下log4j的使用，希望能够帮助到阅读本文的同行。

 

那么，什么是log4j？

log4j介绍

 

log4j为apache组织推出的通用软件包，通过log4j可以将日志信息输出到文件，OutputStream,java.io.Writer,
远程log4j服务器和远程Unix Syslog守护进程，甚至是NT的事件记录器，通过使用Log4j我们还可以控制每一条

 

日志的输出格式，通过定义每一条日志的级别，我们能更加细致控制日志的生成过程，这些都可以通过一个配置文件灵活的进行配置，不需要修改相应代码。

 

Log4j主要由三种主要的组件组成：

Logger，Appender，Layout这三种组件协同工作，使得开发人员可以依照消息的类型和级别来记录信息并在程序运行时控制消息以什么样式在什么地方被输出。

这三个组建简单点说就是：

1.根目录（级别和目的地）；
2.目的地（控制台、文件等等）；
3.输出样式；

 

我们可以简单了解下log4j的类图：

Logger - 日志写出器，供程序员输出日志信息 

Appender - 日志目的地，把格式化好的日志信息输出到指定的地方去 

ConsoleAppender - 目的地为控制台的Appender 

FileAppender - 目的地为文件的Appender 

RollingFileAppender - 目的地为大小受限的文件的Appender 

Layout - 日志格式化器，用来把程序员的logging request格式化成字符串

PatternLayout - 用指定的pattern格式化logging request的Layout

 

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有以下几种：

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 ) ;

 

接下来笔者给大家举一个简单的例子，读取的是一个log4j的配置文件：

 

package com.kameleon.logtest;

import org.apache.log4j.Logger;

public class HelloLog4j {
	private static Logger logger = Logger.getLogger(HelloLog4j.class);
	
	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

 

 

log4j.rootLogger=DEBUG,A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%d %5p [%t] (%F:%L) - %m%n

以下是输出：

 

 

文章有些长，很多都是一些方法的使用信息，大家可以将它当成一篇工具类文章来看待，也希望阅读的同行能够各取所需，充分利用log4j提供的方便，写出更好更漂亮的应用！

 

如果有问题，欢迎大家指出！