log4j是一个非常强大的log记录软件,下面我们就来看看在项目中如何使log4j。
我们先看一个最简单的示例:
【示例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.");
- }
- }
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
#可以设置级别: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.
[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
#设置级别: 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
#设置级别和多个目的地 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
#设置级别和目的地 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.
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
#设置级别和目的地 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.
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
#设置级别和目的地 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.");
- }
- }
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
#省略根,只设置特定包的级别和目的地 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>
<?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.");
转载:http://www.iteye.com/topic/378077
相关推荐
### Log4j详解:日志记录的全面解析 #### 标题与描述解析: 标题“log4j详解(超详细)”与描述“log4j详解(超详细)”明确指出文章将对Log4j这一日志框架进行深入且详尽的介绍。Log4j作为一款流行的开源日志组件...
Log4j 详解 Log4j 是一款功能强大的日志记录工具,广泛应用于 Java 应用程序中。它可以帮助开发人员调试和分析程序,记录程序的运行情况,并提供了灵活的配置方式来控制日志的输出。 Log4j 的概念 Log4j 中有三个...
**Log4j详解与实战** Log4j是Java平台上的一个广泛应用的日志框架,由Apache软件基金会开发。它提供了一种灵活、强大的日志记录机制,使得开发者可以在应用程序中轻松地进行日志输出,便于调试、性能分析以及系统...
### Log4j详解 #### 1. Log4j简介 Log4j是Apache下的一个开源项目,用于实现灵活的日志管理。它可以帮助开发者控制日志信息的输出目的地、格式以及生成过程,这一切都可以通过简单的配置文件来实现,而无需修改...
Log4j详解
**日志框架Log4j详解** 日志框架在软件开发中扮演着至关重要的角色,它提供了记录应用程序运行过程中的各种信息的功能,便于调试、监控和问题排查。Log4j是Apache组织开发的一个开源日志记录工具,广泛应用于Java...
### Log4j详解:日志记录的精妙与配置解析 Log4j是Apache软件基金会下的一个开源项目,用于Java应用程序的日志记录。它提供了一种灵活、强大的日志记录框架,可以定制日志级别、格式和输出目标,极大地提高了应用的...
【log4j详解】 在Java开发中,日志记录是一个至关重要的部分,它帮助开发者监控程序行为、追踪错误和调试代码。Log4j是Apache软件基金会的一个开源项目,提供了强大的日志处理能力。本文将深入解析Log4j,探讨其...
### Log4j 详解与实战 #### 一、Log4j 概述 Log4j 是 Apache 的一个开源项目,它是由 Java 编写的一款功能强大的日志记录工具。Log4j 具备灵活的日志配置能力,允许开发者在运行时动态地控制日志输出的等级、格式...
### Log4j 配置详解 #### 一、概述 Log4j 是一款非常流行的 Java 日志框架,它提供了一种灵活的日志记录机制。在实际应用中,开发者可以通过简单的配置来实现对日志级别的控制、日志信息的格式化以及日志文件的...
Log4j 在 SSM 整合中的配置详解 Log4j 是一个功能强大且广泛使用的日志记录工具,特别是在 SSM(Spring、Spring MVC、Mybatis)整合项目中,合理地配置 Log4j 对项目的日志记录和输出至关重要。本文将详细介绍 SSM...
### Log4j详解 #### 输出级别的种类 在Log4j中,日志记录的信息可以根据不同的级别进行筛选。这些级别从高到低分别为:`FATAL`、`ERROR`、`WARN`、`INFO`、`DEBUG`。这些级别的定义如下: - **FATAL**:致命错误...
在“log4j详解”部分,我们首先会了解到Log4j的核心概念,包括Logger、Appender、Layout和Level。Logger是记录日志的对象,它可以设置不同的级别(如DEBUG、INFO、WARN、ERROR和FATAL),以便控制不同级别的信息输出...
**日志框架Log4j详解** 日志框架在软件开发中扮演着至关重要的角色,它提供了记录应用程序运行过程中的各种事件的功能,便于调试、监控和问题排查。Log4j是Apache组织开发的一个开源的日志记录工具,广泛应用于Java...