log4j入门教程

        在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析工作;跟踪代码运行时轨迹,作为日后审计的依据;担当集成开发环境中的调试器的作用,向文件或控制台打印代码的调试信息。
  最普通的做法就是在代码中嵌入许多的打印语句,这些打印语句可以输出到控制台或文件中,比较好的做法就是构造一个日志操作类来封装此类操作,而不是让一系列的打印语句充斥了代码的主体。

Log4j简介
    Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码.

    Log4j 是一个开源的日志记录组件,其产品已经相当的成熟,且使用非常的广泛。在工程中可以易用,方便等代替了 System.out 等打印语句,它是JAVA下最流行的日志输入工具,一些著名的开源项目,像spring、hibernate、struts都使用该工具作为日志输入工具,可以帮助调试(有时候debug是发挥不了作用的)和分析。 Log4j 的目标是:它允许开发人员以任意的精细程度控制哪些日志说明被输出。通过使用 外部的配置文件,可以在运行时配置它。 Log4j 的具体在 http://logging.apache.org/log4j/找到它(有使用的文档说明)。另 外,log4j 已经被转换成 C, C++, C#, Perl, Python, Ruby, 和 Eiffel 语言。一般情况下Log4j总是Apache Commons-logging一起用的,多了个东西不是更麻烦,而是更简单!

Log4j组成:

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

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

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

Log4j中将要输出的Log信息定义了5种级别,依次为DEBUG、INFO、WARN、ERROR和FATAL,当输出时,只有级别高过配置中规定的级别的信息才能真正的输出,这样就很方便的来配置不同情况下要输出的内容,而不需要更改代码,比如配置输出级别为ERROR,那么程序的日志输出就只有ERROR信息和FATAL信息,而没有INFO信息和DEBUF信息。

Log4j的配置文件:
     虽然可以不用配置文件,而在程序中实现配置,但这种方法在如今的系统开发中显然是不可取的,能采用配置文件的地方一定一定要用配置文件。Log4j支持两种格式的配置文件:Log4j 支持两种配置文件格式,一种是 XML 格式的文件,一种是 Java 特性文件 lg4j.properties (键 = 值),properties文件简单易读,xml文件可以配置更多的功能(比如过滤),这个没有睡好谁坏,哪个适合用哪个,用着顺手的、能够融会贯通的就是最好的。

 

Log4j的简单思想
    Log4j真的很简单,简单到令人发指的地步。不是要记录日志吗?那就给你一个Log,然后用Log来写东西就行了,先来一个完整类示例:

 

package test.robin;        
       
import org.apache.commons.logging.Log;        
import org.apache.commons.logging.LogFactory;        
       
public class Test {        
       
        static Log log = LogFactory.getLog(Test.class);        
       
        public void log(){        
           log.debug("Debug info.");        
           log.info("Info info");        
           log.warn("Warn info");        
           log.error("Error info");        
           log.fatal("Fatal info");        
        }        
       
        public static void main(String[] args) {        
           Test test = new Test();        
           test.log();        
       }        
}   


我们从这个例子说起,先不要着急,很快就豁然开朗了。

     Log4j默认把日志信息分为五个等级:
     all<debug < info < warn < error < fatal<off

     虽然可以自己添加等级,但是我觉得没有必要,五个够用了吧!你要写入信息的时候就把信息归为五个等级中的一个,然后调用相应的函数即可。分五个等级到底有什么用呢?日志信息到底写到哪里去了?“LogFactory.getLog(Test.class)”又是什么意思捏?接着往下看吧!(现在用这个Logger.getLogger(Test.class)或者Logger.getLogger(InitDicDao.class.getName()) )

继承思想:
    Log4j的关键之处在于它的继承思想。也就是一个Log可以继承另外一个Log的属性(输出到哪里,日志等级,日志格式等等)。怎么继承?
    Log4j是根据Log的名字来判断继承关系的,比如:
    名字为“com.robin.lib”的Log就是“com.robin.lib.log”的parent,明白了吧!Log4j还有一个rootLogger,相当于Java的Object。Log4J中总是存在一个rootLogger,即使没有显示配置也是存在的,并且默认输出级别为DEBUG。其它的logger都继承自这个rootLogger(如果其他logger未单独定义其输出级别)了解Log4j的继承思想对学习Log4j很重要。

    回过头来看“Logger.getLogger(Test.class)”这里的“Test.class”事实上传进去的是Test这个类的完整路径(包名+类名),“test.robin.Test”。这样如果存在“test”或者“text.robin”这样的Log那么Test这个Log就继承它,否则就继承rootLogger。

     那具体的Log属性是在哪里定义的呢?
    我们可以认为Logger.getLogger(Test.class)就是静态方法获取一个loger实例,这个实例的相关信息就是我们在配置文件里配置好的logger。(xml文件的logger标签)
    每次我们在系统中取得logger时,并不是新建实例,这些实例是系统启动的时候就按照配置文件初始化好的
(也可能时第一次引用的时候建立的,然后缓存其实例供以后使用,这部分还没有时间研究)。

关于logger的两点说明:

·     用同名参数调用Logger.getLogger(String name)将返回同一个logger的引用。故可以在一个地方配置logger,在另外一个地方获得配置好的logger,而无须相互间传递logger的引用。

·     logger的创建可以按照任意的顺序,即,父logger可以后于子logger被创建。log4j将自动维护logger的继承树。

 

部署:
    把log4j的包和commons-logging的包(加在一起才两个)放到classpath下面。然后把配置文件保存为log4j.properties,也放在classpath下面(如果用Eclipse的话,放在src目录下即可)。然后你就可以跑了。 

默认的log4j初始化过程:

    Logger类的静态初始化块(static initialization block)中对log4j的环境做默认的初始化。注意:如果程序员已经通过设置系统属性的方法来配置了log4j环境,则不需要再显式地调用XXXConfigurator.configure()方法来配置log4j环境了。

Logger的静态初始化块在完成初始化过程时将检查一系列log4j定义的系统属性。它所做的事情如下:

  • 检查系统属性log4j.defaultInitOverride,如果该属性被设置为false,则执行初始化;否则(只要不是false,无论是什么值,甚至没有值,都是否则),跳过初始化。
  • 把系统属性log4j.configuration的值赋给变量resource。如果该系统变量没有被定义,则把resource赋值为"log4j.properties"。注意:在apache的log4j文档中建议使用定义log4j.configuration系统属性的方法来设置默认的初始化文件是一个好方法。
  • 试图把resource变量转化成为一个URL对象url。如果一般的转化方法行不通,就调用org.apache.log4j.helpers.Loader.getResource(resource, Logger.class)方法来完成转化。
  • 如果url以".xml"结尾,则调用方法DOMConfigurator.configure(url)来完成初始化;否则,则调用方法PropertyConfigurator.configure(url)来完成初始化。如果url指定的资

常见的配置文件

虽然可以用xml或者在运行时用Java来配置Log4j,但还是properties文件好用啊!

log4j.rootLogger=info, stdout

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.rootLogger你明白吧。应为它是根,总得配置一下,否则别的Log继承什么啊。其他的Log可以配置也可以不配置。等号后面的第一个参数表示日志级别,可以填五个级别中的一种,后面的参数都是让Log知道输出到哪里,如果你想让日志输出到两个地方就加两个输出参数,比如:

log4j.rootLogger=info, stdout, file

这里的info表示,该Log的日志级别为info,所有级别小于info的日志都不会被记录。比如使用这个配置文件的话,我刚开始举的那个类中

log.debug("Debug info.");

这句话是不起作用的,因为debug的级别小于info。这样就很容易控制什么信息在调试的时候要显示,什么信息在发布的时候要去掉。这些都不用改代码,很方便吧。

     

但,stdoutfile又是什么呢?

接着往下看,就是配置stdout了,这个名字是随便取的,你可以叫它A

log4j.appender.A=org.apache.log4j.ConsoleAppender

那么上面的rootLogger的参数stdout也要改成A,其他用到的地方当然也要改。这里的关键不是名字,而是appender类型,比如这里的“ConsoleAppender”,看明白了吧,输出到Console。后面两行都是设置日志格式的,一般情况下你就照抄吧。既然是最简入门关注于理解Log4j的工作原理,我就不介绍file类型的appender了,一搜一大把。

在实际的项目开发中,很可能遇到所引用的包用Log4j来记录日志,比如Hibernate。那么在这里你可以很容易的控制这个包如何记录日志。比如在上面的配置文件中加一行:

log4j.logger.org.hibernate=fatal

       那么所有org.hibernate包下面的类就只会显示很少的信息,因为fatal的级别最高啊。

源不能被获得,则跳出初始化过程。


 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值