SpringBoot 使用Log4j2日志

原创
2021/04/25 22:33
阅读数 113

Apache Log4j 2 是 Log4j 的升级版,对 Log4j 的前身 Log4j 1.x 进行了重大改进,并提供了 Logback 中可用的许多改进,同时解决了 Logback 体系结构中的一些固有问题。由于使用了 LMAX Disruptor 技术(无锁异步),使得日志的吞吐量、性能比 Log4j 1.x 提高 10 倍,并解决了一些死锁的 bug,而且配置更加简单灵活。Log4j 2 中各种Message对象,字符串数组,字节数组等全部复用 ,不重复创建,大大减少了无用对象的创建,从而做到“零GC”。

 

官网地址:http://logging.apache.org/log4j/2.x/index.html

中文文档:https://www.docs4dev.com/docs/zh/log4j2/2.x/all

注意:2021年12月发现了 Apache Log4j 2.x <= 2.14.1 版本存在远程执行代码漏洞。建议使用2.15.0以上的版本。

 

优点如下:

  • 相比与其他的日志系统,Log4j2 丢数据的情况少。
  • 采用 Disruptor 技术,在多线程环境下,性能高于 Logback 等 10 倍以上(在所有日志框架中 Log4j2 性能都是最佳的)。
  • 利用 JDK1.5 并发的特性,减少了死锁的发生。

 

我们可以整合 Log4j2 日志框架(形成 SLF4J + Log4j2 组合)。

日志框架有很多,大多数是由一个抽象层 + 实现层的组合来搭建的,而用户不应该直接使用具体的日志实现类,应该使用日志的抽象层。

  • 抽象层:JCL(Jakarta Commons Logging)、SLF4j(Simple Logging Facade for Java)、jboss-logging。
  • 实现层:Log4j 、JUL(java.util.logging)、Log4j2、Logback。

 

一、添加依赖

如项目中有导入 spring-boot-starter-web 依赖包,记得去掉 spring 自带的日志依赖 spring-boot-starter-logging。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <!-- 去掉springboot默认日志配置 -->
    <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>

 

二、编写代码

1、通过类加载方式打印日志

@RestController
@RequestMapping("/demo")
public class DemoController {

    Logger logger = LoggerFactory.getLogger(getClass());

    @GetMapping
    public void demo() {
        logger.trace("Trace 日志...");
        logger.debug("Debug 日志...");
        logger.info("Info 日志...");
        logger.warn("Warn 日志...");
        logger.error("Error 日志...");
    }

}

这里我们打印出 5 种不同级别的日志,控制台日志信息:

 

2、使用 Lombok 打印日志

如果项目有使用 Lombok 的话,直接使用 @Slf4j 注解可以省去从日志工厂生成日志对象这一步,直接进行日志记录。

@Slf4j
@RestController
@RequestMapping("/demo")
public class DemoController {

    @GetMapping
    public void demo() {
        log.trace("Trace 日志...");
        log.debug("Debug 日志...");
        log.info("Info 日志...");
        log.warn("Warn 日志...");
        log.error("Error 日志...");
    }

}

 

三、配置文件

Log4j 是通过一个 .properties 文件作为主配置文。Log4j2 则弃用了这种方式,采用的是 .xml、.json 或者 .jsn 这种方式来做。

1、添加默认配置文件名 log4j2-spring.xml,在 src/main/resources 根目录下。

如果自定义了文件名,需要在 application.properties 或者 application.yml 文件中配置:

logging.config=classpath:log4j2-dev.xml

2、配置内容

<?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是换行符 -->
        <property name="LOG_PATTERN" value="%date{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger [%L] : %msg%n" />
        <property name="LOG_PATTERN_HIGHLIGHT" value="%date{yyyy-MM-dd HH:mm:ss:SSS} %highlight{%5level} [%thread] %style{%logger}{bright,cyan} [%style{%L}{bright,blue}] : %msg%n" />
 
        <!-- 定义日志存储的路径,不要配置相对路径 -->
        <property name="FILE_PATH" value="/Volumes/BOOTCAMP/log" />
        <!-- 定义日志归档压缩包名字,通常设置为项目名 -->
        <property name="FILE_NAME" value="hangge-test" />
    </Properties>
 
    <appenders>
 
        <!--*********************控制台日志***********************-->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN_HIGHLIGHT}"/>
            <!--控制台只输出level及其以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
            <ThresholdFilter level="info" 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>
 
    </appenders>
 
    <!--Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。-->
    <!--然后定义loggers,只有定义了logger并引入的appender,appender才会生效-->
    <loggers>
 
        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        <!--监控系统信息-->
        <!--若是additivity设为false,则 子Logger 只会在自己的appender里输出,而不会在 父Logger 的appender里输出。-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </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>

我们配置了控制台输出,以及生成 4 个日志文件。当日期变更时,或者超过指定大小,之前的日志文件会自动打成压缩包。

  • test.log:保存所有信息,这个 log 每次运行程序会自动清空之前日志(适合临时测试用)
  • info.log:保存所有的 info 及以下级别的信息。
  • warn.log:保存所有的 warn 及以下级别的信息。
  • error.log:所有的 error 及以下级别的信息。

 

展开阅读全文
加载中
点击引领话题📣 发布并加入讨论🔥
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部