在Springboot中使用log4j2实现日志记录，以及可能会出现的错误及其解决方案

茴香豆110

已于 2024-06-28 12:48:05 修改

阅读量693

点赞数 24

文章标签： spring boot log4j java logback

于 2024-06-27 22:35:57 首次发布

本文链接：https://blog.csdn.net/2401_86027272/article/details/140024656

版权

1. Springboot使用的原生日志

2. 如何在Springboot中使用log4j2

2.1 配置相关依赖

2.2 通过两种方式来配置log4j2

2.2.1 在application.properties中通过属性配置

编辑

2.2.2 在log4j2.xml文件中配置

2.3 使用lombok实现日志记录

1. Springboot使用的原生日志

Springboot中使用的日志实现方式是slf4j+logback的实现方式。虽然使用原生的日志可以实现日志记录的功能，但是log4j2的功能更加强大，效率更高。log4j2的效率可以在多线程时，在线程数量大的情况下，超过logback10倍左右！500万数据大概0.25G，只需3秒左右就可以写进磁盘，所以越来越多的公司开始使用log4j2。接下来我会逐步介绍如何在Springboot中使用log4j2记录日志

2. 如何在Springboot中使用log4j2

2.1 配置相关依赖

在pom.xml中排除原生的日志场景启动器，也就是移除logback的相关依赖，方便后续使用log4j2的场景启动器

 <!--排除logback的依赖-->
<dependency>
   <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <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>

注意：网上大部分的教程都是按照这个方式配置相关依赖，只是在web 场景启动器中排除logging，可能会导致无法配置上log4j2，如果同学按照此方法无法配置成功，可以按照下面的方式配置，我们在spring-boot-start中排除logging

 <!--排除logback的依赖-->
<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>

        <!--引入log4j2的场景启动器-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

2.2 通过两种方式来配置log4j2

2.2.1 在application.properties中通过属性配置

我们可以在application.properties中通过属性配置，下面是具体配置可以参考。注意在配置层单独设置日志级别时，注意选择自己controller层具体的包名替换我的包名

logging.file.name=./boot/mybatis.log 日志文件是项目下的boot文件夹下的mybatis.log

这种方式可以在日常学习中使用，比较简便。

#设置日志
#默认日志级别
logging.level.root=info
#控制层设置日志级别是debug
#logging.level.com.mmy.boot.controller=warn
# 针对于控制台  %d日志输出时间格式  %thread线程  %-5level日志级别限制显示5个字符  %logger{50}日志器限制显示50个字符  %msg日志信息
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss}---> [%thread]---> %-5level %logger{50} - %msg%n

#日志文件的编码
logging.charset.file=UTF-8
#设置日志文件名
logging.file.name=./boot/mybatis.log
#设置日志文件格式
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss:SS}--->> [%thread]---> %-5level %logger{50} - %msg%n
 滚动记录日志
logging.logback.rollingpolicy.file-name-pattern=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz
logging.logback.rollingpolicy.max-file-size=5MB
logging.logback.rollingpolicy.max-history=365

实现效果如下：

2.2.2 在log4j2.xml文件中配置

在resuorces下直接创建log4j2.xml文件即可自动识别完成配置，注意放置位置以及文件名。下面是具体的配置文件内容供大家参考

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="5">
    <!--日志级别以及优先级排序: 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="./myLog" />
        <property name="FILE_NAME" value="boot" />
    </Properties>

    <appenders>

        <!-- 控制台 -->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>

        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!--druid的日志记录追加器-->
        <RollingFile name="druidSqlRollingFile" fileName="${FILE_PATH}/druid-sql.log" filePattern="${FILE_PATH}/$${date:yyyy-MM}/api-%d{yyyy-MM-dd}-%i.log.gz">
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss}] %-5level %L %M - %msg%xEx%n"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="500MB"/>
                <TimeBasedTriggeringPolicy/>
            </Policies>
        </RollingFile>

    </appenders>

    <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
    <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>

        <!--过滤掉mybatis的一些无用的DEBUG信息-->
        <!--若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
        <logger name="org.mybatis" level="info"></logger>

        <!--过滤掉spring的一些无用的DEBUG信息-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="Filelog"/>
        </Logger>

        <!--Druid监控系统信息-->
        <logger name="druid.sql.Statement" level="debug" additivity="false">
            <appender-ref ref="druidSqlRollingFile"/>
        </logger>

        <!-- 针对当前项目下的controller -->
        <logger name="com.mmy.boot.controller" level="debug" additivity="false">
            <appender-ref ref="Console" />
            <appender-ref ref="Filelog" />
            <appender-ref ref="RollingFileInfo" />
            <appender-ref ref="RollingFileError"/>
        </logger>

        <!-- 父 -->
        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="Filelog"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>

</configuration>

具体效果如下，在当前项目下log文件夹内产生五个日志文件，不同的日志信息可以存储在不同的日志文件中，方便查询，由此可见log4j2的功能强大。

2.3 使用lombok实现日志记录

没有使用过lombok或者不会配置的同学，可以参考这篇文章:Lombok简介、使用、工作原理、优缺点-CSDN博客

可以使用lombok的@Slf4j注解简便操作，可以直接使用log作为日志器。下面是个测试案例：

@RestController
@Slf4j
public class UserController {

    @GetMapping("/test")
    public String test(){

        try {
            int i = 1/0;
            log.info("test");
            return "test";
        } catch (Exception e) {
            log.error(e.getMessage());
            e.printStackTrace();
        }
        return null;
    }
}

测试结果：在error.log文件中记录了错误日志

茴香豆110

关注

24
点赞
踩
14

收藏

觉得还不错? 一键收藏
1
评论
在Springboot中使用log4j2实现日志记录，以及可能会出现的错误及其解决方案

Springboot中使用的日志实现方式是slf4j+logback的实现方式。虽然使用原生的日志可以实现日志记录的功能，但是log4g2的功能更加强大，效率更高。log4j2的效率可以在多线程时，在线程数量大的情况下，超过logback10倍左右！500万数据大概0.25G，只需3秒左右就可以写进磁盘，所以越来越多的公司开始使用log4g2。接下来我会逐步介绍如何在Springboot中使用log4j2记录日志。
复制链接

扫一扫