Log4j2 配置讲解(转)

IDEA 开发交流群:185441009



1. Log4j2的导入

        首先到http://logging.apache.org/log4j/2.x/download.html 上下载最新的log4j2的jar包,然后再eclipse中加入log4j-api-2.0-beta2.jar和log4j-core-2.0- beta2.jar,需要注意的是不要将所有jar都导入工程造成不必要的混乱。

2. 测试用例

      log4j 2.0的使用非常简单,只要用LogManager的getLogger函数获取一个logger,就可以使用logger记录日志,代码如下:

  1. import org.apache.logging.log4j.LogManager;

  2. import org.apache.logging.log4j.Logger;

  3. public class HelloLog4j {

  4. private static Logger logger = LogManager.getLogger("HelloLog4j");

  5. public static void main(String[] args) {

  6. MyApplication myApplication =  new MyApplication();

  7. logger.entry();

  8. logger.info("Hello, World!");

  9. myApplication.doIt();

  10. logger.error("Hello, World!");

  11. logger.exit();

  12. }

  13. }

  14. import org.apache.logging.log4j.LogManager;

  15. import org.apache.logging.log4j.Logger;

  16. public class MyApplication {

  17. static Logger logger = LogManager.getLogger(MyApplication.class.getName());

  18. public boolean doIt() {

  19. logger.entry();   //Log entry to a method

  20. logger.error("Did it again!"); //Log a message object with the ERROR level

  21. logger.exit();    //Log exit from a method

  22. return false;

  23. }

  24. }

运行程序,输出结果为:

  1. 16:10:28.672 [main] ERROR MyApplication - Did it again!
  2. 16:10:28.672 [main] ERROR HelloLog4j - Hello, World!

注意到,输出的log都是在ERROR level上的,log4j定义了8个级别的log(除去OFF和ALL,可以说分为6个级别),优先级从高到低依次为:OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、 ALL。如果将log level设置在某一个级别上,那么比此级别优先级高的log都能打印出来。例如,如果设置优先级为WARN,那么OFF、FATAL、ERROR、WARN 4个级别的log能正常输出,而INFO、DEBUG、TRACE、 ALL级别的log则会被忽略。从我们实验的结果可以看出,log4j默认的优先级为ERROR或者WARN(实际上是ERROR)。

3. 配置文件

          log4j是apache的一个开源项目,在写这篇博客的时候已经发布了2.0的beta版本,首先需要注意的是,log4j 2.0与以往的1.x有一个明显的不同,其配置文件只能采用.xml, .json或者 .jsn。在默认情况下,系统选择configuration文件的优先级如下:(classpath为scr文件夹)

  1. classpath下名为 log4j-test.json 或者log4j-test.jsn文件

  2. classpath下名为 log4j2-test.xml

  3. classpath下名为 log4j.json 或者log4j.jsn文件

  4. classpath下名为 log4j2.xml

必须注意.xml 文件的文件名为log4j2,这里让我纠结了一个下午,系统一直找不到配置文件,最后发现是文件名里面少了一个2。下面以log4j2.xml为例来介绍log4j的配置。

  1. <configuration status="OFF">
  2. <appenders>
  3. <Console name="Console" target="SYSTEM_OUT">
  4. <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
  5. </Console>
  6. </appenders>
  7. <loggers>
  8. <root level="trace">
  9. <appender-ref ref="Console"/>
  10. </root>
  11. </loggers>
  12. </configuration>

         

         首先介绍loggers标签,用于定义logger的lever和所采用的appender,其中appender-ref必须为先前定义的 appenders的名称,例如,此处为Console。那么log就会以appender所定义的输出格式来输出log。

         root标签为log的默认输出形式,如果一个类的log没有在loggers中明确指定其输出lever与格式,那么就会采用root中定义的格式。例如以下定义:

  1. <configuration status="OFF">
  2. <appenders>
  3. <Console name="Console" target="SYSTEM_OUT">
  4. <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
  5. </Console>
  6. </appenders>
  7. <loggers>
  8. <logger name="com.relin.HelloLog4j" level="error" additivity="false">
  9. <appender-ref ref="Console"/>
  10. </logger>
  11. <root level="trace">
  12. <appender-ref ref="Console"/>
  13. </root>
  14. </loggers>
  15. </configuration>

此时,HelloLog4j则会在error级别上输出log,而其他类则会在trace级别上输出log。需要注意的是 additivity选项,如果设置为true(默认值)则HelloLog4j的log会被打印两次,第二次打印是由于HelloLog4j同时也满足 root里面定义的trace

4. 其他特征

  1. <configuration status="error">
  2. <appenders>
  3. <Console name="Console" target="SYSTEM_OUT">
  4. <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/>
  5. <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
  6. </Console>
  7. <File name="log" fileName="target/test.log" append="false">
  8. <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
  9. </File>
  10. <RollingFile name="RollingFile" fileName="logs/app.log"
  11. filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
  12. <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
  13. <SizeBasedTriggeringPolicy size="500 MB" />
  14. </RollingFile>
  15. </appenders>
  16. <loggers>
  17. <root level="trace">
  18. <appender-ref ref="RollingFile"/>
  19. <appender-ref ref="Console"/>
  20. </root>
  21. </loggers>
  22. </configuration>

扩展组件

1,ConsoleAppender

输出结果到System.out或是System.err。

2,FileAppender

输出结果到指定文件,同时可以指定输出数据的格式。append=“false”指定不追加到文件末尾

3,RollingFileAppender

自动追加日志信息到文件中,直至文件达到预定的大小,然后自动重新生成另外一个文件来记录之后的日志。

过滤标签

1,ThresholdFilter

用来过滤指定优先级的事件。

2,TimeFilter

设置start和end,来指定接收日志信息的时间区间。

评论

暂无评论