springboot集成log4j2,Spring集成log4j2解決方案整理總結


Log4J

參考網站: https://www.cnblogs.com/keeya/p/10101547.html

常用日志框架

  • java.util.logging:是JDK在1.4版本中引入的Java原生日志框架
  • Log4j:Apache的一個開源項目,可以控制日志信息輸送的目的地是控制台、文件、GUI組件等,可以控制每一條日志的輸出格式,這些可以通過一個配置文件來靈活地進行配置,而不需要修改應用的代碼。雖然已經停止維護了,但目前絕大部分企業都是用的log4j。
  • LogBack:是Log4j的一個改良版本
  • Log4j2:Log4j2已經不僅僅是Log4j的一個升級版本了,它從頭到尾都被重寫了

為什么選用Log4j2

	相比與其他的日志系統,log4j2丟數據這種情況少;disruptor技術,在多線程環境下,性能高於logback等10倍以上;利用jdk1.5並發的特性,減少了死鎖的發生;

springboot集成log4j2(已實踐:該操作沒問題,很便捷)

1.引入jar包
springboot默認是用logback的日志框架的,所以需要排除logback,不然會出現jar依賴沖突的報錯。

<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-web</artifactId>  
    <exclusions><!-- 去掉springboot默認配置 -->  
        <exclusion>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-logging</artifactId>  
        </exclusion>  
    </exclusions>  
</dependency> 

<!-- 引入log4j2依賴 -->  
<dependency> 
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-log4j2</artifactId>  
</dependency> 

2.配置文件
如果自定義了文件名,需要在application.yml中配置
logging:
  config: xxxx.xml
  level:
    cn.jay.repository: trace
默認名log4j2-spring.xml,就省下了在application.yml中配置

3.配置文件模板
      log4j是通過一個.properties的文件作為主配置文件的,而現在的log4j2則已經棄用了這種方式,采用的是.xml,.json或者.jsn這種方式來做,可能這也是技術發展的一個必然性,因為properties文件的可閱讀性真的是有點差。這里給出博主自配的一個模版,供大家參考。

      具體詳情參考項目中配置文件

//簡單使用
//1.
public class LogExampleOther {
  private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExampleOther.class);
  
  public static void main(String... args) {
   	 log.error("Something else is wrong here");
  }
}
      
//2.
lombok就是一個注解工具jar包,能幫助我們省略一繁雜的代碼。具體介紹可以看我的這篇教程。

使用lombok后下面的代碼等效於上述的代碼,這樣會更方便的使用日志。
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.10</version>
</dependency>
  
@Slf4j
public class LogExampleOther {
  
  public static void main(String... args) {
    log.error("Something else is wrong here");
  }
}

      

Spring集成log4j2(已驗證、可用)

https://www.cnblogs.com/fukua123/p/10692247.html

#1、配置pom.xml,引用log4j2相關包
			<!--log4j2支持-->
      <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>2.11.2</version>
      </dependency>
      <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.11.2</version>
      </dependency>

#2、配置簡單的log4j2.xml配置文件
#在項目的classpath目錄下新建log4j2.xml

####重點:
log4j中配置日志文件相對路徑方法分析: https://blog.csdn.net/wangjc_opal/article/details/83330005
<!--  輸出路徑  :此處需要重點注意:相對路徑、絕對路徑、以及系統變量的應用-->
<Property name="logpath">./Log4j/logs/dev</Property>

#3、在web.xml文件里引用log4j2.xml
    <context-param>
        <param-name>log4jConfiguration</param-name>
        <param-value>classpath:log4j2.xml</param-value>
    </context-param>

參考log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO" monitorInterval="30">
    <!--  配置詳解: https://www.cnblogs.com/lzb1096101803/p/5796849.html  -->
    <!--日志級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

    <!--變量配置-->
    <Properties>
        <!-- 格式化輸出:%date表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度 %msg:日志消息,%n是換行符-->
        <!-- %logger{36} 表示 Logger 名字最長36個字符 -->
        <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
        <!-- 定義日志存儲的路徑 -->
        <property name="FILE_PATH" value="更換為你的日志路徑" />
        <property name="FILE_NAME" value="更換為你的項目名" />
        <!--  以上配置暫不使用,僅供了解  -->

        <!--  輸出路徑  -->
        <Property name="logpath">./Log4j/logs/dev</Property>
    </Properties>


    <!--先定義所有的appender-->
    <Appenders>
        <!--這個輸出控制台的配置-->
        <Console name="Console" target="SYSTEM_OUT">
            <!--輸出日志的格式-->
            <PatternLayout pattern="[%d][%-5p][%t] %m (%F:%L)%n"/>

            <!--控制台只輸出level及其以上級別的信息(onMatch),其他的直接拒絕(onMismatch)-->
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
        </Console>

        <!--文件會打印出所有信息,這個log每次運行程序會自動清空,由append屬性決定,這個也挺有用的,適合臨時測試用-->
        <File name="Filelog" fileName="${logpath}/log/test.log" append="false">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>

        <!-- 這個會打印出所有的info及以下級別的信息,每次大小超過size,則這size大小的日志會自動存入按年份-月份建立的文件夾下面並進行壓縮,作為存檔-->
        <RollingFile name="debug" fileName="${logpath}/debug/erp_debug.log"
                     filePattern="${logpath}/debug/erp_debug_%d{yyyy-MM-dd}-%i.log">

            <!--Filters決定日志事件能否被輸出。過濾條件有三個值:ACCEPT(接受), DENY(拒絕) or NEUTRAL(中立).
                ACCEP和DENY比較好理解就是接受和拒絕的意思,在使用單個過濾器的時候,一般就是使用這兩個值。
                但是在組合過濾器中,如果用接受ACCEPT的話,日志信息就會直接寫入日志文件,后續的過濾器不再進行過濾。
                所以,在組合過濾器中,接受使用NEUTRAL(中立),被第一個過濾器接受的日志信息,會繼續用后面的過濾器進行過濾,
                只有符合所有過濾器條件的日志信息,才會被最終寫入日志文件。 -->
            <Filters>
                <!--ThresholdFilter
                    有幾個參數:
                    level:將被過濾的級別。
                    onMatch:默認值是NEUTRAL
                    onMismatch:默認是DENY
                    如果LogEvent 中的 Log Level 大於 ThresholdFilter 中配置的 Log Level,那么返回 onMatch 的值, 否則返回 onMismatch 的值,
                    例如 : 如果ThresholdFilter 配置的 Log Level 是 ERROR , LogEvent 的Log Level 是 DEBUG。 那么 onMismatch 的值將被返回,
                    因為 ERROR 小於DEBUG。如果是Accept,將自己被接受,而不經過下一個過濾器 -->

                <!--如果level大於info級別及其以上返回DENY(拒絕),否則返回NEUTRAL(中立),如果后面沒有其他過濾器,則被接受;否則繼續下一個校驗,
                  如果level大於debug級別及其以上返回ACCEPT(接受),否則返回DENY(拒絕)-->
                <!-- 綜上:該配置只接受debug類型的日志-->
                <ThresholdFilter level="info" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <PatternLayout pattern="[%d][%-5p][%t] %m (%F:%L)%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="24" modulate="true"/>
                <SizeBasedTriggeringPolicy size="50 MB"/>\
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置,則默認為最多同一文件夾下7個文件,這里設置了30 -->
            <DefaultRolloverStrategy max="30">
                <Delete basePath="${logpath}/debug" maxDepth="1">
                    <IfFileName glob="erp_debug_*.log"/>
                    <IfLastModified age="15d"/>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>



        <RollingFile name="info" fileName="${logpath}/info/erp_info.log"
                     filePattern="${logpath}/info/erp_info_%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <!-- 該配置只接受info類型的日志-->
                <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <PatternLayout pattern="[%d][%-5p][%t] %m (%F:%L)%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="24" modulate="true"/>
                <SizeBasedTriggeringPolicy size="50 MB"/>\
            </Policies>
            <DefaultRolloverStrategy max="30">
                <Delete basePath="${logpath}/info" maxDepth="1">
                    <IfFileName glob="erp_info_*.log"/>
                    <IfLastModified age="15d"/>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
        <RollingFile name="warn" fileName="${logpath}/warn/erp_warn.log"
                     filePattern="${logpath}/warn/erp_warn_%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <!-- 該配置只接受warn類型的日志-->
                <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <PatternLayout pattern="[%d][%-5p][%t] %m (%F:%L)%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="24" modulate="true"/>
                <SizeBasedTriggeringPolicy size="50 MB"/>\
            </Policies>
            <DefaultRolloverStrategy max="30">
                <Delete basePath="${logpath}/warn" maxDepth="1">
                    <IfFileName glob="erp_warn_*.log"/>
                    <IfLastModified age="15d"/>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
        <RollingFile name="error" fileName="${logpath}/error/erp_error.log"
                     filePattern="${logpath}/error/erp_error_%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <!-- 該配置只接受error類型的日志-->
                <ThresholdFilter level="fatal" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <PatternLayout pattern="[%d][%-5p][%t] %m (%F:%L)%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="24" modulate="true"/>
                <!--   每個文件最大50M -->
                <SizeBasedTriggeringPolicy size="50 MB"/>\
            </Policies>
            <DefaultRolloverStrategy max="30">
                <Delete basePath="${logpath}/error" maxDepth="1">
                    <IfFileName glob="erp_error_*.log"/>
                    <!-- 設置最大保存時間為15天-->
                    <IfLastModified age="15d"/>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>

    </Appenders>





    <!--切換輸出級別-->
    <!--然后定義logger,只有定義了logger並引入的appender,appender才會生效-->
    <Loggers>
        <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
        <logger name="org.springframework" level="INFO"></logger>
        <logger name="org.mybatis" level="INFO"></logger>

        <!-- 級別順序(低到高):TRACE < DEBUG < INFO < WARN < ERROR < FATAL -->
        <!-- 需要哪個級別的日志就放開哪一個注釋,不需要的就注釋掉-->

        <!-- <Root level="info"> level="all",執行以下是有的配置;level="info"執行info及以上的配置,哪怕debug配置了也不執行日志 -->
        <Root level="all">

            <AppenderRef ref="Console"/>


            <AppenderRef ref="debug"/>
            <AppenderRef ref="info"/>

            <!--
            <AppenderRef ref="warn"/>
            <AppenderRef ref="error"/>
            -->
            <!--測試時使用,打印所有的日志信息-->
            <AppenderRef ref="Filelog"/>

        </Root>
    </Loggers>
</Configuration>

在這里簡單介紹下常用的配置參數**

1.日志級別
機制:如果一條日志信息的級別大於等於配置文件的級別,就記錄。

trace:追蹤,就是程序推進一下,可以寫個trace輸出
debug:調試,一般作為最低級別,trace基本不用。
info:輸出重要的信息,使用較多
warn:警告,有些信息不是錯誤信息,但也要給程序員一些提示。
error:錯誤信息。用的也很多。
fatal:致命錯誤。
2.輸出源
CONSOLE(輸出到控制台)
FILE(輸出到文件)
3.格式
SimpleLayout:以簡單的形式顯示
HTMLLayout:以HTML表格顯示
PatternLayout:自定義形式顯示
PatternLayout自定義日志布局:

%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生產時間,輸出到毫秒的時間
%-5level : 輸出日志級別,-5表示左對齊並且固定輸出5個字符,如果不足在右邊補0
%c : logger的名稱(%logger)
%t : 輸出當前線程名稱
%p : 日志輸出格式
%m : 日志內容,即 logger.info("message")
%n : 換行符
%C : Java類名(%F)
%L : 行號
%M : 方法名
%l : 輸出語句所在的行數, 包括類名、方法名、文件名、行數
hostName : 本地機器名
hostAddress : 本地ip地址

為什么阿里巴巴禁止工程師直接使用日志系統(Log4j、Logback)中的 API

對於Java工程師來說,關於日志工具的使用,最佳實踐就是在應用中使用如Log4j + SLF4J 這樣的組合來進行日志輸出。

這樣做的最大好處,就是業務層的開發不需要關心底層日志框架的實現及細節,在編碼的時候也不需要考慮日后更換框架所帶來的成本。這也是門面模式所帶來的好處。

綜上,請不要在你的Java代碼中出現任何Log4j等日志框架的API的使用,而是應該直接使用SLF4J這種日志門面。

logback log4j log4j2 性能實測

https://blog.csdn.net/yjh1271845364/article/details/70888262

可見在同步日志模式下, Logback的性能是最糟糕的.
而log4j2的性能無論在同步日志模式還是異步日志模式下都是最佳的.
其根本原因在於log4j2使用了LMAX, 一個無鎖的線程間通信庫代替了, logback和log4j之前的隊列. 並發性能大大提升, 下期文章將研究一下LMAX, 到底是什么

關於log4j2的新特性
丟數據這種情況少,可以用來做審計功能。而且自身內部報的exception會被發現,但是logback和log4j不會。
log4j2使用了disruptor技術,在多線程環境下,性能高於logback等10倍以上。
(garbage free)之前的版本會產生非常多的臨時對象,會造成GC頻繁,log4j2則在這方面上做了優化,減少產生臨時對象。盡可能少的GC
利用插件系統,使得擴展新的appender,filter,layout等變得容易,log4j不可以擴展 插件????
因為插件系統的簡單性,所以在配置的時候,可以不用具體指定所要處理的類型。class
可以自定義level
Java 8 lambda support for lazy logging
Support for Message objects
對filter的功能支持的更強大
系統日志(Syslog)協議supports both TCP and UDP
利用jdk1.5並發的特性,減少了死鎖的發生。
Socket LogEvent SerializedLayout
支持kafka queue

參考文章

最詳細的Log4j使用教程

Spring 中配置log4j日志功能

SSM框架+Log4j框架搭建

spring mvclog4j****的配置與使用

log4j.properties和log4j.xml有什么區別

  • 區別不大,只是在項目中配置的文件形式不一樣。功能上沒區別。 推薦用xml 方式。
  • 有web 項目中log4.properties不能使用Filter攔截日志級別,而log4j.xml可以,這點感覺log4j.xml要強大些 l
  • og4j.xml插入數據庫的時候sql寫在layout屬性的ConversionPattern參數中,而log4.properties則有單獨的sql屬性接受配置文件中的sql語句
  • properties是簡單的鍵-值對應。

如果properties不能滿足你的要求了,你自然就需要用xml了。

xml可以保存多屬性的復雜對象結構。

web項目Log4j日志輸出路徑配置問題

問題描述:一個web項目想在一個tomcat下運行多個實例(通過修改war包名稱的實現),然后每個實例都將日志輸出到tomcat的logs目錄下實例名命名的文件夾下進行區分查看每個實例日志,要求通過盡可能少的改動配置文件,最好修改實例名后可以不修改log4j的配置文件。

實現分析:一般實現上面需求,需要在修改完war包名稱之外要再做下面配置:

1、修改每個實例名下web.xml中參數webAppRootKey為不同值。同一個tomcat下運行多個web應用時,該值相同的話,運行時會拋異常。

webAppRootKey

webApp.root

2、log4j配置文件日志輸出路徑修改

log4j配置文件中路徑配置一般有三種方法:

(1)絕對路徑法:直接配置為系統覺得路徑;

(2)相對路徑法:(路徑是相對於Tomcat/bin路徑)

​ log4j.appender.logfile.File=../logs/app.log,將日志記錄到tomcat下的logs文件夾;

​ log4j.appender.logfile.File=logs/app.log,將日志記錄到tomcat的bin目錄下的logs文件夾;

(3)使用環境變量相對路徑法:程序會優先找jvm環境變量,然后再找系統環境變量,來查找配置文件中的變量。

​ log4j.appender.logfile.File=${user.dir}/logs/app.log,使用tomcat容器時${user.dir}對應tomcat的bin目錄;

​ log4j.appender.logfile.File=${user.home}/logs/app.log,${user.home}對應操作系統當前用戶目錄;

​ log4j.appender.logfile.File=${webApp.root}/logs/app.log,${webApp.root}對應當前應用根目錄;

暫時沒找到不修改log4j配置而實現上面需求的方法。在log4j配置文件中可以獲取環境變量來配置,但變量里沒有當前應用的名稱(不能直接通過webApp.root,因為它在不同的實例名稱不一樣),嘗試在web.xml中增加listener,獲取應用名稱,然后調用System.setProperty("contextPath", sce.getServletContext().getContextPath());將上下文設置到系統變量中在log4j應用,但多實例運行時每個實例都會改變該屬性值。

結論,該問題的解決方法

1、手動修改配置,修改war名稱后手動修改web.xml和log4j配置文件,實現上述需求。

2、通過其它程序來進行批量修改,若bat或maven等在修改war包名稱時,自動修改掉web.xml和log4j中相關配置。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM