如何将滚动文件记录器添加到SpringBoot?

时间:2020-06-15 16:31:37

标签: spring spring-boot logging log4j slf4j

我正在使用这个非常好的示例here学习SpringBoot。

但是我想学习如何添加到该项目中的一件事是RollingFileAppender

在以前的项目中,我总是做以下事情:

1)添加了这些依赖性

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.5</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.5</version>
</dependency>

2)在log4j.properties文件夹中添加以下文件src/main/resources

# Root logger option
log4j.rootLogger=INFO, stdout, loggerId

log4j.appender.loggerId=org.apache.log4j.RollingFileAppender  
log4j.appender.loggerId.layout=org.apache.log4j.PatternLayout  
log4j.appender.loggerId.layout.ConversionPattern=%d [%t] %-5p (%F:%L) - %m%n  
log4j.appender.loggerId.File=logs/app.log
log4j.appender.loggerId.MaxFileSize=100MB
log4j.appender.loggerId.MaxBackupIndex=30

# Direct log messages to stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

# Silence unnecessary logs
log4j.logger.net.schmizz=OFF
log4j.logger.io.javalin=OFF
log4j.logger.net.dv8tion.jda.core.requests=OFF

3)在代码中,我可以调用记录器:

private Logger LOG = LoggerFactory.getLogger(<class>)

(...)

LOG.info("logging a message")

这会将日志发送到控制台以及滚动文件logs/app.log,该文件的最大大小为100MB(在属性文件中定义)。

在现代的SpringBoot项目中,例如我上面在GitHub中链接的项目中,可能使用SpringBoot附带的记录器,这样做的正确方法是什么?

谢谢!

1 个答案:

答案 0 :(得分:1)

Spring Boot中的登录与普通Java项目中的登录没有本质上的区别。 Spring Boot使用Commons Logging进行所有内部日志记录,但是使底层日志实现保持打开状态。提供了Java Util Logging,Log4J2和Logback的默认配置。在每种情况下,记录器都已预先配置为使用控制台输出,同时还提供可选文件输出。默认情况下,如果您使用“启动器”,则使用Logback进行日志记录。1

如果要坚持使用Log4J2,则必须排除默认的Logback依赖项,并包括Log4J2:

<!-- exclude logback , add log4j2 -->
<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>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

然后在log4j2.xml中添加一个名为log4j2.properties或(src/main/resources)的新文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="loggerId" class="org.apache.log4j.RollingFileAppender">
        <param name="File" value="logs/app.log"/>
        <param name="MaxBackupIndex" value="30"/>
        <param name="MaxFileSize" value="100MB"/>
        <layout class="org.apache.log4j.PatternLayout  ">
            <param name="ConversionPattern" value="%d [%t] %-5p (%F:%L) - %m%n"/>
        </layout>
    </appender>
    <appender name="stdout" class="org.apache.log4j.ConsoleAppender">
        <param name="Target" value="System.out"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        </layout>
    </appender>
    <logger name="io.javalin">
        <level value="OFF"/>
    </logger>
    <logger name="net.dv8tion.jda.core.requests">
        <level value="OFF"/>
    </logger>
    <logger name="net.schmizz">
        <level value="OFF"/>
    </logger>
    <root>
        <level value="INFO"/>
        <appender-ref ref="stdout"/>
        <appender-ref ref="loggerId"/>
    </root>
</configuration>

有关更多信息,baeldung.com是我转到有关如何执行此操作的最佳指南的地方。由于您是专门询问滚动文件添加程序的建议,因此我建议使用A Guide to Rolling File Appenders。在Logging in Spring Boot上还有更通用的文章。

我个人喜欢使用@Slf4j之类的Lombok annotations来摆脱日志记录样板,并防止复制和粘贴错误。

启用代码!