SpringBoot日志配置-logback和log4j2

本文介绍了SpringBoot默认的日志框架commons-logging及其配置,然后详细讲解了如何切换到更灵活的logback,并提供了多环境配置示例。对于生产环境,还提及了log4j2的配置方法,包括添加依赖、配置文件内容以及环境切换。文章最后对比了Log4J2和Logback的性能和配置复杂度,推荐使用logback作为首选。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

SpringBoot默认使用的 commons-logging 日志框架, 默认的日志输出级别: info

使用commons-logging 配置文件对日志的配置:

//只需要在配置文件中更改默认值
//设置日志输出级别为debug
Debug=true
//日志文件名,比如:suke.log,或者是 /var/log/suke.log
logging.file=suke.log
//设置目录
logging.path=/var/log
//日志级别配置,比如: logging.level.org.springframework=DEBUG
logging.level.*=info
logging.level.org.springframework=DEBUG

不够灵活, 多环境切换的时候, 对日志文件经常进行修改

使用logback(推荐)

spring boot默认会加载:classpath:logback-spring.xml

注意:如果logback的配置文件不叫:logback-spring.xml

// 如果日志配置文件名不是logback-spring.xml, 需要在springBoot配置文件中指明使用哪个文件
// logging.config=logback配置文件
logging: 
  config: classpath:logback-demo.xml

logback-spring.xml :

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 文件输出格式 -->
    <property name="PATTERN" value="%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] -| %msg%n" />
    <!-- test文件路径 : 测试环境,日志保存路径   更改文件夹地址,文件夹不存在会自动创建**(更改)-->
    <property name="TEST_FILE_PATH" value="d:/opt/hj/logs" />  
    <!-- prod文件路径 :生产环境 , linux系统-->
    <property name="PROD_FILE_PATH" value="/opt/hj/logs" />
    
    <!-- 开发环境 -->
    <springProfile name="dev">
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>${PATTERN}</pattern>
            </encoder>
        </appender>
        <!-- 设置那个包下的日志的输出级别 
            com.zl.app 包以及子包下的所有类的输出级别:debug  (更改包名,输出级别)
        -->
        <logger name="com.springBootThymeleaf" level="debug"/>
        <logger name="org.springframework" level="debug"/>
        <!-- 整个项目的日志输出级别:  info-->
        <root level="info">
            <appender-ref ref="CONSOLE" />
        </root>
    </springProfile>
    <!-- 测试环境 -->
    <springProfile name="test">
        <!-- 每天产生一个文件 -->
        <appender name="TEST-FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 文件路径 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 文件名称:  
                        info.2020-07-06.log
                        info.2020-07-07.log
                 -->
                <fileNamePattern>${TEST_FILE_PATH}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
                <!-- 文件最大保存历史数量 -->
                <MaxHistory>100</MaxHistory>
            </rollingPolicy>
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>${PATTERN}</pattern>
            </layout>
        </appender>     

        <root level="info">
            <appender-ref ref="TEST-FILE" />
        </root>
    </springProfile>

    <!-- 生产环境 -->
    <springProfile name="prod">
        <appender name="PROD_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${PRO_FILE_PATH}/warn.%d{yyyy-MM-dd}.log</fileNamePattern>
                <MaxHistory>100</MaxHistory>
            </rollingPolicy>
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>${PATTERN}</pattern>
            </layout>
        </appender>

        <root level="warn">
            <appender-ref ref="PROD_FILE" />
        </root>
    </springProfile>
</configuration>

使用或者更改环境:

spring:
  profiles:
    active: dev (或者test/prod 会自动加载)

使用log4j2配置

1.去除logback的依赖包,添加log4j2的依赖包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <!-- 基于log4J2的配置,需要排除logback的依赖 -->
    <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 在classpath添加log4j2.xml或者log4j2-spring.xml(spring boot 默认加载)

application.yml 扫描自定义配置文件

logging:
  config: classpath:log4j2-dev.xml

Log4j的配置文件:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <properties>
        <!-- 文件输出格式 -->
        <property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss} |-%-5level [%thread] %c [%L] -| %msg%n</property>
    </properties>
    <appenders>
        <Console name="CONSOLE" target="system_out">
            <PatternLayout pattern="${PATTERN}" />
        </Console>
    </appenders>
    <loggers>
        <logger name="com.roncoo.education" level="debug" />
        <root level="info">
            <appenderref ref="CONSOLE" />
        </root>
    </loggers>
</configuration>

比较

性能比较:Log4J2 和 Logback 都优于 log4j(不推荐使用)

配置方式:Logback最简洁,spring boot默认,推荐使用

参考资料:
1、https://www.cnblogs.com/64Byte/p/13256543.html 【20211214】

### 在Spring Boot项目中配置Log4j2作为日志框架 在Spring Boot项目中,默认情况下使用的是Logback作为日志记录工具。为了切换至Log4j2,需调整项目的依赖关系并正确设置相应的配置文件。 对于Maven构建的项目,在`pom.xml`文件中的dependencies部分应移除默认的日志启动器,并加入针对Log4j2的支持: ```xml <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> ``` 完成上述操作之后,还需创建或修改位于src/main/resources目录下的`log4j2.xml`来定义具体的应用程序日志行为[^1]。 此外,确保应用程序内的代码遵循SLF4J接口标准来进行日志调用,这允许开发者编写与特定日志库无关的日志语句,从而方便日后更换底层日志机制而不需要改动业务逻辑层面上的日志输出方式[^4]。 例如: ```java import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class MyClass { private static final Logger logger = LoggerFactory.getLogger(MyClass.class); public void myMethod() { logger.info("This is an info message."); } } ``` 通过以上步骤即可成功地将在Spring Boot应用里使用的日志系统由原来的Logback更改为Log4j2[^3]。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值