您的位置：首页 > 编程语言 > Java开发

详细讲解Java中log4j的使用方法

2014-05-04 12:07 615 查看

　1、Log4j是什么？

　　Log4j可以帮助调试（有时候debug是发挥不了作用的）和分析，要下载和了解更详细的内容，还是访问其官方网站吧： http://jakarta.apache.org/log4j .

　　2、Log4j的概念

　　Log4j中有三个主要的组件，它们分别是 Logger、Appender和Layout，Log4j 允许开发人员定义多个Logger，每个Logger拥有自己的名字，Logger之间通过名字来表明隶属关系。有一个Logger称为Root，它永远存在，且不能通过名字检索或引用，可以通过Logger.getRootLogger（）方法获得，其它Logger通过 Logger.getLogger（String name）方法。

　　Appender则是用来指明将所有的log信息存放到什么地方，Log4j中支持多种appender，如 console、files、GUI components、NT Event Loggers等，一个Logger可以拥有多个Appender，也就是你既可以将Log信息输出到屏幕，同时存储到一个文件中。

　　Layout的作用是控制Log信息的输出方式，也就是格式化输出的信息。

　　Log4j中将要输出的Log信息定义了5种级别，依次为DEBUG、INFO、WARN、ERROR和FATAL，当输出时，只有级别高过配置中规定的级别的信息才能真正的输出，这样就很方便的来配置不同情况下要输出的内容，而不需要更改代码，这点实在是方便啊。

　　3、Log4j的配置文件

　　虽然可以不用配置文件，而在程序中实现配置，但这种方法在如今的系统开发中显然是不可取的，能采用配置文件的地方一定一定要用配置文件。Log4j支持两种格式的配置文件：XML格式和Java的property格式，本人更喜欢后者，首先看一个简单的例子吧，如下：

log4j.rootLogger=debug, stdout, R
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log
log4j.appender.R.MaxFileSize= 100KB

# Keep one backup file
log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

　　首先，是设置root，格式为 log4j.rootLogger=[level]，appenderName， ……，其中level就是设置需要输出信息的级别，后面是appender的输出的目的地，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）

　　4、Log4j在程序中的使用

　　要在自己的程序中使用Log4j，首先需要将commons- logging.jar和logging-log4j-1.2.9.jar导入到构建路径中。然后再将log4j.properties放到src根目录下。这样就可以在程序中使用log4j了。在类中使用log4j，首先声明一个静态变量 Logger logger=Logger.getLog（"classname"）；现在就可以使用了，用法如下：logger.debug（"debug message"）或者logger.info（"info message"），看下面一个小例子：

import com.foo.Bar;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
public class MyApp {
static Logger logger = Logger.getLogger(MyApp.class.getName());
public static void main(String[] args) {
// BasicConfigurator replaced with PropertyConfigurator.
PropertyConfigurator.configure(args[0]);
logger.info("Entering application.");
Bar bar = new Bar();
bar.doIt();
logger.info("Exiting application.");
}
}

例子：

log4j.rootLogger=INFO,FILE
#log4j.rootLogger=INFO,CONSOLE,FILE

###################
# Console Appender
###################
#log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
#log4j.appender.CONSOLE.Target=System.out
#log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
#log4j.appender.CONSOLE.layout.ConversionPattern=%d %c %x - %m%n

#####################
# File Appender
#####################
#log4j.appender.FILE=org.apache.log4j.RollingFileAppender
log4j.appender.FILE=org.apache.log4j.DailyRollingFileAppender
#location
log4j.appender.FILE.File=d:/apps/logs/push/api-check.log
#log4j.appender.FILE.MaxFileSize=100MB
#log4j.appender.FILE.MaxBackupIndex=10
log4j.appender.FILE.Append=false
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.ConversionPattern=[%d] [%t] [%c{1}]- %m%n

log4j.logger.com.vipshop.check.TimerCheck=INFO,tc
log4j.appender.tc=org.apache.log4j.DailyRollingFileAppender
log4j.appender.tc.DatePattern='.'yyyy-MM-dd
log4j.appender.tc.File=d:/apps/logs/push/mcache.log
log4j.appender.tc.layout=org.apache.log4j.PatternLayout
log4j.appender.tc.layout.ConversionPattern=[mc] [%5p] [%d] [%t] [%c{1}] %x - %m%n

static {
// 启用log日志
BasicConfigurator.configure();

}

-----------------------------

### direct log messages to stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c:%L - %m%n

### direct messages to file hibernate.log ###
#log4j.appender.file=org.apache.log4j.FileAppender
#log4j.appender.file.File=hibernate.log
#log4j.appender.file.layout=org.apache.log4j.PatternLayout
#log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### set log levels - for more verbose logging change 'info' to 'debug' ###

log4j.rootLogger=warn, stdout

#log4j.logger.org.hibernate=info
#log4j.logger.org.hibernate=debug

### log HQL query parser activity
#log4j.logger.org.hibernate.hql.ast.AST=debug

### log just the SQL
#log4j.logger.org.hibernate.SQL=debug

### log JDBC bind parameters ###
#log4j.logger.org.hibernate.type=info
#log4j.logger.org.hibernate.type=debug

### log schema export/update ###
log4j.logger.org.hibernate.tool.hbm2ddl=debug

### log HQL parse trees
#log4j.logger.org.hibernate.hql=debug

### log cache activity ###
#log4j.logger.org.hibernate.cache=debug

### log transaction activity
#log4j.logger.org.hibernate.transaction=debug

### log JDBC resource acquisition
#log4j.logger.org.hibernate.jdbc=debug

### enable the following line if you want to track down connection ###
### leakages when using DriverManagerConnectionProvider ###
#log4j.logger.org.hibernate.connection.DriverManagerConnectionProvider=trace

-----------

控制台输出例子：

#log4j.rootLogger\uFF0C\u7B2C\u4E00\u4E2A\u53C2\u6570\u6807\u793A\u65E5\u5FD7\u8BB0\u5F55\u7684\u4F18\u5148\u7EA7\uFF0C\u53EA\u6709\u7B49\u4E8E\u3001\u5927\u4E8E\u8FD9\u4E2A\u7EA7\u522B\u7684\u65E5\u5FD7\u624D\u4F1A\u88AB\u8F93\u51FA\u3002
#log4j\u7684\u65E5\u5FD7\u7684\u7EA7\u522B\u5171\u6709\u4EE5\u4E0B\u51E0\u79CD\uFF1AOFF\u3001FATAL\u3001ERROR\u3001WARN\u3001INFO\u3001DEBUG\u3001ALL\uFF0C
#\u4F46\u662F\u6211\u4EEC\u4E00\u822C\u53EA\u662F\u7528ERROR\u3001WARN\u3001INFO\u3001DEBUG\u8FD9\u56DB\u79CD\uFF08\u8FD9\u91CC\u6309\u7167\u4ECE\u9AD8\u5230\u4F4E\u7ED9\u51FA\uFF09\u3002
log4j.rootLogger=DEBUG,console

#\u5C06\u65E5\u5FD7\u8F93\u51FA\u5230\u63A7\u5236\u53F0
log4j.appender.console=org.apache.log4j.ConsoleAppender
#\u65E5\u5FD7\u8F93\u51FA\u7684\u4FE1\u606F\u5E03\u5C40
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.Target=System.out
#\u65E5\u5FD7\u8F93\u51FA\u683C\u5F0F:%d{\u65F6\u95F4\u683C\u5F0F}\uFF0C%c \u7C7B\u8DEF\u5F84\uFF0C%n\u6362\u884C\uFF0C%m \u6253\u5370\u4FE1\u606F
#\u4E2D\u6587\u9700 \u8F6C\u4E3A unicode
#log4j.appender.console.layout.ConversionPattern=%n[\u65F6\u95F4] %d{yyyy-MM-dd HH\:mm\:ss}  [\u8DEF\u5F84] %c  %n[\u4FE1\u606F] %m%n
log4j.appender.console.layout.ConversionPattern=%n[\u65F6\u95F4] %d{yyyy-MM-dd HH\:mm\:ss}   [\u4FE1\u606F] %m

-----------------------------

Log4j的配置

配置Log4j环境就是指配置root Logger，包括把Logger为哪个级别，为它增加哪些Appender,以及为这些Appender设置Layout，等等。因为所有其他的Logger都是root Logger的后代，所以它们都继承了root Logger的性质。这些可以通过设置系统属性的方法来隐式地完成，也可以在程序中调用XXXConfigurator.configure()方法来显式地完成。有以下几种方式来配置Log4j。

A：配置放在文件里，通过环境变量传递文件名等信息，利用Log4j默认的初始化过程解析并配置。

B：配置放在文件里，通过应用服务器配置传递文件甸等信息，利用一个特定的Servlet来完成配置。

C：在程序中调用BasicConfigor.configure()方法。

D：配置放在文件里，通过命令行PropertyConfigurator.configure(args[])解析log4j.properties文件并配置Log4j。

下面对BasicConfigurator.configure()方法和PropertyConfigurator.config()方法分别进行介绍。

BasicConfigurator.configure()方法：

它使用简单的方法配置Log4j环境。这个方法完成的任务是：

1：用默认的方式创建PatternLayout对象p:

PatternLayout p = new PatternLayout("%-4r[%t]%-5p%c%x-%m%n");

2：用p创建ConsoleAppender对象a，目标是System.out，标准输出设备：

ConsoleAppender a = new CpnsoleAppender(p,ConsoleAppender.SYSTEM_OUT);

3：为root Logger增加一个ConsoleAppender p;

rootLogger.addAppender(p);

4：把rootLogger的log level设置为DUBUG级别;

rootLogger.setLevel(Level.DEBUG);

PropertyConfigurator.configure()方法：

当使用以下语句生成Logger对象时：

static Logger logger = Logger.getLogger(mycalss.class);

如果没有调用BasicConfigurator.configure()，PropertyConfigurator.configure()或DOMConfigurator.configure()方法，Log4j会自动加载CLASSPATH下名为log4j.properties的配置文件。如果把此配置文件改为其他名字，例如my.properties,程序虽然仍能运行，但会报出不能正确初始化Log4j系统的提示。这时可以在程序中加上：

PropertyConfigurator.configure("classes/my.properties");

问题即可解决。

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航