Log4J学习【五】Log4J的体系结构之Logger的结构

当我们在描述为系统做日志这个动作的时候,实际上描述了3个点;类似于小学语文学语法一样。做日志,其实就是在规定,在什么地方用日志记录器以什么样的格式做日志。把三个最重要的点抽取出来,即什么地方,日志记录器,什么格式。在Log4J中,就使用了三个最重要的组件来描述这三个要素,即
    Logger:日志记录器
    Appender:什么地方
    Layout:什么格式

    下面我们就分别来看看这三个对象在Log4J中起的重要作用和一些基本的规则用法。

    Logger的结构
    之前的示例中大家对Logger已经有了一定的认识,Logger就是最重要的,我们直接用来完成日志的工具。使用日志框架一个非常重要的目的就是让程序员能够方便的控制特定的日志的输出。要能够控制特定日志的输出,就需要创建一种特殊的结构来划分我们的日志记录器。而对于JAVA程序员来说,按照包的层次关系划分Logger是最容易想到,也最贴近我们的代码结构的。
之前我们在创建Logger的时候,都是使用Logger.getLogger(Class)方法来得到一个类绑定的日志记录器的。实际上,当我们说把一个日志记录器绑定在一个类上,这种说法是不准确的,正确的说,我们仅仅是使用给定的类的全限定名为Logger取了一个名字。这里请大家注意一下,Logger都是有名字的,假如我们除开rootLogger不谈,我们可以把Logger想象成一张表里面的数据,Logger对应的名字就是其主键,当两个Logger的名字相同,这两个Logger就是同一个Logger实例。我们可以简单的通过一个实例来验证:
@Test
public void testLoggerName(){
    BasicConfigurator.configure();
    Logger log1=Logger.getLogger("a");
    Logger log2=Logger.getLogger("a");
    log1.info(log1==log2);
}

    控制台打印:0 [main] INFO a  - true;说明Logger自身维护着每一个名字的Logger实例的引用,保证相同名字的Logger在不同地方获取到的实例是一致的,这样就允许我们在统一的代码中配置不同Logger的特性。
    另外,Logger的层次结构,也是靠Logger的名字来区分的,比如:名称为java的Logger就是java.util的父Logger;java.util是java.util.Collection的父Logger;Logger的体系结构和package的结构划分类似,使用.来区分;所以我们前面才说,使用类的全限定名是最简单,也是最符合logger的体系结构的命名方式。当然,你也可能使用任何的能想到的方式去处理Logger的命名;这也是可以的。
    看到这里,可能有的人会提出疑问,那既然Logger的层次结构是按照Logger的名字来创建的,那在创建Logger的时候,是否必须按照其结构来顺序创建Logger?比如:
Logger log1=Logger.getLogger(“cd”);
Logger log2=Logger.getLogger(“cd.itcast”);
Logger log3=Logger.getLogger(“cd.itcast.log”);

    是否必须要按照这个顺序创建呢?不需要。在做前面的示例的时候,我们说到,大家可以认为当我们通过Logger.getLogger(“cd.itcast.log”)的时候,Log4J其实为我们创建了cd;cd.itcast和cd.itcast.log这三个Logger;其实不然,如果是这样的话,Log4J可能会产生非常多不必要的Logger。所以,真正的方式应该是,当我通过Logger.getLogger(“cd.itcast.log”)的时候,Log4J仅仅为我们创建了cd.itcast.log这个Logger;而当我们再次使用Logget.getLogger(“cd.itcast”)的时候,Log4J才会为我们创建cd.itcast这个Logger,并且Log4J会自动的去寻找这个Logger的上下级关系,并自动的把这个新创建的Logger添加到已有的Logger结构体系中。
    上面说到,除了rootLogger之外,其他的Logger都有名字,那么rootLogger呢?rootLogger有下面的规范:
    rootLogger是没有名字的,
    rootLogger是自动存在的;
    rootLogger必须设置Level等级。

    rootLogger没有名字,所以无法像其他的类一样,可以通过Logger.getLogger(String)得到,他只能通过Logger.getRootLogger方法得到;而我们前面使用的Logger.getLogger(Class)方法,其实相当于Logger.getLogger(Class.getName())而已;所以真正赋予Logger的是一个名字,而不是类型。

    在Logger中,非常重要的一个组件,就是Logger的日志级别,即Level。关于Level的划分,使用,我们在前面的例子中已经大概了解到了,下面来看看完整的Level的定义和其在Logger体系中的继承方式,这是一个很简单的概念。
    首先,在Log4J中,为我们默认的定义了7种不同的Level级别,即all<debug<info<warn<error<fatal<off;而这7中Level级别又刚好对应着Level类中的7个默认实例:Level.ALL;Level.DEBUG;Level.INFO;Level.WARN;Level.ERROR;Level.FATAL和Level.OFF。我们在之前也只看到了其中的debug到fatal这5种;这五种日志级别正好对应着Logger中的五个方法,即:
public class Logger {
// 输出日志方法:
    public void debug(Object message);
    public void info(Object message);
    public void warn(Object message);
    public void error(Object message);
    public void fatal(Object message);
// 输出带有错误的日志方法:
    public void debug(Object message, Throwable t);
    public void info(Object message, Throwable t);
    public void warn(Object message, Throwable t);
    public void error(Object message, Throwable t);
    public void fatal(Object message, Throwable t);
// 更通用的输出日志方法:
    public void log(Level p, Object message);
}

    为什么这里列出了11个方法,其实大家仔细看一下就知道了,最上面5个方法和中间的5个方法其实是对应的,只是中间的5个方法都带有对应的错误信息。而更下面的log方法,是允许我们直接使用Level类型来输出日志,这给了我们直接使用自定义的Level级别提供了输出日志的方式。换句话说,debug(Object message)其实就是log(Level.DEBUG,message)的简写而已。
    要能输出日志,按照常规来说,每一个Logger实例都应该设置其对应的Level;但是如果这样做,会让我们控制Logger的Level非常麻烦,而Log4J借助Logger的层级关系,使用继承的方式来最大限度的减少Level的设置。这个规律我们在之前的代码中已经讲过。下面再用表格的形式来举几个例子:
Logger设置的Level起作用的Level
rootDEBUGDEBUG
cdnullDEBUG
cd.itcastnullDEBUG
cd.itcast.lognullDEBUG


Logger设置的Level起作用的Level
rootDEBUGDEBUG
cdINFOINFO
cd.itcastWARNWARN
cd.itcast.logDEBUGDEBUG



Logger设置的Level起作用的Level
rootDEBUGDEBUG
cdINFOINFO
cd.itcastnullINFO
cd.itcast.logDEBUGDEBUG

    这三个表格应该能很容易的看出Level的继承体系。
    再来一段代码演示:
@Test
public void testLogLevel() {
    BasicConfigurator.configure();

    Logger logger = Logger.getLogger("cd.itcast");
    logger.setLevel(Level.INFO);
    Logger barLogger = Logger.getLogger("cd.itcast.log");

    logger.warn("logger warn");
    logger.debug("logger debug");
    barLogger.info("bar logger info");
    barLogger.debug("bar logger debug");
}

    先不运行测试,我们直接来分析一下结果。第一句话完成了基础的配置,即rootLogger的等级被设置为了DEBUG;接着创建了一个名字为cd.itcast的logger,并设置其Level为INFO;然后创建了一个名字叫cd.itcast.log的barLogger,这里,并没有设置其Level,又因为cd.itcast.log是cd.itcast的子Logger,所以其继承了cd.itcast的Level,即INFO;所以,最后不管调用logger还是barLogger,都只能输出等级大于或等于INFO的日志信息,我们分析得出,结果应该是logger warn和bar logger info两条信息。
    运行测试,输出:
0 [main] WARN cd.itcast  - logger warn
0 [main] INFO cd.itcast.log  - bar logger info


=======================以下对于Threshold与Level的解释=======================

    符合我们的预期。使用Level方式限制日志的输出只是过滤日志输出的一种方式,另外一种不太常用的方式是使用Threshold方式来限制日志输出。Threshold我们可以理解为门槛,它和Level的概念完全一致,只是使用方式有一些区别,先来看代码:
@Test
public void testLogLevel2() {
    BasicConfigurator.configure();

    Logger logger = Logger.getLogger("cd.itcast");
    logger.getLoggerRepository().setThreshold(Level.WARN);
    Logger barLogger = Logger.getLogger("cd.itcast.log");

    logger.warn("logger warn");
    logger.debug("logger debug");
    barLogger.info("bar logger info");
    barLogger.debug("bar logger debug");
}

    注意加粗的代码,从字面意义来看,我们先创建了一个名字为cd.itcast的Logger,这次我们并没有设置其Level,而是使用logger.getLoggerRepository()方法得到了一个LoggerRepository对象。这个LoggerRepository可以理解为Logger栈,简单说,就是从当前Logger开始其下的所有的子Logger。然后,我们设置了这个栈的日志门槛,Threshold就是门槛的意思,换句话说就是最低日志输出级别为WARN,那么其下的所有的Logger的最低日志输出级别就变为了WARN。所以,这段代码执行的结果是:
0 [main] WARN cd.itcast  - logger warn

    那么大家马上就会有下面三个疑问:1,如果父Logger同时设置了Level和门槛,谁有优先级?2,如果子Logger也设置自己的门槛,会怎么样?3,如果子Logger设置自己的Level会怎么样?下面我们就来分别测试一下:
@Test
public void testLogLevel2() {
    BasicConfigurator.configure();

    Logger logger = Logger.getLogger("cd.itcast");
    logger.getLoggerRepository().setThreshold(Level.WARN);
    logger.setLevel(Level.DEBUG);
    Logger barLogger = Logger.getLogger("cd.itcast.log");

    logger.warn("logger warn");
    logger.debug("logger debug");
    barLogger.info("bar logger info");
    barLogger.debug("bar logger debug");
}

    在这段代码中,我们先设置门槛为WARN,再设置Level为DEBUG,运行结果为:
0 [main] WARN cd.itcast  - logger warn

    那么结论很明白,Threshold优先级>Level优先级,这里需要注意一点,Threshold优先级大于Level优先级,不等于Level就没有了意义。假如Threshold设置的级别为DEBUG,而Level设置的等级为INFO,那么最终,logger.debug还是不会输出日志(这里也附带上网上其他人对于level和threshold关系的解释:

网友1:(地址http://bbs.csdn.net/topics/350162480

in fact , threshold's level should be larger or equals rootlogger's level.
usually, thresold can be used to define some special appender's filter log level.
eg:
there are two appenders: console and file,and the level is warn, if you just only want the error message be written to file, so you can use "file.threshold=error" to filter out the "warn" message.

网友2:(地址http://www.cnblogs.com/wqsbk/p/6817871.html)

有时候我们需要把一些报错ERROR日志单独存到指定文件 ,这时候,Threshold属性就派上用场了;

 

Threshold属性可以指定日志level 

Log4j根据日志信息的重要程度,分OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL

比如我们指定某个appender的Threshold为WARN,那这个appender输出的日志信息就是WARN级别以及WARN以上的级别; 

假如我们指定的是ERROR,那这个就输出ERROR或者FATAL日志信息;

当然这里有个提前  rootLogger里配置的level比如小于Threshold层级  否则无效 还是按照总的rootLogger里的level来输出,一般我们实际实用的话 rootLogger里配置DEBUG,然后某个文件专门存储ERRO日志,就配置下Threshold为ERROR,这个就是我们的最佳实践,不要乱七八糟瞎配置;



    第二,如果子Logger设置了自己的门槛:
@Test
public void testLogLevel2() {
    BasicConfigurator.configure();

    Logger logger = Logger.getLogger("cd.itcast");
    logger.getLoggerRepository().setThreshold(Level.WARN);
    Logger barLogger = Logger.getLogger("cd.itcast.log");
    barLogger.getLoggerRepository().setThreshold(Level.INFO);

    logger.warn("logger warn");
    logger.debug("logger debug");
    barLogger.info("bar logger info");
    barLogger.debug("bar logger debug");
}

    首先设置父Logger的门槛为WARN,接着设置子Logger的门槛为INFO,最终的输出结果为:
0 [main] WARN cd.itcast  - logger warn
0 [main] INFO cd.itcast.log  - bar logger info
    说明使用Threshold的方式和Level一样,如果子Logger设置了自己的Threshold,则会使用自己的Threshold,如果没有设置,则继续向上查询,直到找到一个父类的Threshold或者rootLogger的level。

    第三个问题,其实已经不用代码测试了。综合第一个问题的结论和第二个问题的结论,Threshold>Level,所以,只要父Logger的Threshold设置好了,子Logger的Level也失效了通过如下的测试代码证明并不是这个效果:

public void test2() {
    BasicConfigurator.configure();


    Logger logger = Logger.getLogger("cd.itcast");
    logger.getLoggerRepository().setThreshold(Level.INFO);
//        logger.setLevel(Level.WARN);
    Logger barLogger = Logger.getLogger("cd.itcast.log");
    barLogger.setLevel(Level.WARN);

    logger.warn("logger warn");
    logger.info("logger info");
    logger.debug("logger debug");
    barLogger.warn("bar logger warn");
    barLogger.info("bar logger info");
    barLogger.debug("bar logger debug");
}

输出如下:

0 [main] WARN cd.itcast  - logger warn
1 [main] INFO cd.itcast  - logger info
1 [main] WARN cd.itcast.log  - bar logger warn

可见barLogger.setLevel(Level.WARN);确实是起作用了

    上面简单的介绍了Logger和Level的意义和使用方式,其实,在真正使用Log4J的时候,我们一般都不需要使用代码的方式去配置Level或者Threshold,这些配置更多的时候是使用配置文件来完成的,这个后面会详细介绍。但是,不管使用什么样的配置文件,最终也会解释成这样的配置代码,所以,理解了这些代码,再去使用配置文件,会更加清楚到底配置文件在干什么,同样,为我们自己去扩展Log4J的配置,想要自己去实现自定义的配置文件格式,提供了可能。
  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值