SpringBoot如何整合Log4j2实现日志记录

Java技术 潘老师 2个月前 (06-15) 166 ℃ (0) 扫码查看

在java项目开发中,日志记录是必不可少的,详细且具体的日志记录对于日后的bug漏洞追踪及维护具有事半功倍的效果,而目前比较流行的主要架构就是SpringBoot+Log4j2来实现日志记录。下面我们来详细了解下如何使用SpringBoot整合Log4j2以及为什么选择Log4j2。

一、常用日志框架类型

1)java.util.logging:是JDK在1.4版本中引入的Java原生日志框架
2)Log4j:Apache的一个开源项目,可以控制日志信息输送的目的地是控制台、文件、GUI组件等,可以控制每一条日志的输出格式,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。不过apache官方对给项目已经停止维护了,虽然市面上目前绝大部分企业都是用的log4j,但新项目建议不要再使用了。
3)LogBack:是Log4j的一个改良版本,SpringBoot默认集成的就是该日志框架。
4)Log4j2:Log4j2已经不仅仅是Log4j的一个升级版本了,它从头到尾都被重写了,性能目前最优,也是开发的首选。

二、常用日志框架与slf4j的区别

上述介绍的是一些日志框架的实现,这里我们需要用日志门面来解决系统与日志实现框架的耦合性。SLF4J,即简单日志门面(Simple Logging Facade for Java),它不是一个真正的日志实现,而是一个抽象层( abstraction layer),它允许你在后台使用任意一个日志实现。
使用了slf4j后,对于应用程序来说,无论底层的日志框架如何变,应用程序不需要修改任意一行代码,就可以直接上线了,有效地降低了其耦合性。

三、为什么选择Log4j2

选择Log4j2,是因为相比与其他的日志框架,Log4j2主要有以下几个优势:

  • log4j2丢数据这种情况少
  • disruptor技术,在多线程环境下,性能高于logback等10倍以上
  • 利用jdk1.5并发的特性,减少了死锁的发生
  • log4j2的性能无论在同步日志模式还是异步日志模式下都是最佳的

另外,log4j2优越的性能其原因在于log4j2使用了LMAX,一个无锁的线程间通信库代替了logback和log4j之前的队列,使得并发性能大大提升。以下是性能对比图:
SpringBoot如何整合Log4j2实现日志记录

四、SpringBoot整合Log4j2步骤

1、修改和添加依赖

在SpringBoot项目中的pom.xml下添加(或修改)如下依赖:

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

如果启动报如下异常:

Caused by: java.lang.BootstrapMethodError: java.lang.NoClassDefFoundError: com/lmax/disruptor/EventFactory

请再加上如下依赖:

<dependency>
    <groupId>com.lmax</groupId>
    <artifactId>disruptor</artifactId>
    <version>3.3.7</version>
</dependency>
注意:由于SpringBoot默认是用logback的日志框架的,所以需要排除logback,不然会出现jar依赖冲突的报错。

2、配置文件

1)情形1:使用默认配置文件名称
resources目录下新建名为log4j2.xml(默认名称)的日志配置文件
2)情形2:自定义配置文件名称
如果自定义了文件名比如为my-log4j2.xml,需要在application.yml中配置如下:

logging:
  config: my-log4j2.xml
  level:
    cn.jay.repository: trace

3、log4j2.xml具体配置

log4j是通过一个.properties的文件作为主配置文件的,而现在的log4j2则已经弃用了这种方式,采用的是.xml.json或者.jsn这种方式来做,可能这也是技术发展的一个必然性,因为properties文件的可阅读性真的是有点差。这里潘老师给出log4j2.xml具体模板配置,供大家参考。
我这里给出一个比较实用的模板,如下:

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="warn" monitorInterval="60" strict="true">
    <Properties>
        <Property name="base.dir">logs</Property>
        <Property name="info.file.name">system</Property>
        <Property name="error.file.name">error</Property>
        <Property name="layout.pattern">%d{yyyy-MM-dd HH:mm:ss,SSS} | %p | %t | %c{2} |- %m%n
        </Property>
        <Property name="file.max.age">180d</Property>
        <Property name="log_info_level">info</Property>
        <Property name="log_debug_level">debug</Property>
        <Property name="log_error_level">error</Property>
    </Properties>

    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout charset="UTF-8" pattern="${layout.pattern}"/>
        </Console>

        <RollingFile name="FILE_INFO" fileName="${base.dir}/${info.file.name}.log"
            filePattern="${base.dir}/${info.file.name}.%d{yyyy-MM-dd}-%i.log.gz">

            <Filters>
                <ThresholdFilter level="${log_debug_level}" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <PatternLayout charset="UTF-8" pattern="${layout.pattern}"/>

            <Policies>
                <OnStartupTriggeringPolicy/>
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="1G"/>
            </Policies>
            <DefaultRolloverStrategy>
                <Delete basePath="${base.dir}" maxDepth="1" followLinks="true">
                    <IfFileName glob="${info.file.name}*.gz"/>
                    <IfLastModified age="${file.max.age}"/>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>

        <RollingFile name="FILE_ERROR" fileName="${base.dir}/${error.file.name}.log"
            filePattern="${base.dir}/${error.file.name}.%d{yyyy-MM-dd}-%i.log.gz">

            <Filters>
                <ThresholdFilter level="${log_error_level}" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>

            <PatternLayout charset="UTF-8" pattern="${layout.pattern}"/>
            <Policies>
                <OnStartupTriggeringPolicy/>
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="200MB"/>
            </Policies>
            <DefaultRolloverStrategy>
                <Delete basePath="${base.dir}" maxDepth="1" followLinks="true">
                    <IfFileName glob="${error.file.name}*.gz"/>
                    <IfLastModified age="${file.max.age}"/>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
    </Appenders>

    <Loggers>
        <!-- 这里的name记得改为自己项目对应的package -->
        <AsyncLogger name="com.panziye" level="DEBUG" additivity="false">
            ${mvn.log.appenders}
            <AppenderRef ref="Console"/>
            <AppenderRef ref="FILE_INFO"/>
            <AppenderRef ref="FILE_ERROR"/>
        </AsyncLogger>

        <AsyncRoot level="INFO">
            ${mvn.log.appenders}
            <AppenderRef ref="Console"/>
            <AppenderRef ref="FILE_INFO"/>
            <AppenderRef ref="FILE_ERROR"/>
        </AsyncRoot>
    </Loggers>
</configuration>

4、简单使用

1)第1种使用方式:

public class LogExample {
  private static final Logger log = LogManager.getLogger(LogExample.class);
  
  public static void main(String[] args) {
    log.error("错误日志信息....");
  }
}

2)第2种使用方式(使用@Slf4j或@Log4j2注解):
使用lombok后,下面的代码等效于上述的代码,注解的方式可以更方便地使用日志。

@Slf4j
public class LogExample {
  public static void main(String[] args) {
    log.error("错误日志信息....");
  }
}

或:

@Log4j2
public class LogExample {
  public static void main(String[] args) {
    log.error("错误日志信息....");
  }
}

1)如果你还不知道Lombok是什么,请参考:

Lombok入门使用教程及其优缺点详解

在Java开发中,因工作需要,你可能会学习或被迫去学习Lombok这个工具,这玩意用起来可以说是贼爽,很方便, […]


2)如果你发现Console控制台日志打印没有彩色效果,请参考:
IDEA使用Log4j2后Console控制台日志打印没有彩色效果

在开发过程中,发现IDEA使用SpringBoot整合Log4j2后Console控制台日志打印没有彩色效果, […]

五、补充:日志参数配置详解

1、日志级别

机制:如果一条日志信息的级别大于等于配置文件的级别,就记录,常用的级别如下:

  • trace:追踪,就是程序推进一下,可以写个trace输出
  • debug:调试,一般作为最低级别,trace基本不用。
  • info:输出重要的信息,使用较多
  • warn:警告,有些信息不是错误信息,但也要给程序员一些提示。
  • error:错误信息。用的也很多。
  • fatal:致命错误。

2、输出源

  • CONSOLE:输出到控制台
  • FILE:输出到文件

3、格式

  • SimpleLayout:以简单的形式显示
  • HTMLLayout:以HTML表格显示
  • PatternLayout:自定义形式显示

4、PatternLayout自定义日志布局:

  • %d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间,输出到毫秒的时间
  • %-5level : 输出日志级别,-5表示左对齐并且固定输出5个字符,如果不足在右边补0
  • %c : logger的名称(%logger)
  • %t : 输出当前线程名称
  • %p : 日志输出格式
  • %m : 日志内容,即 logger.info(“message”)
  • %n : 换行符
  • %C : Java类名(%F)
  • %L : 行号
  • %M : 方法名
  • %l : 输出语句所在的行数, 包括类名、方法名、文件名、行数
  • hostName : 本地机器名
  • hostAddress : 本地ip地址

六、补充:Log4j2配置详解

1、根节点Configuration

11)有两个属性:

  • status
  • monitorinterval

status:用来指定log4j本身的打印日志的级别.
monitorinterval:用于指定log4j自动重新配置的监测间隔时间,单位是s,最小是5s.
2)有两个子节点:
  • Appenders:用来控制日志的输出目的地
  • Loggers:表明可以定义多个Appender和Logger

2、Appenders节点

常见的有三种子节点:Console、RollingFile、File
1)Console节点用来定义输出到控制台的Appender.

  • name:指定Appender的名字.
  • target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
  • PatternLayout:输出格式,不设置默认为:%m%n.

Log4j2提供了很多种非常实用的Appenders,具体可以参考官方文档示例:官方文档示例

2)File节点用来定义输出到指定位置的文件的Appender.

  • name:指定Appender的名字.
  • fileName:指定输出日志的目的文件带全路径的文件名.
  • PatternLayout:输出格式,不设置默认为:%m%n.

3)RollingFile节点用来定义超过指定条件自动删除旧的创建新的Appender.
  • name:指定Appender的名字.
  • fileName:指定输出日志的目的文件带全路径的文件名.
  • PatternLayout:输出格式,不设置默认为:%m%n.
  • filePattern : 指定当发生Rolling时,文件的转移和重命名规则.
  • Policies:指定滚动日志的策略,就是什么时候进行新建日志文件输出日志.
  • TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am…而不是7am.
  • SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.
  • DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。

3、Loggers节点,常见的有两种:Root和Logger.

Root节点用来指定项目的根日志,如果没有单独指定Logger,那么就会默认使用该Root日志输出

  • level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < AppenderRef:Root的子节点,用来指定该日志输出到哪个Appender.
  • Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。
  • level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
  • name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
  • AppenderRef:Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自Root.如果指定了,那么会在指定的这个Appender和Root的Appender中都会输出,此时我们可以设置Logger的additivity=”false”只在自定义的Appender中进行输出。


版权声明:本站所有文章,如无特殊说明,均为本站原创。全部下载资源版权归原作者所有。任何个人或组织,若未征得本站同意,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。
本文链接:SpringBoot如何整合Log4j2实现日志记录
喜欢 (0)
请潘老师喝杯Coffee吧!】
分享 (0)

您必须 微信登录 才能发表评论!