使用log4j2自定義配置文件位置和文件名(附log4j2.xml配置實例)

Posted on by

log4j2自定義配置文件位置和文件名

我們使用log4j2一般做法是將log4j2.xml文件放在資源文件夾根目錄。對於有強迫癥的開發者來說，我更喜歡在資源文件夾下新建包或文件夾，然後把配置文件放在裡面。本博客將介紹如何自定義log4j2.xml文件的位置和文件名。

web.xml配置

    <!-- 系統日志配置監聽器 -->
    <listener>
        <listener-class>edu.example.holder.system.Log4j2ConfigListener</listener-class>
    </listener>
    <context-param>
        <description>日志配置文件的路徑</description>
        <param-name>log4j.configurationFile</param-name>
        <param-value>log4j/log4j2.xml</param-value>
    </context-param>

Log4j2ConfigListener類是自定義的類，實現ServletContextListener接口，這樣tomcat啟動時可以更改日志配置文件的默認路徑和文件名。

生效配置文件

package edu.example.holder.system;
import java.util.Enumeration;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import org.apache.logging.log4j.core.config.Configurator;
public class Log4j2ConfigListener implements ServletContextListener
{
    private static final String KEY = "log4j.configurationFile";
    @Override
    public void contextDestroyed(ServletContextEvent arg0)
    {
    }
    @Override
    public void contextInitialized(ServletContextEvent arg0)
    {
        String fileName = getContextParam(arg0);
        Configurator.initialize("Log4j2", "classpath:" + fileName);
    }
    @SuppressWarnings("unchecked")
    private String getContextParam(ServletContextEvent event) {
        Enumeration<String> names = event.getServletContext().getInitParameterNames();
        while (names.hasMoreElements())
        {
            String name = names.nextElement();
            String value = event.getServletContext().getInitParameter(name);
            if(name.trim().equals(KEY))
            {
                return value;
            }
        }
        return null;
    }
}

日志配置文件實例

<?xml version="1.0" encoding="UTF-8"?>
<!--
    status : 這個用於設置log4j2自身內部的信息輸出,可以不設置,當設置成trace時,會看到log4j2內部各種詳細輸出
    monitorInterval : Log4j能夠自動檢測修改配置文件和重新配置本身, 設置間隔秒數。
    註：本配置文件的目標是將不同級別的日志輸出到不同文件，最大2MB一個文件，
    文件數據達到最大值時，舊數據會被壓縮並放進指定文件夾
-->
<Configuration status="WARN" monitorInterval="600">
    <Properties>
        <!-- 配置日志文件輸出目錄，此配置將日志輸出到tomcat根目錄下的指定文件夾 -->
        <Property name="LOG_HOME">${sys:catalina.home}/WebAppLogs/SSHExample</Property>
    </Properties>
    <Appenders>
        <!--這個輸出控制臺的配置，這裡輸出除瞭warn和error級別的信息到System.out-->
        <Console name="console_out_appender" target="SYSTEM_OUT">
            <!-- 控制臺隻輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch) -->
            <ThresholdFilter level="warn" onMatch="DENY" onMismatch="ACCEPT"/>  
            <!-- 輸出日志的格式 -->
            <PatternLayout pattern="%5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n"/>
        </Console>
        <!--這個輸出控制臺的配置，這裡輸出warn和error級別的信息到System.err，在eclipse控制臺上看到的是紅色文字-->
        <Console name="console_err_appender" target="SYSTEM_ERR">
            <!-- 控制臺隻輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch) -->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <!-- 輸出日志的格式 -->
            <PatternLayout pattern="%5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n"/>
        </Console>
        <!-- TRACE級別日志 -->
        <!-- 設置日志格式並配置日志壓縮格式，壓縮文件獨立放在一個文件夾內，
        日期格式不能為冒號，否則無法生成，因為文件名不允許有冒號，此appender隻輸出trace級別的數據到trace.log -->
        <RollingRandomAccessFile name="trace_appender"
                                 immediateFlush="true" fileName="${LOG_HOME}/trace.log"
                                 filePattern="${LOG_HOME}/trace/trace - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
            <PatternLayout>
                <pattern>%5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n</pattern>
            </PatternLayout>
            <Policies><!-- 兩個配置任選其一 -->
                <!-- 每個日志文件最大2MB -->
                <SizeBasedTriggeringPolicy size="2MB"/>
            </Policies>
            <Filters><!-- 此Filter意思是，隻輸出debug級別的數據 -->
                <!-- DENY，日志將立即被拋棄不再經過其他過濾器；
                       NEUTRAL，有序列表裡的下個過濾器過接著處理日志；
                       ACCEPT，日志會被立即處理，不再經過剩餘過濾器。 -->
                <ThresholdFilter level="debug" onMatch="DENY" onMismatch="NEUTRAL"/>  
                <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/> 
            </Filters>
        </RollingRandomAccessFile>
        <!-- DEBUG級別日志 -->
        <!-- 設置日志格式並配置日志壓縮格式，壓縮文件獨立放在一個文件夾內，
        日期格式不能為冒號，否則無法生成，因為文件名不允許有冒號，此appender隻輸出debug級別的數據到debug.log -->
        <RollingRandomAccessFile name="debug_appender"
                                 immediateFlush="true" fileName="${LOG_HOME}/debug.log"
                                 filePattern="${LOG_HOME}/debug/debug - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
            <PatternLayout>
                <pattern>%5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n</pattern>
            </PatternLayout>
            <Policies><!-- 兩個配置任選其一 -->
                <!-- 每個日志文件最大2MB -->
                <SizeBasedTriggeringPolicy size="2MB"/>
                <!-- 如果啟用此配置，則日志會按文件名生成新壓縮文件，
                即如果filePattern配置的日期格式為 %d{yyyy-MM-dd HH} ，則每小時生成一個壓縮文件，
                如果filePattern配置的日期格式為 %d{yyyy-MM-dd} ，則天生成一個壓縮文件 -->
<!--                 <TimeBasedTriggeringPolicy interval="1" modulate="true" /> -->
            </Policies>
            <Filters><!-- 此Filter意思是，隻輸出debug級別的數據 -->
                <!-- DENY，日志將立即被拋棄不再經過其他過濾器；
                       NEUTRAL，有序列表裡的下個過濾器過接著處理日志；
                       ACCEPT，日志會被立即處理，不再經過剩餘過濾器。 -->
                <ThresholdFilter level="info" onMatch="DENY" onMismatch="NEUTRAL"/>  
                <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/> 
            </Filters>
        </RollingRandomAccessFile>
        <!-- INFO級別日志 -->
        <RollingRandomAccessFile name="info_appender"
                                 immediateFlush="true" fileName="${LOG_HOME}/info.log"
                                 filePattern="${LOG_HOME}/info/info - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
            <PatternLayout>
                <pattern>%5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n</pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="2MB"/>
            </Policies>
            <Filters>
                <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL"/>  
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/> 
            </Filters>
        </RollingRandomAccessFile>
        <!-- WARN級別日志 -->
        <RollingRandomAccessFile name="warn_appender"
                                 immediateFlush="true" fileName="${LOG_HOME}/warn.log"
                                 filePattern="${LOG_HOME}/warn/warn - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
            <PatternLayout>
                <pattern>%5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n</pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="2MB"/>
            </Policies>
            <Filters>
                <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/>  
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/> 
              </Filters>
        </RollingRandomAccessFile>
        <!-- ERROR級別日志 -->
        <RollingRandomAccessFile name="error_appender"
                                 immediateFlush="true" fileName="${LOG_HOME}/error.log"
                                 filePattern="${LOG_HOME}/error/error - %d{yyyy-MM-dd HH_mm_ss}.log.gz">
            <PatternLayout>
                <pattern>%5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n</pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="2MB"/>
            </Policies>
            <Filters>
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
              </Filters>
        </RollingRandomAccessFile>
    </Appenders>
    <Loggers>
        <!-- 配置日志的根節點 -->
        <root level="trace">
            <appender-ref ref="console_out_appender"/>
            <appender-ref ref="console_err_appender"/>
            <appender-ref ref="trace_appender"/>
            <appender-ref ref="debug_appender"/>
            <appender-ref ref="info_appender"/>
            <appender-ref ref="warn_appender"/>
            <appender-ref ref="error_appender"/>
        </root>
        <!-- 第三方日志系統 -->
        <logger name="org.springframework.core" level="info"/>
        <logger name="org.springframework.beans" level="info"/>
        <logger name="org.springframework.context" level="info"/>
        <logger name="org.springframework.web" level="info"/>
        <logger name="org.jboss.netty" level="warn"/>
        <logger name="org.apache.http" level="warn"/>
    </Loggers>
</Configuration>

log4j2.xml配置及例子

1.使用log4j2需要下載包

如下：

2.配置文件可以有三種格式

(文件名必須規范,否則系統無法找到配置文件)：

  • classpath下名為 log4j-test.json 或者log4j-test.jsn文件
  • classpath下名為 log4j2-test.xml
  • classpath下名為 log4j.json 或者log4j.jsn文件
  • classpath下名為 log4j2.xml

3.日志記錄有兩種方法

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

4.我用的xml的配置

所以介紹一下xml配置：

1.首先要配幾個要用到的appender,這些appender功能不一樣,比如有常規輸出,重大異常輸出,你可能需要他們輸出形式或者輸出的文件不同,這些都可以在appender中配置

2.appender裡面的一些配置說明：

  • name：appender的名稱
  • fileName：輸出文件和名稱
  • append：是否追加，true表示追加內容到所在的日志，false表示每次都覆蓋
  • filePattern：表示當日志到達指定的大小或者時間，產生新日志時，舊日志的命名路徑
  • PatternLayout：指定輸出日志的格式，具體代表的意思見前面的博客中
  • Policies：策略，表示日志什麼時候應該產生新日志，可以有時間策略和大小策略等
  • ThresholdFilter ：過濾器，log4j2中有很多的filter

3.接下來配置logger

指定哪些類進行何種輸出，這個比較簡單，可以直接看栗子:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration monitorInterval="1" status="ERROR" strict="true" name="LogConfig">
    <Properties>
        <Property name="logbasedir">e:/log</Property>
        <Property name="log.layout">%d %-5p %t (%c:%L) - %m%n</Property>
    </Properties>
    
    <--此處使用瞭兩種類型的appender,RollingFile為滾動類型,滿足策略條件後會新建文件夾記錄 -->
    <Appenders>
        <Appender type="Console" name="STDOUT">
            <Target>SYSTEM_OUT</Target>
            <Layout type="PatternLayout" pattern="${log.layout}"/>
        </Appender>
        <Appender type="RollingFile" name="FILE" fileName="${logbasedir}/jutap-${sys:APPNAME}.log"
             filePattern = "${logbasedir}/jutap-${sys:APPNAME}-%d{yyyy-MM-dd}.%i.log">
            <Policies>
                <TimeBasedTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <Layout type="PatternLayout">
                <Charset>GBK</Charset>
                <Pattern>${log.layout}</Pattern>
            </Layout>
        </Appender>
        <Appender type="RollingFile" name="ExceptionLog" fileName="${logbasedir}/exception-${sys:APPNAME}.log"
                  filePattern = "${logbasedir}/exception-${sys:APPNAME}-%d{yyyy-MM-dd}.%i.log">
            <Policies>
                <TimeBasedTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <Layout type="PatternLayout">
                <Charset>GBK</Charset>
                <Pattern>${log.layout}</Pattern>
            </Layout>
        </Appender>
    </Appenders>
    <Loggers>
        <Logger name="exception" level="error" additivity="false">
            <AppenderRef ref="ExceptionLog"/>
        </Logger>
        <Root level="info">
            <AppenderRef ref="STDOUT"/>
            <AppenderRef ref="FILE"/>
        </Root>
        <Logger name="com.garfield.learn" level="debug"/>
        <Logger name="com.garfield.learnp" level="info"/>
    </Loggers>
</Configuration>

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：