Log4j 2.X 使用總結

轉載自 Blog of 天外的星星：　http://www.cnblogs.com/leo-lsw/p/log4j2tutorial.html

Log4j 2的好處就不和大家說了，如果你搜了2，說明你對他已經有一定的瞭解，並且想用它，所以這裏直接就上手了。

　　1. 去官方下載log4j 2，導入jar包，基本上你只需要導入下面兩個jar包就可以了(xx是亂七八糟的版本號)：

　　　　log4j-core-xx.jar

　　　　log4j-api-xx.jar

　　2. 導入到你的項目中：這個就不說了。

　　3. 開始使用：

　　　　我們知道，要在某個類中使用log4j記錄日誌，只需要申明下面的成員變量（其實不一定要是成員變量，只是爲了方便調用而已）

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

　　　　這裏getLogger有一個參數指定的是這個logger的名稱，這個名稱在配置文件裏面可是有需要的，這個待會兒再說。

　　　　聲明瞭Logger對象，我們就可以在代碼中使用他了。

　　4. 日誌的級別：

　　　　我們現在要調用logger的方法，不過在這個Logger對象中，有很多方法，所以要先了解log4j的日誌級別，log4j規定了默認的幾個級別：trace<debug<info<warn<error<fatal等。這裏要說明一下：

　　　　1）級別之間是包含的關係，意思是如果你設置日誌級別是trace，則大於等於這個級別的日誌都會輸出。

　　　　2）基本上默認的級別沒多大區別，就是一個默認的設定。你可以通過它的API自己定義級別。你也可以隨意調用這些方法，不過你要在配置文件裏面好好處理了，否則就起不到日誌的作用了，而且也不易讀，相當於一個規範，你要完全定義一套也可以，不用沒多大必要。

　　　　3）這不同的級別的含義大家都很容易理解，這裏就簡單介紹一下：

　　　　trace：是追蹤，就是程序推進以下，你就可以寫個trace輸出，所以trace應該會特別多，不過沒關係，我們可以設置最低日誌級別不讓他輸出。

　　　　debug：調試麼，我一般就只用這個作爲最低級別，trace壓根不用。是在沒辦法就用eclipse或者idea的debug功能就好了麼。

　　　　info：輸出一下你感興趣的或者重要的信息，這個用的最多了。

　　　　warn：有些信息不是錯誤信息，但是也要給程序員的一些提示，類似於eclipse中代碼的驗證不是有error 和warn（不算錯誤但是也請注意，比如以下depressed的方法）。

　　　　error：錯誤信息。用的也比較多。

　　　　fatal：級別比較高了。重大錯誤，這種級別你可以直接停止程序了，是不應該出現的錯誤麼！不用那麼緊張，其實就是一個程度的問題。

　　5. 日誌調用：

　　　　這裏隨便寫個類，調用就是這麼簡單，log4j的核心在配置文件上。

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

public class Hello {

    static Logger logger = LogManager.getLogger(Hello.class.getName());

    public boolean hello() {
        logger.entry();   //trace級別的信息，單獨列出來是希望你在某個方法或者程序邏輯開始的時候調用，和logger.trace("entry")基本一個意思
        logger.error("Did it again!");   //error級別的信息，參數就是你輸出的信息
        logger.info("我是info信息");    //info級別的信息
        logger.debug("我是debug信息");
        logger.warn("我是warn信息");
        logger.fatal("我是fatal信息");
        logger.log(Level.DEBUG, "我是debug信息");   //這個就是制定Level類型的調用：誰閒着沒事調用這個，也不一定哦！
        logger.exit();    //和entry()對應的結束方法，和logger.trace("exit");一個意思
        return false;
    }
}

　　如果沒有自定義配置文件，上面這個類在寫一個main方法，控制檯會輸入下面的樣子：

19:09:40.256 [main] ERROR cn.lsw.base.log4j2.Hello - Did it again!
19:09:40.260 [main] FATAL cn.lsw.base.log4j2.Hello - 我是fatal信息

　　看到沒，只有>=ERROR的日誌輸出來了（這是因爲Log4j有一個默認的配置，它的日誌級別是ERROR，輸出只有控制檯）。如果我已經定義好了日誌，我把日誌級別改成了TRACE，輸出會變成下面這樣：　

19:11:36.941 TRACE cn.lsw.base.log4j2.Hello 12 hello - entry
19:11:36.951 ERROR cn.lsw.base.log4j2.Hello 13 hello - Did it again!
19:11:36.951 INFO  cn.lsw.base.log4j2.Hello 14 hello - 我是info信息
19:11:36.951 DEBUG cn.lsw.base.log4j2.Hello 15 hello - 我是debug信息
19:11:36.951 WARN  cn.lsw.base.log4j2.Hello 16 hello - 我是warn信息
19:11:36.952 FATAL cn.lsw.base.log4j2.Hello 17 hello - 我是fatal信息
19:11:36.952 DEBUG cn.lsw.base.log4j2.Hello 18 hello - 我是debug信息
19:11:36.952 TRACE cn.lsw.base.log4j2.Hello 19 hello - exit

　　所有的日誌都打印出來了，大家可以對照上面的代碼看一看。

　　6. 配置文件：

　　現在開始正題了。

　　本來以爲Log4J 2應該有一個默認的配置文件的，不過好像沒有找到，下面這個配置文件等同於缺省配置（from http://blog.csdn.net/welcome000yy/article/details/7962668）：

<?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="error">  
      <appender-ref ref="Console"/>  
    </root>  
  </loggers>  
</configuration>

　　而我們只要把configuration->loggers->root的level屬性改爲trace，就可以輸出剛纔寫的所有信息了。相信用過Log4j的人對這個配置文件也不算陌生，Log4J傳統的配置一直是.properties文件，鍵值對的形式，那種配置方式很不好看，但是基本上我們從這個配置文件也能看到Log4J 1的影子，無非是appender了，layout之類的，含義也基本一樣的。

　　這裏不準備仔細的講配置文件，沒什麼必要，大家只要知道一些基本的配置就可以了。我這裏寫幾個配置文件，並且給了一定的註釋和講解，基本上可以用了。

我們需要注意的是2.0版本中的配置只能爲Xml和Json，並且log4j2.X中配置文件的名稱爲log4j2.XML。

　第一個例子：

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </appenders>
    <loggers>
        <!--我們只讓這個logger輸出trace信息，其他的都是error級別-->
        <!--
        additivity開啓的話，由於這個logger也是滿足root的，所以會被打印兩遍。
        不過root logger 的level是error，爲什麼Bar 裏面的trace信息也被打印兩遍呢
        -->
        <logger name="cn.lsw.base.log4j2.Hello" level="trace" additivity="false">
            <appender-ref ref="Console"/>
        </logger>
        <root level="error">
            <appender-ref ref="Console"/>
        </root>
    </loggers>
</configuration>

　先簡單介紹一下下面這個配置文件。

　　1）根節點configuration，然後有兩個子節點：appenders和loggers（都是複數，意思就是可以定義很多個appender和logger了）（如果想詳細的看一下這個xml的結構，可以去jar包下面去找xsd文件和dtd文件）

　　2）appenders：這個下面定義的是各個appender，就是輸出了，有好多類別，這裏也不多說（容易造成理解和解釋上的壓力，一開始也未必能聽懂，等於白講），先看這個例子，只有一個Console，這些節點可不是隨便命名的，Console就是輸出控制檯的意思。然後就針對這個輸出設置一些屬性，這裏設置了PatternLayout就是輸出格式了，基本上是前面時間，線程，級別，logger名稱，log信息等，差不多，可以自己去查他們的語法規則。

　　3）loggers下面會定義許多個logger，這些logger通過name進行區分，來對不同的logger配置不同的輸出，方法是通過引用上面定義的logger，注意，appender-ref引用的值是上面每個appender的name，而不是節點名稱。

　　這個例子爲了說明什麼呢？我們要說說這個logger的name（名稱）了（前面有提到）。

　　7. name的機制：(可以參考： http://logging.apache.org/log4j/2.x/manual/architecture.html)

　　　我們這裏看到了配置文件裏面是name很重要，沒錯，這個name可不能隨便起（其實可以隨便起）。這個機制意思很簡單。就是類似於java package一樣，比如我們的一個包：cn.lsw.base.log4j2。而且，可以發現我們前面生成Logger對象的時候，命名都是通過 Hello.class.getName(); 這樣的方法，爲什麼要這樣呢？很簡單，因爲有所謂的Logger 繼承的問題。比如如果你給cn.lsw.base定義了一個logger，那麼他也適用於cn.lsw.base.lgo4j2這個logger。名稱的繼承是通過點（.）分隔的。然後你可以猜測上面loggers裏面有一個子節點不是logger而是root，而且這個root沒有name屬性。這個root相當於根節點。你所有的logger都適用與這個logger，所以，即使你在很多類裏面通過類名.class.getName() 得到很多的logger，而且沒有在配置文件的loggers下面做配置，他們也都能夠輸出，因爲他們都繼承了root的log配置。

　　我們上面的這個配置文件裏面還定義了一個logger，他的名稱是 cn.lsw.base.log4j2.Hello ，這個名稱其實就是通過前面的Hello.class.getName(); 得到的，我們爲了給他單獨做配置，這裏就生成對於這個類的logger，上面的配置基本的意思是隻有cn.lsw.base.log4j2.Hello 這個logger輸出trace信息，也就是他的日誌級別是trace，其他的logger則繼承root的日誌配置，日誌級別是error，只能打印出ERROR及以上級別的日誌。如果這裏logger 的name屬性改成cn.lsw.base，則這個包下面的所有logger都會繼承這個log配置（這裏的包是log4j的logger name的“包”的含義，不是java的包，你非要給Hello生成一個名稱爲“myhello”的logger，他也就沒法繼承cn.lsw.base這個配置了。

　　那有人就要問了，他不是也應該繼承了root的配置了麼，那麼會不會輸出兩遍呢？我們在配置文件中給瞭解釋，如果你設置了additivity="false"，就不會輸出兩遍，否則，看下面的輸出：

　　這裏要在加入一個類做對比：　

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

public class Test {


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

    public static void main(String[] args) {

        logger.trace("開始程序.");
        Hello hello= new Hello();
//        for (int i = 0; i < 10000;i++){
            if (!hello.hello()) {
                logger.error("hello");
            }
//        }
        logger.trace("退出程序.");
    }
}

　　這裏先把配置文件改一下方便對照，一個是剛纔第一個logger的名稱還是cn.lsw.base.log4j2.Hello，additivity去掉或改爲true（因爲默認是true，所以可以去掉），第二是把root的level改爲info方便觀察。　

　　然後運行Test，看控制檯的日誌輸出：

2013-12-20 19:59:42.538 [main] INFO  cn.lsw.base.log4j2.Test - test
2013-12-20 19:59:42.541 [main] TRACE cn.lsw.base.log4j2.Hello - entry
2013-12-20 19:59:42.541 [main] TRACE cn.lsw.base.log4j2.Hello - entry
2013-12-20 19:59:42.542 [main] ERROR cn.lsw.base.log4j2.Hello - Did it again!
2013-12-20 19:59:42.542 [main] ERROR cn.lsw.base.log4j2.Hello - Did it again!
2013-12-20 19:59:42.542 [main] INFO  cn.lsw.base.log4j2.Hello - 我是info信息
2013-12-20 19:59:42.542 [main] INFO  cn.lsw.base.log4j2.Hello - 我是info信息
2013-12-20 19:59:42.542 [main] DEBUG cn.lsw.base.log4j2.Hello - 我是debug信息
2013-12-20 19:59:42.542 [main] DEBUG cn.lsw.base.log4j2.Hello - 我是debug信息
2013-12-20 19:59:42.542 [main] WARN  cn.lsw.base.log4j2.Hello - 我是warn信息
2013-12-20 19:59:42.542 [main] WARN  cn.lsw.base.log4j2.Hello - 我是warn信息
2013-12-20 19:59:42.542 [main] FATAL cn.lsw.base.log4j2.Hello - 我是fatal信息
2013-12-20 19:59:42.542 [main] FATAL cn.lsw.base.log4j2.Hello - 我是fatal信息
2013-12-20 19:59:42.542 [main] DEBUG cn.lsw.base.log4j2.Hello - 我是debug信息
2013-12-20 19:59:42.542 [main] DEBUG cn.lsw.base.log4j2.Hello - 我是debug信息
2013-12-20 19:59:42.543 [main] TRACE cn.lsw.base.log4j2.Hello - exit
2013-12-20 19:59:42.543 [main] TRACE cn.lsw.base.log4j2.Hello - exit
2013-12-20 19:59:42.543 [main] ERROR cn.lsw.base.log4j2.Test - hello

　　可以看出，Test的trace日誌沒有輸出，因爲他繼承了root的日誌配置，只輸出info即以上級別的日誌。Hello 輸出了trace及以上級別的日誌，但是每個都輸出了兩遍。你可以試一下，把第一個logger的level該爲error，那麼error以上的級別也是輸出兩遍。這時候，只要加上additivity爲false就可以避免這個問題了。

　　當然，你可以爲每個logger 都在配置文件下面做不同的配置，也可以通過繼承機制，對不同包下面的日誌做不同的配置。因爲loggers下面可以寫很多歌logger。

　　下面在看一個稍微複雜的例子：

<?xml version="1.0" encoding="UTF-8"?>

<configuration status="error">
    <!--先定義所有的appender-->
    <appenders>
        <!--這個輸出控制檯的配置-->
        <Console name="Console" target="SYSTEM_OUT">
            <!--控制檯只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/>
            <!--這個都知道是輸出日誌的格式-->
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </Console>
        <!--文件會打印出所有信息，這個log每次運行程序會自動清空，由append屬性決定，這個也挺有用的，適合臨時測試用-->
        <File name="log" fileName="log/test.log" append="false">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

        <!--這個會打印出所有的信息，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作爲存檔-->
        <RollingFile name="RollingFile" fileName="logs/app.log"
                     filePattern="log/$${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="50MB"/>
        </RollingFile>
    </appenders>
    <!--然後定義logger，只有定義了logger並引入的appender，appender纔會生效-->
    <loggers>
        <!--建立一個默認的root的logger-->
        <root level="trace">
            <appender-ref ref="RollingFile"/>
            <appender-ref ref="Console"/>
        </root>

    </loggers>
</configuration>

　　說複雜，其實也不復雜，這一個例子主要是爲了講一下appenders。

　　這裏定義了三個appender，Console，File，RollingFile，看意思基本也明白，第二個是寫入文件，第三個是“循環”的日誌文件，意思是日誌文件大於閥值的時候，就開始寫一個新的日誌文件。

　　這裏我們的配置文件裏面的註釋算比較詳細的了。所以就大家自己看了。有一個比較有意思的是ThresholdFilter ，一個過濾器，其實每個appender可以定義很多個filter，這個功能很有用。如果你要選擇控制檯只能輸出ERROR以上的類別，你就用ThresholdFilter，把level設置成ERROR，onMatch="ACCEPT" onMismatch="DENY" 的意思是匹配就接受，否則直接拒絕，當然有其他選擇了，比如交給其他的過濾器去處理了之類的，詳情大家自己去琢磨吧。

　　爲什麼要加一個這樣的配置文件呢？其實這個配置文件我感覺挺好的，他的實用性就在下面：

　　8. 一個實用的配置文件：

　　我們用日誌一方面是爲了記錄程序運行的信息，在出錯的時候排查之類的，有時候調試的時候也喜歡用日誌。所以，日誌如果記錄的很亂的話，看起來也不方便。所以我可能有下面一些需求：

　　1）我正在調試某個類，所以，我不想讓其他的類或者包的日誌輸出，否則會很多內容，所以，你可以修改上面root的級別爲最高（或者謹慎起見就用ERROR），然後，加一個針對該類的logger配置，比如第一個配置文件中的設置，把他的level設置trace或者debug之類的，然後我們給一個appender-ref是定義的File那個appender（共三個appender，還記得嗎），這個appender的好處是有一個append爲false的屬性，這樣，每次運行都會清空上次的日誌，這樣就不會因爲一直在調試而增加這個文件的內容，查起來也方便，這個和輸出到控制檯就一個效果了。

　　2）我已經基本上部署好程序了，然後我要長時間運行了。我需要記錄下面幾種日誌，第一，控制檯輸出所有的error級別以上的信息。第二，我要有一個文件輸出是所有的debug或者info以上的信息，類似做程序記錄什麼的。第三，我要單獨爲ERROR以上的信息輸出到單獨的文件，如果出了錯，只查這個配置文件就好了，不會去處理太多的日誌，看起來頭都大了。怎麼做呢，很簡單。

　　>首先，在appenders下面加一個Console類型的appender，通過加一個ThresholdFilter設置level爲error。（直接在配置文件的Console這個appender中修改）

　　>其次，增加一個File類型的appender（也可以是RollingFile或者其他文件輸出類型），然後通過設置ThresholdFilter的level爲error，設置成File好在，你的error日誌應該不會那麼多，不需要有多個error級別日誌文件的存在，否則你的程序基本上可以重寫了。

　　這裏可以添加一個appender，內容如下：

  <File name="ERROR" fileName="logs/error.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

　　並在loggers中的某個logger(如root）中引用（root節點加入這一行作爲子節點）。　

 <appender-ref ref="ERROR" />

　　>然後，增加一個RollingFile的appender，設置基本上同上面的那個配置文件。

　　>最後，在logger中進行相應的配置。不過如果你的logger中也有日誌級別的配置，如果級別都在error以上，你的appender裏面也就不會輸出error一下的信息了。

　　還記得上面的Test類裏面有一個被註釋掉的for循環麼？這個是爲了做配置文件中RollingFile那個appender的配置的，取消註釋，運行商一次或幾次，看你的輸出配置文件的地方，他是怎麼“RollingFile”的，這裏給個我測試的截圖：（這裏你可以把 <SizeBasedTriggeringPolicy size="50MB"/>這裏的size改成2MB，要生成50MB的日誌還是比較慢的。爲了方便觀察麼！然後把Console的ThresholdFilter的level設置成error這樣的較高級別，不然控制檯輸出東西太多了）

　　第一部分（圖中標識爲1），是我加入的jar包；

　　第二部分是File這個appender生成的日誌文件，你會發現你運行很多次，這個文件中的日誌是被覆蓋的。

　　第三部分是RollingFile 這個appender生成的配置文件，可以發現，默認建立的是app.log這個日誌，每次超過2MB的時候，就會生成對應年-月的文件夾，和制定命名格式的log文件，而且是壓縮成gz格式文件，打開資源管理器發現這個文件只有11KB，解壓後就是2MB。

　　最後，希望這個教程能夠幫到大家！

Log4j 2.X 使用總結

如何使用 JS 判斷用戶是否處於活躍狀態

lightdb秒級增加列和刪除列（not null帶默認值）

lightdb數據庫超時相關控制參數

通過HPA+CronHPA組合應對業務複雜彈性伸縮場景

❤️‍🔥 Solon Cloud Event 新的事務特性與應用

lightdb mysql 8.0兼容之不可見主鍵

使用 JS 實現在瀏覽器控制檯打印圖片 console.image()

基於Ubuntu-22.04安裝K8s-v1.28.2實驗（四）使用域名訪問網站應用

Log4j1.x和2.x使用詳解總結

spring對log4j的錦上添花

（4）設計模式之原型模式

Log4net不同版本在app.config和web.config的配置區別

（3）設置模式之建造者模式

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結