实在看不下去搜索引擎查出来的文章中各种错误的配置信息,于是翻译了下文。
翻译原文:How to use Log4j2 with Spring Boot
Apache Lo4j 2 是Log4j 1.x的接替者。
Log4j2和自己之前的版本相比在性能上有了很多的提升。它包含了异步日志,并支持SLF4j、commons logging、java.util.logging多个API。
在这篇文章中你将学会如何在Spring Boot项目中集成和配置Log4j 2。你将学会配置不同类型的appenders:RollingFileAppender和SMTPAppender。你还将回到如何使用Log4j 2提供的异步记录日志的功能。
我的想法是通过构建一个简单的Spring Boot应用来演示如何在应用中集成和配置Log4j2。
那么,我们开始吧!
创建工程
我们使用Spring Boot CLI工具来生成一个项目,如果你还没有安装Spring Boot CLI,我建议你快点去安装,你可以通过Spring Boot官方文档来获得一些帮助。
打开你的命令行工具,并通过以下命令来生成项目:
spring init --name=log4j2-demo --dependencies=web log4j2-demo
项目创建成功后,你可以将项目引入到你的IDE工具中。项目结构如下图:
添加Log4j2
在Spring Boot中所有的starter 都是基于spring-boot-starter-logging的,默认使用Logback。使用Log4j2的话,你需要排除 spring-boot-starter-logging 的依赖,并添加 spring-boot-starter-log4j2的依赖。
打开 pom.xml文件,在中添加如下依赖:
<!-- Exclude Spring Boot's Default Logging -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- Add Log4j2 Dependency -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
配置Log4j2
如果Spring Boot 在classpath中找到 log4j2.xml 或者 log4j2.json 或者 log4j2.yaml,那么它就会自动配置Log4j2.
在本文中,我们在 src/main/resources 目录中使用XML格式的文件来配置XML,并添加如下的配置:
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="30">
<Properties>
<Property name="LOG_PATTERN">
%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${hostName} --- [%15.15t] %-40.40c{1.} : %m%n%ex
</Property>
</Properties>
<Appenders>
<Console name="ConsoleAppender" target="SYSTEM_OUT" follow="true">
<PatternLayout pattern="${LOG_PATTERN}"/>
</Console>
</Appenders>
<Loggers>
<Logger name="com.example.log4j2demo" level="debug" additivity="false">
<AppenderRef ref="ConsoleAppender" />
</Logger>
<Root level="info">
<AppenderRef ref="ConsoleAppender" />
</Root>
</Loggers>
</Configuration>
上面的配置定义了一个简单的ConsoleAppender,并声明了两个logger:一个特定的logger和一个root logger。
在应用使用Log4j2
打开 Log4j2DemoApplication.java 我们替换为如下的代码:
package com.example.log4j2demo;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Log4j2DemoApplication implements ApplicationRunner {
private static final Logger logger = LogManager.getLogger(Log4j2DemoApplication.class);
public static void main(String[] args) {
SpringApplication.run(Log4j2DemoApplication.class, args);
}
@Override
public void run(ApplicationArguments applicationArguments) throws Exception {
logger.debug("Debugging log");
logger.info("Info log");
logger.warn("Hey, This is a warning!");
logger.error("Oops! We have an Error. OK");
logger.fatal("Damn! Fatal error. Please fix me.");
}
}
我们添加了5个不同级别的日志记录,当我们运行时,它会在控制台打印这些日志信息。
添加 Rolling File Appender
如果你想将日志写入到一个文件中,你可以使用RollingFile appender. RollingFile appener根据某些设置的阀值,在满足设定的规则时将会创建一个日志文件。
通过指定filePattern属性来指定就文件的存储形式。
<!-- Rolling File Appender -->
<RollingFile name="FileAppender" fileName="logs/log4j2-demo.log"
filePattern="logs/log4j2-demo-%d{yyyy-MM-dd}-%i.log">
<PatternLayout>
<Pattern>${LOG_PATTERN}</Pattern>
</PatternLayout>
<Policies>
<SizeBasedTriggeringPolicy size="10MB" />
</Policies>
<DefaultRolloverStrategy max="10"/>
</RollingFile>
在上面的 RollingFile 配置中,我指定了 SizeBasedTriggeringPolicy, 它将会在文件内容达到10MB的时候来归档旧日志, 元素将会指定文件最大的保存的数量
另外一个Log4j2中经常用到的规则TimeBasedTriggeringPolicy,通过它你可以指定日志归档的周期,它的时间单位时基于filePattern指定的规则来设定的。(比如:filePattern中指定的文件为天,那么该属性属性时间就是x天,如果filePattern指定的月,那么该属性值对应的就是x月)。具体下面还会讲到
下面是使用 TimeBasedTriggeringPolicy的配置:
<Policies>
<TimeBasedTriggeringPolicy interval="1" />
</Policies>
interval属性指定了归档的频率。如果你需要7天归档一次,那么你需要指定 interval=“7”。
在上面的例子中,日期时间模式设定的是 {yyyy-MM-dd}, 指定的时间单位就是 dd(天)。因此,TimeBasedTriggeringPolicy 归档文件将会基于这个单位,如果日期模式设定的是**{yyyy-MM-dd-HH}**,那么归档的时间单位就是小时。
最后,我们需要使用上面配置好的FollingFile,你需要将它添加到log4j2.xml中的中:
<Root level="info">
<AppenderRef ref="ConsoleAppender"/>
<AppenderRef ref="FileAppender"/>
</Root>
运行,并查看日志会打印在控制台和指定的日志的文件中。
添加SMTP Appender
在线上的产品环境中SMTP appender非常有用,比如:当系统出现错误时,通过SMTP 你可以第一时间收到异常日志邮件。
通过下面的配置你可以指定SMTP appender想你的邮箱发送Error邮件。
<!-- SMTP Appender -->
<SMTP name="MailAppender"
subject="邮件主题:一般为错误信息类型"
to="收件人邮箱地址"
from="发件人邮箱地址"
smtpHost="发件人邮箱的SMTP HOST"
smtpPort="发件人邮箱的SMTP PORT(可删除该项不填写)"
smtpUsername="发件人的邮箱地址(不需要@及之后的内容)"
smtpPassword="发件人的邮箱密码"
bufferSize="1">
<ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout>
<Pattern>${LOG_PATTERN}</Pattern>
</PatternLayout>
</SMTP>
注意,为了让SMTP appender运行起来,还需要在pom.xml中添加 spring-boot-starter-mail的依赖。
<!-- Needed for SMTP appender -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
异步Logging
Log4j2支持异步 logger,这些logger相对于同步日志性能上更好。
异步日志需要使用Disruptor工具库。我们需要在pom.xml中添加对它的依赖配置。
<!-- Needed for Async Logging with Log4j 2 -->
<dependency>
<groupId>com.lmax</groupId>
<artifactId>disruptor</artifactId>
<version>3.3.6</version>
</dependency>
现在你就可以使所有的logger成为异步的,或者只让一部分logger成为异步的,其他的保持同步的。
1, 让所有的日志成为异步的
操作非常简单,你只需要设置SystemProperty Log4jContextSelector为org.apache.logging.log4j.core.async.AsyncLoggerContextSelector.
mvn spring-boot:run -DLog4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector
你也可以使用jar包
mvn clean package
java -jar target/log4j2-demo-0.0.1-SNAPSHOT.jar -DLog4jContextSelector=org.apache.log4j.core.async.AsyncLoggerContextSelector
2,使用同步、异步的混合体
通过使用****你可以同时使用同步和异步两种模式。
在下面的例子中,所有应用指定日志使用异步的,而root 日志使用同步的。
<Loggers>
<AsyncLogger name="com.example.log4j2demo" level="debug" additivity="false">
<AppenderRef ref="ConsoleAppender" />
<AppenderRef ref="FileAppender" />
</AsyncLogger>
<Root level="info">
<AppenderRef ref="ConsoleAppender" />
<AppenderRef ref="FileAppender" />
</Root>
</Loggers>
你在使用**元素时,并不需要添加SystemProperty。只需在log4j2.xml**中按照上面的内容进行修改。
总结
在本文中,我们学习了如何在Spring Boot项目中集成和配置Log4j2。同时我们也配置了不同类型的appender:ConsoleAppender, RollingFileAppender, SMTP Appender. 最后我们需要如何使用Log4j2的同步/异步日志。
本文涉及到的代码你可以在github中查看。