log4j和log4j2

log4j

log4j是之前最流行的日誌輸出系統,目前儘管有了log4j2和其他日誌輸出系統。但log4j 裏面的概念還是保留了。

先看個例子:

這裏我使用的是 slf4 => log4j,依賴:

dependencies {
    compile "org.slf4j:slf4j-api:1.7.30"
    compile "org.slf4j:slf4j-log4j12:1.7.30" // 適配到 log4j
    compile "log4j:log4j:1.2.17"
}

打印日誌時,只需要:

private Logger logger = LoggerFactory.getLogger(XXX.class);
// 注意是 slf4j的 org.slf4j.Logger

概念

Logger

輸出日誌之前都要獲取一個Logger。一個 Logger 被當作爲一個實體。而且Logger是有層級關係的,跟包名的層級是一致的。
比如,名爲com.hust 的Logger 的父級是 名爲 com 的Logger。而且會自動關聯。而且向上最高層是root logger。

等級

Logger 能夠被分成不同的等級(TRACE, DEBUG, INFO, WARN, ERROR)。對於一個給定的名爲 L 的 logger,它的有效層級爲從自身一直回溯到 root logger,直到找到第一個不爲空的層級作爲自己的層級。
爲了確保所有的 logger 都有一個層級,root logger 會有一個默認層級 --- DEBUG。root logger 默認等級是DEBUG。
這樣所有的logger都會有一個等級。

打印規則

日誌的打印級別爲 p,Logger 實例的級別爲 q,如果 p >= q,則該條日誌可以打印出來。
日誌的打印級別爲 p,Logger 實例的級別爲 q,如果 p >= q,則該條日誌可以打印出來
TRACE < DEBUG < INFO < WARN < ERROR。

 

Appender

輸出目的地叫做 appender。appender 包括console、file、remote socket server、MySQL、PostgreSQL、Oracle 或者其它的數據庫、JMS、remote UNIX Syslog daemons 中。
這樣可以指定的把日誌輸出到不同的地方。
另外,logger L 的日誌輸出語句會遍歷 L 和它的子級中所有的 appender。這就是所謂的 appender 疊加性(appender additivity)。

因此,對於Logger L
設置 additivity = true,logger L的appender 就是 自己的appender 疊加其父級的appender;
設置 additivity = fasle,L的appender 只有自己指定的appender。L的子層級也無法繼承L的appender。

值得注意的是:如果 L 指定了appender,同時父層級也有同樣的appender,會當成兩個appender處理,即會輸出兩遍。

常用的appender有:
ConsoleAppender: 輸出到控制檯;
FileAppender:輸出到文件;
RollingFileAppender:輸出到文件,文件達到一定閾值時,自動備份日誌文件;
DailyRollingFileAppender:可定期備份日誌文件,默認一天一個文件,也可設置爲每分鐘一個、每小時一個;
WriterAppender:可自定義日誌輸出位置。

PatternLayout

也就是日誌的格式化輸出。利用PatternLayout定義日誌輸出格式,附帶把輸出日誌的環境信息帶上,增加日誌的可讀性。

%n - 換行
%m - 日誌內容
%p - 日誌級別(FATAL,ERROR,WARN,INFO,DEBUG)
%r - 程序啓動到現在的毫秒數
%t - 當前線程名
%d - 日期和時間, 一般使用格式 %d{yyyy-MM-dd HH:mm:ss, SSS}
%l - 輸出日誌事件的發生位置, 同 %F%L%C%M
%F - java 源文件名
%L - java 源碼行數
%C - java 類名,%C{1} 輸出最後一個元素
%M - java 方法名

配置

log4j配置

log4j.xml 最基本的結構爲 <log4j:configuration> 元素,包含 0 或多個 <appender> 元素,其後跟 0 或多個 <logger> 元素,其後再跟最多隻能存在一個的 <root> 元素。

一個比較全的配置如下:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration>

    <!-- 將日誌信息輸出到控制檯 -->
    <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
        <!-- 設置日誌輸出的樣式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 設置日誌輸出的格式 -->
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%t] [%-5p] [method:%l] %m%n"/>
        </layout>
        <!--過濾器設置輸出的級別-->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <!-- 設置日誌輸出的最小級別 -->
            <param name="levelMin" value="INFO"/>
            <!-- 設置日誌輸出的最大級別 -->
            <param name="levelMax" value="ERROR"/>
            <!-- 設置日誌輸出的xxx,默認是false -->
            <param name="AcceptOnMatch" value="true"/>
        </filter>
    </appender>

    <!-- 單獨過濾並輸出 ERROR 日誌到 error.log 文件 -->
    <appender name="ERROR" class="org.apache.log4j.FileAppender">
        <!-- 輸出文件全路徑名-->
        <param name="File" value="/Users/zhangwei/note/error.log"/>

        <!--是否在已存在的文件追加寫:默認時true,若爲false則每次啓動都會刪除並重新新建文件-->
        <param name="Append" value="false"/>
        <!--是否啓用緩存,默認false-->
        <param name="BufferedIO" value="false"/>
        <!--緩存大小,依賴上一個參數(bufferedIO), 默認緩存大小8K  -->
        <param name="BufferSize" value="512"/>
        <!-- 日誌輸出格式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%p][%d{yyyy-MM-dd HH:mm:ss SSS}] [%t] [%c]-[%m]%n"/>
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="LevelMin" value="ERROR"/>
            <param name="LevelMax" value="ERROR"/>
        </filter>
    </appender>

    <!-- 將日誌信息輸出到文件,但是當文件的大小達到某個閾值的時候,日誌文件會自動回滾 -->
    <appender name="RollingFileAppender" class="org.apache.log4j.RollingFileAppender">
        <!-- 設置日誌信息輸出文件全路徑名 -->
        <param name="File" value="/Users/zhangwei/note/day.log"/>
        <!-- 設置是否在重新啓動服務時,在原有日誌的基礎添加新日誌 -->
        <param name="Append" value="true"/>
        <!-- 設置保存備份回滾日誌的最大個數 -->
        <param name="MaxBackupIndex" value="10"/>
        <!-- 設置當日志文件達到此閾值的時候自動回滾,單位可以是KB,MB,GB,默認單位是KB -->
        <param name="MaxFileSize" value="10KB"/>
        <!-- 設置日誌輸出的樣式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 設置日誌輸出的格式 -->
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%t] [%-5p] [method:%l] %m%n"/>
        </layout>
    </appender>

    <!-- 將日誌信息輸出到文件,可以配置多久產生一個新的日誌信息文件 -->
    <appender name="DailyRollingFileAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <!-- 設置日誌信息輸出文件全路徑名 -->
        <param name="File" value="/Users/zhangwei/note/Appender.log"/>
        <!-- 設置日誌每分鐘回滾一次,即產生一個新的日誌文件 -->
        <param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'"/>
        <!-- 設置日誌輸出的樣式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 設置日誌輸出的格式 -->
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%t] [%-5p] [method:%l] %m%n"/>
        </layout>
    </appender>

    <logger name="com">
        <level value="INFO"/>
        <!-- 沒有設置appender ,則使用父層級的appender,即root的全部appender -->
    </logger>

    <logger name="com.hust">
        <level value="INFO"/>
        <!-- 因爲父層級設置了additivity="false" ,因此只能輸出到自己指定appender -->
        <appender-ref ref="ConsoleAppender"/>
    </logger>

    <!-- root logger的設置-->
    <root>
        <level value="INFO"/>
        <appender-ref ref="RollingFileAppender"/>
        <appender-ref ref="ERROR"/>
    </root>


</log4j:configuration>


不過log4j是一個很舊的系統了,最新的版本也是2012年的了。

log4j2配置

之前說到 log4j2是appache重新開發出新版本。它的配置和使用,包括性能更高。

引入:

dependencies {
    compile "org.slf4j:slf4j-api:1.7.30"
    compile "org.apache.logging.log4j:log4j-slf4j-impl:2.13.1"// 適配到log4j2

    compile "org.apache.logging.log4j:log4j-core:2.13.1"
    compile "org.apache.logging.log4j:log4j-api:2.13.1"
}

對應的配置文件是 log4j2.xml。注意不是  log4j.xml 了。它的結構也很簡單:

基本結構是<Configuration> ,裏面可以包含一個<Properties> ,一個 <Appenders> 和一個<Loggers>。其中:

<Properties> 裏面用於定義變量。

<Appenders> 裏面定義0或多個appender。常見的有三種子節點:Console、RollingFile、File.

<Loggers> 裏面定義 0 或多個 <logger> 元素,其後再跟最多隻能存在一個的 <root> 元素。

說明:

Appender

屬性

解釋

Console

定義輸出到控制檯

name

指定Appender的名字

target

SYSTEM_OUT SYSTEM_ERR

PatternLayout

輸出格式,不設置默認爲:%m%n。即只有內容

File

定義輸出到指定位置的文件

name

指定Appender的名字

fileName

輸出日誌的目的文件帶全路徑的文件名

PatternLayout

輸出格式,不設置默認爲:%m%n。即只有內容

RollingFile

定義超過指定大小自動刪除舊的創建新的文件

name

指定Appender的名字

fileName

輸出日誌的目的文件帶全路徑的文件名

PatternLayout

輸出格式,不設置默認爲:%m%n。即只有內容

filePattern

新建日誌文件的名稱格式

Policies

滾動日誌的策略,即何時新建立日誌輸出文件

TimeBasedTriggeringPolicy

Policies子節點

interval:多久滾動一次,默認1hour
modulate=true
:是否調整,從0點開始

SizeBasedTriggeringPolicy

Policies子節點
指定文件大小的滾動策略
size屬性用來定義每個日誌文件的大小

DefaultRolloverStrategy

同一個文件夾下最多有幾個日誌文件時開始刪除最舊的,創建新的

例子:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <!-- 變量 -->
    <Properties>
        <Property name="APP_NAME">Log4j2_test</Property>
    </Properties>
    <!-- appenders -->
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${APP_NAME} %d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    
    <Loggers>
        <!-- 其他logs -->
        <Logger name="com.hust" level="info">
            <AppenderRef ref="Console"/>
        </Logger>
        <!-- root logger -->
        <Root level="error">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

這裏列舉一個網上比較完整的配置例子:

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="WARN">
    <!--先定義所有的appender-->
    <appenders>
        <!--這個輸出控制檯的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--輸出日誌的格式-->
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
        </console>
        <!--文件會打印出所有信息,append =false 代表每次清空,測試用-->
        <File name="logToFile" fileName="/Users/zhangwei/note/log.log" append="false">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

        <!-- 這個會打印出所有的info及以下級別的信息,每次大小超過size,則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮,作爲存檔-->
        <RollingFile name="RollingFileInfo" fileName="/Users/zhangwei/note/${sys:user.home}/logs/info.log"
                     filePattern="/Users/zhangwei/note/${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <!--控制檯只輸出level及以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>

        <RollingFile name="RollingFileWarn" fileName="/Users/zhangwei/note/${sys:user.home}/logs/warn.log"
                     filePattern="/Users/zhangwei/note/${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置,則默認爲最多同一文件夾下7個文件,這裏設置了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>

        <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
                     filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
    </appenders>
    <loggers>
        <logger name="com" level="INFO" additivity="false">
            <!-- 沒有設置appender ,則使用父層級的appender,即root的全部appender -->
        </logger>
        <logger name="com.hust" level="INFO">
            <!-- 因爲父層級設置了additivity="false" ,因此只能輸出到自己指定appender -->
            <appender-ref ref="Console"/>
        </logger>
        <root level="INFO">
            <appender-ref ref="Console"/>
            <appender-ref ref="ERROR"/>
        </root>
    </loggers>
</configuration>

 

 

 

 

 

 

 

 

 

 

 

 

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章