`

Java中log4j的使用方法

    博客分类:
  • java
阅读更多

 

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.");
    }
}
 
5、在代码中使用Log4说明 
①得到记录器 
使用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配置文件的方法进行灵活设置。 


分享到:
评论
1 楼 Redpick13 2013-03-25  
在这儿总能找到详细的教程,非常感谢

相关推荐

    log4j使用与java中log4j记录日志如何写入数据库

    详细介绍了log4j的使用方法,介绍了java中日志记录如何写入数据库,对于初学者来说很不错的一个文档

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

    通过自己学习和在工作中的总结以及在网上查找相关资料,总结了这个文档,希望对大家有帮助

    JAVA-log4j参数

    JAVA-log4j参数配置方法! 大家自己研究

    log4j中配置日志文件相对路径方法分析

    log4j中配置日志文件相对路径方法分析 方法一、 解决的办法自然是用相对路径代替绝对路径,其实log4j的FileAppender本身就有这样的机制,如:log4j.appender.logfile.File=${WORKDIR}/logs/app.log 其中“${...

    log4j.jar各个版本

    log4j-java1.1.jar, log4j-jcl-2.0.2-javadoc.jar, log4j-jcl-2.0.2-sources.jar, log4j-jcl-2.0.2.jar, log4j-jmx-gui-2.0.2-javadoc.jar, log4j-jmx-gui-2.0.2-sources.jar, log4j-jmx-gui-2.0.2.jar, log4j-nosql...

    log4j配置和加载方法

    log4j配置和加载方法log4j配置和加载方法

    Java中Log4J

    java中如何使用Log4J的小案例,怎么引入jar包后使用日志。

    Java与log4j2整合mongoDB需要的jar包

    Java编程语言开发时,利用log4j2将日志输出到mongoDB中存储,整合以上功能时所需的jar包

    Java Log4j所需Jar包

    Java Log4j 1,2 所需Jar包,一个完整的软件,日志是必不可少的。程序从开发、测试、维护、运行等环节,都需 要向控制台或文件等位置输出大量信息。这些信息的输出,在很多时候是使用 System.out.println()无法完成的。 ...

    Java中Log4j素材,Log4j包

    Java中Log4j素材,Log4j包,Log4j使用说明!

    如何在Java工程中使用Log4j

    在Java工程中使用Log4j 方便程序员 开发程序

    log4j.properties

    java开发中 log4j的基本配置,实现日志的记录 java开发中 log4j的基本配置,实现日志的记录

    log4j使用笔记

    1.该笔记中详细的介绍了log4j的作用和优势、具体地讲解了log4j的使用步骤和详细配置。 2.深入的说明了log4j在项目中的重要地位以及给项目带来的影响,同时说明了log4j的优化。 3.该笔记从log4j的简介/入门开始介绍,到...

    log4j-core-2.17.1-API文档-中文版.zip

    标签:apache、logging、log4j、core、中文文档、jar包、java; 使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译...

    Java使用log4j的实例

    Java使用log4j的实例

    java程序log4j配置

    非常全的java代码中,log4j的配置及详细说明,可以直接拿来用。

    java学习log4j详细文档和入门工程

    包含一个log4j的ppt 一个log4j的文档 一个简单的java的log4j工程,含有所需要的jar包

    java关于log4j打印日志demo

    java利用log4j打印日志文件的示例demo,分享给大家

    Java 中log4j 的使用

    java中log4j的使用……………………………………………………

    kafka_Java_Log4j

    使用Kafka自带的Log4jAppender,在Log4j配置文件中进行相应的配置,即可完成将Log4j产生的日志实时发送至Kafka中。

Global site tag (gtag.js) - Google Analytics