詳解log4j2(上) - 從基礎到實戰

1 基礎配置

普通java項目手動添加jar包

log4j-api-2.5.jar
log4j-core-2.5.jar

Maven項目pom.xml

<dependencies>  
    <dependency>  
        <groupId>org.apache.logging.log4j</groupId>  
        <artifactId>log4j-api</artifactId>  
        <version>2.5</version>  
    </dependency>  
    <dependency>  
        <groupId>org.apache.logging.log4j</groupId>  
        <artifactId>log4j-core</artifactId>  
        <version>2.5</version>  
    </dependency>  
</dependencies>

測試代碼

public static void main(String[] args) {
    Logger logger = LogManager.getLogger(LogManager.ROOT_LOGGER_NAME);
    logger.trace("trace level");
    logger.debug("debug level");
    logger.info("info level");
    logger.warn("warn level");
    logger.error("error level");
    logger.fatal("fatal level");
}

運行後輸出

ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console.
20:37:11.965 [main] ERROR  - error level  
20:37:11.965 [main] FATAL  - fatal level

能夠看到log4j2先發了一句牢騷，抱怨沒有找到配置文件什麼的，不過仍是輸出了error和fatal兩個級別的信息。

log4j2默認會在classpath目錄下尋找log4j.json、log4j.jsn、log4j2.xml等名稱的文件，若是都沒有找到，則會按默認配置輸出，也就是輸出到控制檯。

下面咱們按默認配置添加一個log4j2.xml，添加到src根目錄便可

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <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="error">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

從新執行測試代碼，能夠看到輸出結果相同，可是沒有再提示找不到配置文件。
來看咱們添加的配置文件log4j2.xml，以Configuration爲根節點，有一個status屬性，這個屬性表示log4j2自己的日誌信息打印級別。若是把status改成TRACE再執行測試代碼，能夠看到控制檯中打印了一些log4j加載插件、組裝logger等調試信息。

日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL，若是設置爲WARN，則低於WARN的信息都不會輸出。對於Loggers中level的定義一樣適用。

下面是Appender配置，Appender能夠理解爲日誌的輸出目的地，這裏配置了一個類型爲Console的Appender，也就是輸出到控制檯。Console節點中的PatternLayout定義了輸出日誌時的格式：

%d{HH:mm:ss.SSS} 表示輸出到毫秒的時間

%t 輸出當前線程名稱

%-5level 輸出日誌級別，-5表示左對齊而且固定輸出5個字符，若是不足在右邊補0

%logger 輸出logger名稱，由於Root Logger沒有名稱，因此沒有輸出

%msg 日誌文本

%n 換行

其餘經常使用的佔位符有：

%F 輸出所在的類文件名，如Client.java

%L 輸出行號

%M 輸出所在方法名

%l  輸出語句所在的行數, 包括類名、方法名、文件名、行數

最後是Logger的配置，這裏只配置了一個Root Logger。

2 自定義Logger

首先修改測試代碼

public static void main(String[] args) {
    Logger logger = LogManager.getLogger("mylog");
    logger.trace("trace level");
    logger.debug("debug level");
    logger.info("info level");
    logger.warn("warn level");
    logger.error("error level");
    logger.fatal("fatal level");
}

logger從獲取Root Logger改成嘗試得到一個名稱爲mylog的Logger，在配置文件中一無所獲後，又找到了Root Logger，因此執行結果相同。

下面修改配置文件

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="300">
    <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="mylog" level="trace" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

再次執行測試代碼，這一次log4j2很高興的找到了名稱爲mylog的配置，因而使用新配置把level改成trace，所有的信息都輸出了。

additivity="false"表示在該logger中輸出的日誌不會再延伸到父層logger。這裏若是改成true，則會延伸到Root Logger，遵循Root Logger的配置也輸出一次。

注意根節點增長了一個monitorInterval屬性，含義是每隔300秒從新讀取配置文件，能夠不重啓應用的狀況下修改配置，仍是很好用的功能。

3 自定義Appender

修改配置文件，添加一個文件類型的Appender，而且把mylog的AppenderRef改成新加的Appender

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="300">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <File name="MyFile" fileName="D:/logs/app.log">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </File>
    </Appenders>
    <Loggers>
        <Logger name="mylog" level="trace" additivity="true">
            <AppenderRef ref="MyFile"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

執行並查看控制檯和D:/logs/app.log的輸出結果

4 實用型配置

下面配置一個按時間和文件大小滾動的RollingRandomAccessFile Appender，名字真是夠長，但不光只是名字長，相比RollingFileAppender有很大的性能提高，官網宣稱是20-200%。

Rolling的意思是當知足必定條件後，就重命名原日誌文件用於備份，並重新生成一個新的日誌文件。例如需求是天天生成一個日誌文件，可是若是一天內的日誌文件體積已經超過1G，就重新生成，兩個條件知足一個便可。這在log4j 1.x原生功能中沒法實現，在log4j2中就很簡單了。

看下面的配置

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="300">
    <properties>
        <property name="LOG_HOME">D:/logs</property>
        <property name="FILE_NAME">mylog</property>
    </properties>
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <RollingRandomAccessFile name="MyFile"
                                 fileName="${LOG_HOME}/${FILE_NAME}.log"
                                 filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">
            <PatternLayout
                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="20"/>
        </RollingRandomAccessFile>
    </Appenders>

    <Loggers>
        <Logger name="mylog" level="trace" additivity="false">
            <AppenderRef ref="MyFile"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

<properties>定義了兩個常量方便後面複用

RollingRandomAccessFile的屬性：

fileName  指定當前日誌文件的位置和文件名稱

filePattern  指定當發生Rolling時，文件的轉移和重命名規則

SizeBasedTriggeringPolicy  指定當文件體積大於size指定的值時，觸發Rolling

DefaultRolloverStrategy  指定最多保存的文件個數

TimeBasedTriggeringPolicy  這個配置須要和filePattern結合使用，注意filePattern中配置的文件重命名規則是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i，最小的時間粒度是mm，即分鐘，TimeBasedTriggeringPolicy指定的size是1，結合起來就是每1分鐘生成一個新文件。若是改爲%d{yyyy-MM-dd HH}，最小粒度爲小時，則每個小時生成一個文件。

修改測試代碼，模擬文件體積超過10M和時間超過1分鐘來驗證結果

public static void main(String[] args) {
    Logger logger = LogManager.getLogger("mylog");
    for(int i = 0; i < 50000; i++) {
        logger.trace("trace level");
        logger.debug("debug level");
        logger.info("info level");
        logger.warn("warn level");
        logger.error("error level");
        logger.fatal("fatal level");
    }
    try {
        Thread.sleep(1000 * 61);
    } catch (InterruptedException e) {}
    logger.trace("trace level");
    logger.debug("debug level");
    logger.info("info level");
    logger.warn("warn level");
    logger.error("error level");
    logger.fatal("fatal level");
}

5 自定義配置文件位置

log4j2默認在classpath下查找配置文件，能夠修改配置文件的位置。在非web項目中：

public static void main(String[] args) throws IOException {
    File file = new File("D:/log4j2.xml");
    BufferedInputStream in = new BufferedInputStream(new FileInputStream(file));
    final ConfigurationSource source = new ConfigurationSource(in);
    Configurator.initialize(null, source);

    Logger logger = LogManager.getLogger("mylog");
}

若是是web項目，在web.xml中添加

<context-param>  
    <param-name>log4jConfiguration</param-name>  
    <param-value>/WEB-INF/conf/log4j2.xml</param-value>  
</context-param>  

<listener>  
    <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>  
</listener>

掌握這些基本能夠實際使用了，下篇介紹一些高級應用，異步Appender、MongoDB Appender和基於Filters的按級別輸出到不一樣文件的設置