SpringBoot集成Log4j2

木易羊羊羊

已于 2024-04-25 13:24:43 修改

阅读量593

点赞数 9

文章标签： spring boot log4j java

于 2023-12-20 16:07:44 首次发布

本文链接：https://blog.csdn.net/yangjuan9028/article/details/135108231

版权

Apache Log4j2是对Log4j的升级，它比其前身Log4j 1.x提供了重大改进，并提供了Logback中可用的许多改进，同时修复了Logback架构中的一些问题，所以选择log4j2。

1、SpringBoot 框架默认使用的LogBack日志。如果使用log4j2，需求排除spring-boot-starter中的spring-boot-starter-logging，同时引入spring-boot-starter-log4j2。

pom.xml

<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>

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
</dependency>

2、application.yml

logging:
  level:
    com.example.service.mapper: debug

3、log4j2.xml，SpringBoot会自动加载log4j2.xml文件。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <!--<Configuration status="WARN" monitorInterval="30"> -->
    <properties>
        <property name="LOG_LEVEL">info</property>
        <property name="LOG_HOME">./logs</property>
        <!--<property name="PATTERN">[trace_id=%X{trace_id}] [%d{yyyy-MM-dd HH:mm:ss:SSS}{GMT+8}][%5p][%20c][- %l - %m] %n</property>-->
        <property name="PATTERN">[%d{yyyy-MM-dd HH:mm:ss:SSS}{GMT+8}][%5p][%20c][- %l - %m] %n</property>
    </properties>
    <Appenders>
        <!--*********************控制台日志***********************-->
        <Console name="consoleAppender" target="SYSTEM_OUT">
            <!--设置日志格式及颜色-->
            <PatternLayout
                    pattern="%style{%d{ISO8601}}{bright,green} %highlight{%-5level} [%style{%t}{bright,blue}] %style{%C{}}{bright,yellow}: %msg%n%style{%throwable}{red}"
                    disableAnsi="false" noConsoleNoAnsi="false"/>
        </Console>

        <!--*********************文件日志***********************-->
        <!--all级别日志-->
        <RollingFile name="allFileAppender"
                     fileName="${LOG_HOME}/all.log"
                     filePattern="${LOG_HOME}/$${date:yyyy-MM}/all-%d{yyyy-MM-dd}-%i.log.gz">
            <!--输出日志的格式-->
            <PatternLayout pattern="${PATTERN}"/>
            <Policies>
                <!-- 设置日志文件切分参数 -->
                <!--<OnStartupTriggeringPolicy/>-->
                <!--设置日志基础文件大小，超过该大小就触发日志文件滚动更新-->
                <SizeBasedTriggeringPolicy size="100 MB"/>
                <!--设置日志文件滚动更新的时间，依赖于文件命名filePattern的设置-->
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <!--设置日志的文件个数上限，不设置默认为7个，超过大小后会被覆盖；依赖于filePattern中的%i-->
            <DefaultRolloverStrategy max="100"/>
        </RollingFile>

        <!--debug级别日志-->
        <RollingFile name="debugFileAppender"
                     fileName="${LOG_HOME}/debug.log"
                     filePattern="${LOG_HOME}/$${date:yyyy-MM}/debug-%d{yyyy-MM-dd}-%i.log.gz">
            <Filters>
                <!--过滤掉info及更高级别日志-->
                <ThresholdFilter level="info" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <!--输出日志的格式-->
            <PatternLayout pattern="${PATTERN}"/>
            <Policies>
                <!-- 设置日志文件切分参数 -->
                <!--<OnStartupTriggeringPolicy/>-->
                <!--设置日志基础文件大小，超过该大小就触发日志文件滚动更新-->
                <SizeBasedTriggeringPolicy size="100 MB"/>
                <!--设置日志文件滚动更新的时间，依赖于文件命名filePattern的设置-->
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <!--设置日志的文件个数上限，不设置默认为7个，超过大小后会被覆盖；依赖于filePattern中的%i-->
            <DefaultRolloverStrategy max="100"/>
        </RollingFile>

        <!--info级别日志-->
        <RollingFile name="infoFileAppender"
                     fileName="${LOG_HOME}/info.log"
                     filePattern="${LOG_HOME}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.gz">
            <Filters>
                <!--过滤掉warn及更高级别日志-->
                <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <!--输出日志的格式-->
            <PatternLayout pattern="${PATTERN}"/>
            <Policies>
                <!-- 设置日志文件切分参数 -->
                <!--<OnStartupTriggeringPolicy/>-->
                <!--设置日志基础文件大小，超过该大小就触发日志文件滚动更新-->
                <SizeBasedTriggeringPolicy size="100 MB"/>
                <!--设置日志文件滚动更新的时间，依赖于文件命名filePattern的设置-->
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            </Policies>
            <!--设置日志的文件个数上限，不设置默认为7个，超过大小后会被覆盖；依赖于filePattern中的%i-->
            <!--<DefaultRolloverStrategy max="100"/>-->
        </RollingFile>

        <!--warn级别日志-->
        <RollingFile name="warnFileAppender"
                     fileName="${LOG_HOME}/warn.log"
                     filePattern="${LOG_HOME}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log.gz">
            <Filters>
                <!--过滤掉error及更高级别日志-->
                <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <!--输出日志的格式-->
            <PatternLayout pattern="${PATTERN}"/>
            <Policies>
                <!-- 设置日志文件切分参数 -->
                <!--<OnStartupTriggeringPolicy/>-->
                <!--设置日志基础文件大小，超过该大小就触发日志文件滚动更新-->
                <SizeBasedTriggeringPolicy size="100 MB"/>
                <!--设置日志文件滚动更新的时间，依赖于文件命名filePattern的设置-->
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <!--设置日志的文件个数上限，不设置默认为7个，超过大小后会被覆盖；依赖于filePattern中的%i-->
            <DefaultRolloverStrategy max="100"/>
        </RollingFile>

        <!--error及更高级别日志-->
        <RollingFile name="errorFileAppender"
                     fileName="${LOG_HOME}/error.log"
                     filePattern="${LOG_HOME}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz">
            <!--输出日志的格式-->
            <PatternLayout pattern="${PATTERN}"/>
            <Policies>
                <!-- 设置日志文件切分参数 -->
                <!--<OnStartupTriggeringPolicy/>-->
                <!--设置日志基础文件大小，超过该大小就触发日志文件滚动更新-->
                <SizeBasedTriggeringPolicy size="100 MB"/>
                <!--设置日志文件滚动更新的时间，依赖于文件命名filePattern的设置-->
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <!--设置日志的文件个数上限，不设置默认为7个，超过大小后会被覆盖；依赖于filePattern中的%i-->
            <DefaultRolloverStrategy max="100"/>
        </RollingFile>
    </Appenders>

    <Loggers>
        <!-- 根日志设置 -->
        <Root level="INFO">
            <AppenderRef ref="allFileAppender" level="all"/>
            <AppenderRef ref="consoleAppender" level="debug"/>
            <AppenderRef ref="debugFileAppender" level="debug"/>
            <AppenderRef ref="infoFileAppender" level="info"/>
            <AppenderRef ref="warnFileAppender" level="warn"/>
            <AppenderRef ref="errorFileAppender" level="error"/>
        </Root>

        <!-- 报日志监听 -->
        <Logger name="org.springframework" level="${LOG_LEVEL}"/>
        <Logger name="io.netty" level="${LOG_LEVEL}"/>
        <Logger name="org.apache" level="${LOG_LEVEL}"/>
        <Logger name="org.hibernate" level="${LOG_LEVEL}"/>
        <Logger name="druid.sql.Statement" level="${LOG_LEVEL}"/>
        <Logger name="org.mybatis" level="${LOG_LEVEL}"/>
        <Logger name="com.baomidou.mybatisplus" level="${LOG_LEVEL}"/>
        <Logger name="org.hibernate" level="${LOG_LEVEL}"/>
        <Logger name="org.quartz" level="${LOG_LEVEL}"/>

        <!--关闭如下包的日志信息-->
        <Logger name="springfox" level="OFF"/>

    </Loggers>

</Configuration>

4、代码中使用

1）使用log4j api

// Logger和LogManager导入的是org.apache.logging包
private static final Logger logger = LogManager.getLogger(UserController.class);

2）使用slf4j，slf4j是对所有日志框架制定的一种规范、标准、接口，并不是一个框架的具体的实现，它的接口并不能独立使用，需要和具体的日志框架实现配合使用（如log4j、logback、log4j2）。

// Logger和LoggerFactory导入的是org.slf4j包
private static final Logger logger = LoggerFactory.getLogger(UserController.class);

3）使用 lombok的@Slf4j注解，lombok插件会将Slf4j注解翻译成 private static final org.slf4j.Logger logger = LoggerFactory.getLogger(this.XXX.class);

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@Slf4j
public class ServiceApplication {
    public static void main(String[] args) {
        SpringApplication.run(ServiceApplication.class, args);
        log.info("日志测试");
    }
}

5、单元测试里使用

@Slf4j
public class MyTest {

     @Test
     public void testLog4j2() {
        log.info("info");
        log.warn("warn");
        log.error("error");
    }
}

木易羊羊羊

关注

9
点赞
踩
11

收藏

觉得还不错? 一键收藏
1
评论
SpringBoot集成Log4j2

如果使用log4j2，需求排除spring-boot-starter中的spring-boot-starter-logging，同时引入spring-boot-starter-log4j2。2）使用slf4j，slf4j是对所有日志框架制定的一种规范、标准、接口，并不是一个框架的具体的实现，它的接口并不能独立使用，需要和具体的日志框架实现配合使用（如log4j、logback、log4j2）。3、log4j2.xml，SpringBoot会自动加载log4j2.xml文件。
复制链接

扫一扫