log4j2 使用详解

         前段时间一直用jWebSocket开发长连接的web服务，发现log4j记录log极为好用，今天准备仔细研究一下。

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记录日志，代码如下：

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

public class HelloLog4j {
	private static Logger logger = LogManager.getLogger("HelloLog4j");
	public static void main(String[] args) {
		MyApplication myApplication =  new MyApplication();
		
		logger.entry();
		logger.info("Hello, World!"); 
		myApplication.doIt();
        logger.error("Hello, World!");
        logger.exit();
	}
}

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


public class MyApplication {
    static Logger logger = LogManager.getLogger(MyApplication.class.getName());  
    
    public boolean doIt() {  
      logger.entry();   //Log entry to a method  
      logger.error("Did it again!");   //Log a message object with the ERROR level  
      logger.exit();    //Log exit from a method   
      return false;  
    }  
}

运行程序，输出结果为：

16:10:28.672 [main] ERROR MyApplication - Did it again!
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的配置。

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
  <appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </appenders>
  <loggers>
    <root level="trace">
      <appender-ref ref="Console"/>
    </root>
  </loggers>
</configuration>

         

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

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

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
  <appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </appenders>
  <loggers>
    <logger name="com.relin.HelloLog4j" level="error" additivity="false">
      <appender-ref ref="Console"/>
    </logger>
    <root level="trace">
      <appender-ref ref="Console"/>
    </root>
  </loggers>
</configuration>

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

4. 其他特征

<?xml version="1.0" encoding="UTF-8"?>  
<configuration status="error">  
  <appenders>  
    <Console name="Console" target="SYSTEM_OUT">  
      <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/>  
      <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>  
    </Console>  
    <File name="log" fileName="target/test.log" append="false">  
      <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>  
    </File>  
    <RollingFile name="RollingFile" fileName="logs/app.log"  
                 filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">  
      <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>  
      <SizeBasedTriggeringPolicy size="500 MB" />  
    </RollingFile>  
  </appenders>  
  <loggers>  
    <root level="trace">  
      <appender-ref ref="RollingFile"/>  
      <appender-ref ref="Console"/>  
    </root>  
  </loggers>  
</configuration> 

扩展组件

1，ConsoleAppender

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

2，FileAppender

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

3，RollingFileAppender

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

过滤标签

1，ThresholdFilter

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

2，TimeFilter

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