本篇的重點在於LOG4J2,它與LOG4J 第一版區別很大。我將教程放在後面,將一些知識放在前面,所以想看教程的直接拉到後面即可。
理論知識
關於兩版的區別
兩版的不同,直接的表現是在Maven倉庫中log4j 表示第一版,org.apache.logging.log4j 表示第二版。另外應當注意:
- Log4J2.4及更高版本需要Java 7,版本2.0-alpha1至2.3需要Java 6
- XML配置已被簡化,與Log4j 1.x不兼容
- 版本2.4開始支持通過屬性文件進行配置,但與Log4j 1.x不兼容
- 支持通過JSON或YAML進行配置,但這些格式需要額外的運行時依賴關係
- 雖然Log4j 2與Log4j不直接兼容1.x,但提供了橋接依賴可以減少代碼的修改
尋找配置文件的原理
log4j2允許使用log4jConfiguration 上下文參數在web.xml中指定配置文件。Log4j2將通過以下方式搜索配置文件
- 如果提供了一個位置,它將搜索servlet上下文資源,即配置log4jConfiguration
如果沒有定義位置,則按照如下所有定位顯式配置:
- 檢測 log4j.configurationFile 系統屬性,如果屬性存在,就從它指定的文件中加載配置
- 在類路徑上尋找名爲 log4j2-test.json 或者 log4j2-test.jsn 的文件,如果文件存在,就從該文件加載配置
- 在類路徑上尋找名爲 log4j2-test.xml 的文件,如果文件存在,就從該文件加載配置
- 在類路徑上尋找名爲 log4j2.json 或者 log4j2.jsn 的文件,如果文件存在,就從該文件加載配置
- 在類路徑上尋找名爲 log4j2.xml 的文件,如果文件存在,就從該文件加載配置
使用類路徑和文件URL的正常搜索序列用於定位配置文件
Tomcat版本的差異
出於性能原因,容器經常忽略已知不包含TLD或ServletContainerInitializer的某些JAR,並且不掃描它們的Web片段和初始化器。重要的是,Tomcat 7 <7.0.43將忽略名爲log4j * .jar的所有JAR文件,從而阻止此功能的工作。這在Tomcat 7.0.43,Tomcat 8和更高版本中已經修復。在Tomcat 7 <7.0.43中,您將需要更改catalina.properties,並從jarsToSkip 屬性中刪除”log4j * .jar”。如果他們跳過掃描Log4j JAR文件,您可能需要在其他容器上執行類似的操作。
關於log4j-web的重要性
Log4j2-web.jar文件是配置爲在應用程序中的任何其他Web片段之前的Web片段。它包含容器自動發現和初始化的ServletContainerInitializer(Log4jServletContainerInitializer)。這將Log4jServletContextListener和 Log4jServletFilter添加到ServletContext中。這些類正確初始化並初始化Log4j配置。
對於某些用戶,自動啓動Log4j是有問題的或不合需要的。您可以使用isLog4jAutoInitializationDisabled上下文參數輕鬆禁用此功能。只需將其添加到您的部署描述符,值爲“true”即可禁用自動初始化。您必須在web.xml中定義context參數。如果以編程方式設置,Log4j將檢測到設置爲時已晚。
<context-param>
<param-name> isLog4jAutoInitializationDisabled </ param-name>
<param-value> true </ param-value>
</context-param>
禁用自動初始化後,您必須像Servlet 2.5 Web應用程序一樣初始化Log4j 。您必須這樣做,以便在執行任何其他應用程序代碼(如Spring Framework啓動代碼)之前進行此初始化。
您可以自定義偵聽器的行爲並使用log4jContextName, log4jConfiguration和/或isLog4jContextSelectorNamed上下文參數進行過濾。在下面的“ 上下文參數”部分中閱讀更多信息。您不得在部署描述符(web.xml)中或在Servlet 3.0或更高版本應用程序中的其他初始化程序或偵聽器中 手動配置Log4jServletContextListener或Log4jServletFilter,除非禁用了使用 isLog4jAutoInitializationDisabled 自動初始化。這樣做會導致啓動錯誤和未指定的錯誤行爲。
教程開始
編寫pom.xml
<properties>
<slf4j.version>1.7.25</slf4j.version>
<log4j.version>2.8.2</log4j.version>
</properties>
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>${slf4j.version}</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>${log4j.version}</version>
</dependency>
<!--用於與sfl4j保持橋接-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-web</artifactId>
<version>${log4j.version}</version>
<scope>runtime</scope>
</dependency>
</dependencies>
注意log4j-web是很重要的,在Java EE Web應用程序中使用Log4j或任何其他日誌記錄框架時,必須特別小心。由於Web應用程序中的類加載器的性質,Log4j資源無法通過正常方式進行清理。爲了避免這些問題,務必包含log4j-web
設置web.xml
Servlet 3.0或更高版本是無需配置web.xml的,它默認指定配置文件應命名爲log4j2.xml,並要求放置在classpath中,所以在maven項目裏,只要在resources目錄下新建log4j2.xml文件即可,否則要設置
<context-param>
<param-name>log4jConfiguration</param-name>
<param-value>classpath:config/log4j2.xml</param-value>
</context-param>
如果項目還是基於Servlet 2.x的,官方聲明上Log4j2是不支持Servlet 3.0以下版本的,網上有教程稱設置監聽器和過濾器,這裏給出其參考配置
<listener>
<listener-class>org.apache.logging.log4j.web.Log4jServletFilter
</listener>
<filter>
<filter-name>log4jServletFilter</filter-name>
<filter-class>org.apache.logging.log4j.web.Log4jServletFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>log4jServletFilter</filter-name>
<url-pattern>/*<url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
<dispatcher>INCLUDE</dispatcher>
<dispatcher>ERROR</dispatcher>
</filter-mapping>
設置配置文件
Log4j2支持properties,xml,json以及yaml。這裏給出xml的參考配置
注意命名爲log4j2.xml
<?xml version="1.0" encoding="utf-8" ?>
<Configuration status="off" monitorInterval="1800">
<properties>
<property name="LOG_HOME">F:\logs</property>
<property name="ERROR_LOG_FILE_NAME">error</property>
</properties>
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d %-5p (%F:%L) - %m%n" />
</Console>
<RollingRandomAccessFile name="ErrorLog"
fileName="${LOG_HOME}/${ERROR_LOG_FILE_NAME}.log"
filePattern="${LOG_HOME}/${ERROR_LOG_FILE_NAME}.log.%d{yyyy-MM-dd}.gz">
<PatternLayout pattern="%d %-5p (%F:%L) - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>
<SizeBasedTriggeringPolicy size="100MB"/>
</Policies>
<DefaultRolloverStrategy max="20"/>
</RollingRandomAccessFile>
</Appenders>
<Loggers>
<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.newcih" level="error" includeLocation="true" additivity="false">
<appender-ref ref="ErrorLog"/>
<appender-ref ref="Console"/>
</logger>
<root level="info" includeLocation="true">
<appender-ref ref="Console"/>
</root>
</Loggers>
</Configuration>
測試
一般的log4j代碼正常使用即可,由於使用到slf4j,這裏推薦了lombok,一款簡化代碼的插件,其實是一個jar包,eclipse和idea有各自的插件可以使用。給出代碼如下
import lombok.extern.slf4j.Slf4j;
import org.newcih.teacher.service.TeacherService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Slf4j
@Controller
@RequestMapping("/teacher")
public class TeacherManager {
@Autowired
private TeacherService teacherService;
@ResponseBody
@RequestMapping(value = "/test")
public String test(){
log.info("hello world");
log.error("Hello World");
return "Success";
}
}
在上述代碼中,控制檯和日誌文件只會打印Hello World,這裏因爲在配置文件log4j2.xml中配置到這個包路徑下的日誌level是error,也就是隻記錄error級別的日誌
教程結束,給出參考的CSDN博客
使用Slf4j集成Log4j2構建項目日誌系統的完美解決方案