首页 > 软件编程 > java > SpringBoot整合log4j2日志

SpringBoot整合log4j2日志的实现

2021-06-05 08:48:12 作者：orginly

在项目推进中，如果说第一件事是搭Spring框架的话，那么第二件事情就是在Sring基础上搭建日志框架，大家都知道日志对于一个项目的重要性，尤其是线上Web项目，因为日志可能是我们了解应用如何执行的唯一方式。此篇文章是博主在实践中用Springboot整合log4j2日志的总结

关于日志级别

共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

All：最低等级的，用于打开所有日志记录.
Trace：是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.
Debug：指出细粒度信息事件对调试应用程序是非常有帮助的.
Info：消息在粗粒度级别上突出强调应用程序的运行过程.
Warn：输出警告及warn以下级别的日志.
Error：输出错误信息日志.
Fatal：输出每个严重的错误事件将会导致应用程序的退出的日志.
OFF：最高等级的，用于关闭所有日志记录.

程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少。

为什么选用log4j2

相比与其他的日志系统，log4j2丢数据这种情况少；disruptor技术，在多线程环境下，性能高于logback等10倍以上；利用jdk1.5并发的特性，减少了死锁的发生；

在这列举一下一些网上其他博文中对它们的性能评测：

可以看到在同步日志模式下, Logback的性能是最糟糕的.
log4j2的性能无论在同步日志模式还是异步日志模式下都是最佳的.

log4j2优越的性能其原因在于log4j2使用了LMAX,一个无锁的线程间通信库代替了,logback和log4j之前的队列. 并发性能大大提升。

排除 spring-boot 自带的 logback 依赖

因为多个日志组件在一起的话会产生冲突需要排除 spring-boot 自带的 logback 依赖
pom.xml中原有的spring-boot-web 依赖中添加 exclusion标签

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

不需要设置版本会自动跟具当前 spring-boot 版本进行匹配

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

配置文件节点解析

根节点Configuration

有两个属性：status 和 monitorinterval ,有两个子节点：Appenders和Loggers(表明可以定义多个Appender和Logger)

status： 用来指定log4j本身的打印日志的级别.
monitorinterval： 用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s

Appenders节点

常见的有三种子节点：Console、RollingFile、File.

Console节点用来定义输出到控制台的Appender.

name： 指定Appender的名字.

target： SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认：SYSTEM_OUT.

PatternLayout： 输出格式，不设置默认为：%m%n.

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

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

RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.

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

Loggers节点

常见的有两种：Root和Logger.

Root节点

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

level：日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
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中进行输出。

配置 log4j2

将配置 log4j2.xml 配置文件放在 resource 目录中
例如以下完整的日志配置文件

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="WARN" monitorInterval="30">
    <!--先定义所有的appender-->
    <appenders>
        <!--这个输出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
        </console>
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
        <File name="log" fileName="log/test.log" append="false">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>
        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/IdeaProjects/logs/info.log"
                     filePattern="${sys:user.home}/IdeaProjects/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <!-- 每天滚动一次 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 或者日志达到10KB 滚动一次 -->
                <SizeBasedTriggeringPolicy size="10k"/>
            </Policies>
        </RollingFile>
        <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/IdeaProjects/logs/warn.log"
                     filePattern="${sys:user.home}/IdeaProjects/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <!-- 每天滚动一次 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 或者日志达到10KB 滚动一次 -->
                <SizeBasedTriggeringPolicy size="10k"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
        <RollingFile name="RollingFileError" fileName="${sys:user.home}/IdeaProjects/logs/error.log"
                     filePattern="${sys:user.home}/IdeaProjects/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <!-- 每天滚动一次 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 或者日志达到10KB 滚动一次 -->
                <SizeBasedTriggeringPolicy size="10k"/>
            </Policies>
        </RollingFile>
    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.springframework" level="INFO"/>
        <logger name="org.mybatis" level="INFO"/>
        <root level="all">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>
</configuration>

以上就是SpringBoot 整合log4j2日志的实现的详细内容，更多关于SpringBoot 整合log4j2日志的资料请关注脚本之家其它相关文章！