介紹
目前常用的 Java 日志框架有 Log4j舰蟆、Logback纱注、Log4j2 ,性能方面推薦使用異步的 Log4j2税稼,具體對(duì)比不多做分析烦秩,前人早已完成耕荒,我們就站在巨人的肩膀上來(lái)看看如何實(shí)操郎仆。
SLF4J只祠,簡(jiǎn)單日志門面(Simple Logging Facade for Java),是一個(gè)用于日志系統(tǒng)的簡(jiǎn)單 Facade丸升,不是具體的日志解決方案铆农,而是通過Facade Pattern提供一些Java logging API,我的理解是它和 Log4j狡耻、Logback、Log4j2 的關(guān)系類似于 Java 接口與實(shí)現(xiàn)類的關(guān)系猴凹。
1夷狰、pom 準(zhǔn)備
1.1、war 包 web 工程
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<!--排除 springboot 默認(rèn)的 logback 依賴 -->
<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>
<version>2.2.6.RELEASE</version>
</dependency>
<!--異步,使用 log4j2 的 AsyncLogger 時(shí)需要包含 disruptor-->
<dependency>
<groupId>com.lmax</groupId>
<artifactId>disruptor</artifactId>
<version>3.4.2</version>
</dependency>
1.2郊霎、jar 包自啟動(dòng)工程
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<exclusions>
<!--排除 springboot 默認(rèn)的 logback 依賴 -->
<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>
<version>2.2.6.RELEASE</version>
</dependency>
<!--異步,使用 log4j2 的 AsyncLogger 時(shí)需要包含 disruptor-->
<dependency>
<groupId>com.lmax</groupId>
<artifactId>disruptor</artifactId>
<version>3.4.2</version>
</dependency>
2、application.yml 配置
# 引入日志配置文件
logging:
config: classpath:log4j2.xml
3、log4j2.xml 配置
classpath:log4j2.xml 的話孝治,log4j2.xml 放在目錄 resources 下即可
<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration 后面的 status葡盗,這個(gè)用于設(shè)置 log4j2 自身內(nèi)部的信息輸出級(jí)別,可以不設(shè)置购对,當(dāng)設(shè)置成 trace 時(shí)猾昆,你會(huì)看到 log4j2 內(nèi)部各種詳細(xì)輸出-->
<!--monitorInterval:Log4j2 能夠自動(dòng)檢測(cè)修改配置 文件和重新配置本身,設(shè)置間隔秒數(shù)-->
<configuration status="error" monitorInterval="30">
<!--日志級(jí)別以及優(yōu)先級(jí)排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--變量配置-->
<Properties>
<!-- 格式化輸出:%date 表示日期骡苞,%thread 表示線程名垂蜗,%-5level:級(jí)別從左顯示 5 個(gè)字符寬度 %msg:日志消息,%n 是換行符-->
<!-- %logger{36} 表示 Logger 名字最長(zhǎng) 36 個(gè)字符 -->
<property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level [%logger{50}:%L] - %msg%n" />
<!-- 定義日志存儲(chǔ)的路徑 -->
<property name="FILE_PATH" value="/var/log/songo" />
<property name="FILE_NAME" value="songo" />
</Properties>
<appenders>
<console name="Console" target="SYSTEM_OUT">
<!--輸出日志的格式-->
<PatternLayout pattern="${LOG_PATTERN}" charset="UTF-8"/>
</console>
<!-- 這個(gè)會(huì)打印出所有的info及以上級(jí)別的信息解幽,每次大小超過size贴见,則這size大小的日志會(huì)自動(dòng)存入按年份-月份建立的文件夾下面并進(jìn)行壓縮,作為存檔-->
<RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/${FILE_NAME}/${FILE_NAME}.log" filePattern="${FILE_PATH}/${FILE_NAME}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz" append="true">
<PatternLayout pattern="${LOG_PATTERN}" charset="UTF-8"/>
<Policies>
<!-- 基于時(shí)間的觸發(fā)策略躲株。該策略主要是完成周期性的log文件封存工作片部。有兩個(gè)參數(shù):
interval,integer型霜定,指定兩次封存動(dòng)作之間的時(shí)間間隔档悠。單位:以日志的命名精度來(lái)確定單位廊鸥,
比如yyyy-MM-dd-HH 單位為小時(shí),yyyy-MM-dd-HH-mm 單位為分鐘
modulate站粟,boolean型黍图,說明是否對(duì)封存時(shí)間進(jìn)行調(diào)制。若modulate=true奴烙,
則封存時(shí)間將以0點(diǎn)為邊界進(jìn)行偏移計(jì)算助被。比如,modulate=true切诀,interval=4hours揩环,
那么假設(shè)上次封存日志的時(shí)間為00:00,則下次封存日志的時(shí)間為04:00幅虑,
之后的封存時(shí)間依次為08:00丰滑,12:00,16:00-->
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="10MB"/>
</Policies>
<!-- DefaultRolloverStrategy 屬性如不設(shè)置倒庵,則默認(rèn)為最多同一文件夾下當(dāng)天 7 個(gè)文件后開始覆蓋-->
<DefaultRolloverStrategy max="30">
<!-- 刪除處理策略褒墨,在配置的路徑中搜索,maxDepth 表示往下搜索的最大深度 -->
<Delete basePath="${FILE_PATH}/${FILE_NAME}/" maxDepth="2">
<!-- 文件名搜索匹配擎宝,支持正則 -->
<IfFileName glob="*.log.gz" />
<!--!Note: 這里的 age 必須和 filePattern 協(xié)調(diào), 后者是精確到 dd, 這里就要寫成 xd, xD 就不起作用
另外, 數(shù)字最好 >2, 否則可能造成刪除的時(shí)候, 最近的文件還處于被占用狀態(tài),導(dǎo)致刪除不成功!-->
<!--7天-->
<IfLastModified age="7d" />
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
</appenders>
<!--Logger 節(jié)點(diǎn)用來(lái)單獨(dú)指定日志的形式郁妈,比如要為指定包下的 class 指定不同的日志級(jí)別等。-->
<!--然后定義 loggers绍申,只有定義了 logger 并引入的 appender噩咪,appender 才會(huì)生效-->
<loggers>
<!--若是 additivity 設(shè)為 false,則子 Logger 只會(huì)在自己的 appender 里輸出极阅,而不會(huì)在父 Logger 的 appender 里輸出胃碾。-->
<!--Console、RollingFileInfo 沒有配置 ThresholdFilter筋搏,默認(rèn)走的是 AsyncRoot 的 level 級(jí)別仆百,
com.songo.mapper 為我項(xiàng)目 mapper 的包路徑,級(jí)別設(shè)為 debug拆又,可以打印 sql 語(yǔ)句-->
<AsyncLogger name="com.songo.mapper" level="debug" additivity="false">
<appender-ref ref="Console"/>
<appender-ref ref="RollingFileInfo"/>
</AsyncLogger>
<AsyncLogger name="org.springframework" level="warn" additivity="false">
<appender-ref ref="Console"/>
<appender-ref ref="RollingFileInfo"/>
</AsyncLogger>
<AsyncRoot level="info" includeLocation="true">
<AppenderRef ref="Console"/>
<AppenderRef ref="RollingFileInfo" />
</AsyncRoot>
</loggers>
</configuration>
4儒旬、使用
4.1、聲明 logger 變量
package com.songo.service;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class TestService {
private static final Logger logger = LoggerFactory.getLogger(TestService.class);
public void Test() {
logger.info("test...");
}
}
4.2帖族、簡(jiǎn)單點(diǎn) lombok
引入 pom
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>
package com.songo.service;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class TestService {
public void Test() {
log.info("test...");
}
}
5栈源、驗(yàn)證
服務(wù)啟動(dòng)時(shí),找到 log4j2 的線程竖般,是如下內(nèi)容說明 log4j2 異步日志打印配置成功
記錄如有不對(duì)煩請(qǐng)指出甚垦,先行感謝