log4j2的配置和使用中遇到的問題

log4j2 環境的配置

首先從官網 https://logging.apache.org/log4j/2.x/download.html 中下載最新版本的log4j2的jar包。

下載到本地之後，我們在eclipse中在項目名稱上右擊選擇Build Path，選擇其中的Configure Build Path。在打開的彈窗中選擇Add External Jars。然後文件選擇已經解壓完的所有jar文件添加到build path中。

配置成功後，在Referenced Libraries中出現我們加入的jar。

log4j2 配置文件的編寫

我們接下來需要寫log4j2.xml作爲配置文件。

1.配置文件的位置

首先說明關於配置文件的名稱以及在項目中的存放位置。
log4j 2.x版本不再支持像1.x中的.properties後綴的文件配置方式，2.x版本配置文件後綴名只能爲”.xml”,”.json”或者”.jsn”.
系統選擇配置文件的優先級(從先到後)如下：
(1).classpath下的名爲log4j2-test.json 或者log4j2-test.jsn的文件.
(2).classpath下的名爲log4j2-test.xml的文件.
(3).classpath下名爲log4j2.json 或者log4j2.jsn的文件.
(4).classpath下名爲log4j2.xml的文件.
我們一般默認使用log4j2.xml進行命名。如果本地要測試，可以把log4j2-test.xml放到classpath，而正式環境使用log4j2.xml，則在打包部署的時候不要打包log4j2-test.xml即可。

2.配置文件的各項參數的說明

1. 根節點Configuration有兩個屬性:status和monitorinterval,有兩個子節點:Appenders和Loggers(表明可以定義多個Appender和Logger).
   　　　status用來指定log4j本身的打印日誌的級別.
   　　　monitorinterval用於指定log4j自動重新配置的監測間隔時間，單位是s,最小是5s.
2. Appenders節點，常見的有三種子節點:Console、RollingFile、File.
   Console節點用來定義輸出到控制檯的Appender.
   　　　name:指定Appender的名字.
   　　　target:SYSTEM_OUT 或 SYSTEM_ERR,一般只設置默認:SYSTEM_OUT.
   　　　PatternLayout:輸出格式，不設置默認爲:%m%n.
   File節點用來定義輸出到指定位置的文件的Appender.
   　　　name:指定Appender的名字.
   　　　fileName:指定輸出日誌的目的文件帶全路徑的文件名.
   　　　PatternLayout:輸出格式，不設置默認爲:%m%n.
   RollingFile節點用來定義超過指定大小自動刪除舊的創建新的Appender.
   　　　name:指定Appender的名字.
   　　　fileName:指定輸出日誌的目的文件帶全路徑的文件名.
   　　　PatternLayout:輸出格式，不設置默認爲:%m%n.
   　　　filePattern:指定新建日誌文件的名稱格式.
   　　　Policies:指定滾動日誌的策略，就是什麼時候進行新建日誌文件輸出日誌.
   　　　　　　TimeBasedTriggeringPolicy:Policies子節點，基於時間的滾動策略，interval屬性用來指定多久滾動一次，默認是1 hour。modulate=true用來調整時間：比如現在是早上3am，interval是4，那麼第一次滾動是在4am，接着是8am，12am…而不是7am.
   　　　　　　SizeBasedTriggeringPolicy:Policies子節點，基於指定文件大小的滾動策略，size屬性用來定義每個日誌文件的大小.
   　　　　　　DefaultRolloverStrategy:用來指定同一個文件夾下最多有幾個日誌文件時開始刪除最舊的，創建新的(通過max屬性)。
   Loggers節點，常見的有兩種:Root和Logger.
   Root節點用來指定項目的根日誌，如果沒有單獨指定Logger，那麼就會默認使用該Root日誌輸出
   　　　level:日誌輸出級別，共有8個級別，按照從低到高爲：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
   　　　 AppenderRef：Root的子節點，用來指定該日誌輸出到哪個Appender.
   Logger節點用來單獨指定日誌的形式，比如要爲指定包下的class指定不同的日誌級別等。
   　　　level:日誌輸出級別，共有8個級別，按照從低到高爲：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
   　　　name:用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節點.
   　　　AppenderRef：Logger的子節點，用來指定該日誌輸出到哪個Appender,如果沒有指定，就會默認繼承自Root.如果指定了，那麼會在指定的這個Appender和Root的Appender中都會輸出，此時我們可以設置Logger的additivity=”false”只在自定義的Appender中進行輸出。 　　　　　　
3. 關於日誌level.
   共有8個級別，按照從低到高爲：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
   All:最低等級的，用於打開所有日誌記錄.
   Trace:是追蹤，就是程序推進以下，你就可以寫個trace輸出，所以trace應該會特別多，不過沒關係，我們可以設置最低日誌級別不讓他輸出.
   Debug:指出細粒度信息事件對調試應用程序是非常有幫助的.
   Info:消息在粗粒度級別上突出強調應用程序的運行過程.
   Warn:輸出警告及warn以下級別的日誌.
   Error:輸出錯誤信息日誌.
   Fatal:輸出每個嚴重的錯誤事件將會導致應用程序的退出的日誌.
   OFF:最高等級的，用於關閉所有日誌記錄.

3.配置文件的編寫結果

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">  
    <Appenders>
        <Console name="STDOUT" target="SYSTEM_OUT">
            <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/>
        </Console>
        <File name="File1" fileName="logs/GraphPoetApp_logs.log">
            <PatternLayout>
                <Pattern>[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%n</Pattern>
            </PatternLayout>            
        </File>
        <File name="File2" fileName="logs/MovieGraphApp_logs.log">
            <PatternLayout>
                <Pattern>[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%n</Pattern>
            </PatternLayout>            
        </File>
        <File name="File3" fileName="logs/NetworkTopologyApp_logs.log">
            <PatternLayout>
                <Pattern>[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%n</Pattern>
            </PatternLayout>            
        </File>
        <File name="File4" fileName="logs/SocialNetworkApp_logs.log">
            <PatternLayout>
                <Pattern>[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%n</Pattern>
            </PatternLayout>            
        </File>
    </Appenders>
    <Loggers>
        <Logger name="GraphPoetApp" level="INFO" additivity="true">
            <AppenderRef ref="File1"/>
        </Logger>
        <Logger name="MovieGraphApp" level="INFO" additivity="true">
            <AppenderRef ref="File2"/>
        </Logger>
        <Logger name="NetworkTopologyApp" level="INFO" additivity="true">
            <AppenderRef ref="File3"/>
        </Logger>
        <Logger name="SocialNetworkApp" level="INFO" additivity="true">
            <AppenderRef ref="File4"/>
        </Logger>
        <Root level="INFO">
            <AppenderRef ref="STDOUT"/>
        </Root>
    </Loggers>
</Configuration>

配置文件設置的解釋：
設置的控制檯輸出格式爲：
%d %-5p [%t] %C{2} (%F:%L) - %m%n
設置的文件中的輸出格式爲：
[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%n
文件的輸出路徑：
logs/GraphPoetApp_logs.log
logs/MovieGraphApp_logs.log
logs/NetworkTopologyApp_logs.log
logs/SocialNetworkApp_logs.log
文件輸出等級：
INFO
文件輸出形式：
File，Pattern Layout。

4.最後的工作

將寫好的文件放在src的文件夾下即可。

如何使用log4j2進行日誌記錄

首先在開始的時候導入包

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

然後使用如下代碼獲得一個Logger的對象。

Logger logger = LogManager.getLogger("GraphPoetApp");

最後我們可以調用這個logger對象使用其info，debug，warn等方法進行文件的寫入record。

logger.debug("test");

使用中遇到的問題

1.

測試log是否能正常運行的test文件

public class test{
static Logger log =Logger.getLogger(Log4jtest.class);
  public static void main(String[] args) {
     BasicConfigurator.configure();
     log.debug("This is debug message");
  }
}

但是報錯：

Exception in thread "main" java.lang.ExceptionInInitializerError
Caused by: java.lang.ClassCastException: org.apache.logging.slf4j.SLF4JLoggerContext cannot be cast to org.apache.logging.log4j.core.LoggerContext

根據Stack Overflow的查詢：
從build path的jars中去掉以下的包，問題解決。
log4j-to-slf4j-2.0.2.jar
log4j-to-slf4j-2.0.2-sources.jar
log4j-slf4j-impl-2.0.2.jar
log4j-slf4j-impl-2.0.2-sources.jar

2.

一開始將文件放在工程目錄下，（即和src同級的文件夾中），運行測試報錯找不到文件，使用默認配置：

經過查詢：
查看配置文件的位置一項。
因此我們要將xml的文件放到src文件夾下。

3.

在使用log進行記錄的時候，出現了log.1和log.2等文件。
根據百度的查詢，知道了是因爲在進行記錄的時候沒有將log進行關閉，會有文件的讀寫的保護

參考文獻：

Log4J使用詳解(整理)
https://blog.csdn.net/u011781521/article/details/55002553
聊一聊log4j2配置文件log4j2.xml
https://www.cnblogs.com/hafiz/p/6170702.html
log4j2 實際使用詳解
https://blog.csdn.net/vbirdbest/article/details/71751835