SpringBoot整合Log4j2及配置步骤

SpringBoot整合Log4j2以及配置详解

SpringBoot整合Log4j2步骤：
1、删除spring-boot-starter-parent默认使用spring-boot-starter-logging依赖
2、在pom.xml中增加spring-boot-starter-log4j2依赖
3、创建log4j2.xml文件即可
4、执行，指定目录会生成相应的log文件

1.加入依赖

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
   <exclusions><!-- 去掉springboot默认配置 -->
       <exclusion>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-logging</artifactId>
       </exclusion>
   </exclusions>
</dependency>
<dependency> <!-- 引入log4j2依赖 -->
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

2.在src.java.main.resources目录下创建log4j2.xml文件 log4j2.xml文件内容如下：

<!--定义appender-->
<appenders>
   <!--控制台的输出配置-->
   <console name="Console" target="SYSTEM_OUT">
       <!-- 设置控制台只输出INFO及以上级别的信息(onMatch),其他的直接拒绝(onMismatch) -->
       <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
       <!--输出日志的格式-->
       <PatternLayout pattern="${log_pattern}"/>
   </console>

<!-- 所有的日志信息会打印到此文件中，append=false每次启动程序会自动清空 -->
   <!-- <File name="all" fileName="${file_path}/all.log" append="true">
       <PatternLayout pattern="${log_pattern}"/>
   </File>-->
   <!--
   该RollingFile存储INFO级别的日志，
   默认存储到 fileName 文件中
   超过SizeBasedTriggeringPolicy的设定值，则存储到 filePattern 文件中
   -->
   <RollingFile name="RollingFileInfo" fileName="${file_path}/info.log" filePattern="${file_path}/${backup_folder}/info${backup_file_suffix}">
       <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
       <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
       <!-- 写入日志文件的模板 -->
       <PatternLayout pattern="${log_pattern}"/>
       <Policies>
           <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，超过该数量，会滚动删除前面的记录 -->
           <DefaultRolloverStrategy max="5">
<Delete basePath="" maxDepth="">
<IfFileName glob="*.log" />
<IfLastModified age="*1d" />
</Delete>
</DefaultRolloverStrategy>
           <!--多长时间滚动一次-->
           <TimeBasedTriggeringPolicy interval="2 hour" />
           <!-- 一个日志文件的最大大小 -->
           <SizeBasedTriggeringPolicy size="${file_max_size}"/>
       </Policies>
   </RollingFile>
   <RollingFile name="RollingFileWarn" fileName="${file_path}/warn.log" filePattern="${file_path}/${backup_folder}/warn${backup_file_suffix}">
       <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
       <PatternLayout pattern="${log_pattern}"/>
       <Policies>
           <TimeBasedTriggeringPolicy/>
           <SizeBasedTriggeringPolicy size="${file_max_size}"/>
       </Policies>
   </RollingFile>
   <RollingFile name="RollingFileError" fileName="${file_path}/error.log" filePattern="${file_path}/${backup_folder}/error${backup_file_suffix}">
       <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
       <PatternLayout pattern="${log_pattern}"/>
       <Policies>
           <TimeBasedTriggeringPolicy/>
           <SizeBasedTriggeringPolicy size="${file_max_size}"/>
       </Policies>
   </RollingFile>
</appenders>
<!-- 只有定义了logger并使用appender-ref，appender才会生效 -->
<loggers>
   <!--过滤掉spring和hibernate的一些无用的debug信息-->
   <logger name="org.springframework" level="INFO"/>
   <logger name="org.mybatis" level="INFO">
       <!-- 添加如下设置，控制台会再打印一次 -->
       <AppenderRef ref="Console"/>
   </logger>
   <root level="INFO">
       <appender-ref ref="Console"/>
       <appender-ref ref="RollingFileInfo"/>
       <appender-ref ref="RollingFileWarn"/>
       <appender-ref ref="RollingFileError"/>
   </root>
</loggers>

3.配置参数详解

1.日志级别

• 机制：如果一条日志信息的级别大于等于配置文件的级别，就记录。

• trace：追踪，就是程序推进一下，可以写个trace输出

• debug：调试，一般作为最低级别，trace基本不用。

• info：输出重要的信息，使用较多

• warn：警告，有些信息不是错误信息，但也要给程序员一些提示。

• error：错误信息。用的也很多。

• fatal：致命错误。

2.输出源

• CONSOLE（输出到控制台）

• FILE（输出到文件）

3. 格式

• SimpleLayout：以简单的形式显示

• HTMLLayout：以HTML表格显示

• PatternLayout：自定义形式显示

4.PatternLayout自定义日志布局：

• ％d：显示日志记录时间，{<日期格式>}使用ISO8601定义的日期格式

• 如：％d{yyyy-MM-dd HH:mm:ss}

• ％-5level : 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0

• ％c : 列出logger名字空间的全称，如果加上{<层数>}表示列出从最内层算起的指定层数的名 字空间

• ％C : 列出调用logger的类的全名（包含包路径）

• ％t : 输出当前线程名称

• ％p : 日志输出格式

• ％m : 日志内容，即 logger.info(&ldquo;message&rdquo;)

• ％M : 方法名

• ％n : 换行符

• ％F: 显示调用logger的源文件名

• ％L : 行号

• ％l : 输出语句所在的行数, 包括类名、方法名、文件名、行数

• ％r : 显示从程序启动时到记录该条日志时已经经过的毫秒数

• ％t : 输出产生该日志事件的线程名

• ％x : 按NDC（Nested Diagnostic Context，线程堆栈）顺序输出日志

• 例：假设某程序调用顺序是MyApp调用com.foo.Bar

％c％x - ％m％n ：MyApp - Call com.foo.Bar.com.foo.Bar - Log in Bar MyApp - Return to MyApp.

• hostName : 本地机器名

• hostAddress : 本地ip地址

4.log4j2配置详解

根节点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 : 指定当发生Rolling时，文件的转移和重命名规则.

• Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.

• TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am&hellip;而不是7am.

• SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.

• DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

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中进行输出。

关于日志level.

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

• All:最低等级的，用于打开所有日志记录.

• Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.

• Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.

• Info:消息在粗粒度级别上突出强调应用程序的运行过程.

• Warn:输出警告及warn以下级别的日志.

• Error:输出错误信息日志.

• Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.

• OFF:最高等级的，用于关闭所有日志记录.

5.测试

在启动类添加如下信息：

@SpringBootApplication
public class SpringbootDemoApplication {
    private static final Logger log = org.slf4j.LoggerFactory.getLogger(SpringbootDemoApplication.class);
    public static void main(String[] args) {
        SpringApplication.run(SpringbootDemoApplication.class, args);
        log.error("Something else is wrong here");
        log.info("Something else is wrong here");
        log.warn("Something else is wrong here");
    }
}

查看启动日志：

查看目录：

进入日期下的目录下,由于我们设置了0.5KB作为分隔，并且每个类型最多保留5个文件，所以可以看到下面的情况

现在给大家单独介绍下springboot整合log4j2的方法

导入依赖

<dependency>
   <groupId>log4j</groupId>
   <artifactId>log4j</artifactId>
   <version>1.2.17</version>
</dependency>

<!--log4j2-->
<dependency>
   <groupId>org.apache.logging.log4j</groupId>
   <artifactId>log4j-core</artifactId>
   <version>2.17.2</version>
</dependency>
<dependency>
   <groupId>org.apache.logging.log4j</groupId>
   <artifactId>log4j-api</artifactId>
   <version>2.17.2</version>
</dependency>

！！！注意，屏蔽内部日志部分必须添加上，因为其自带的是logback的依赖

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

添加配置文件

<?xml version="1.0" encoding="UTF-8"?>

<Configuration status="WARN">
   <Properties>
       <Property name="patternLayout">％date{yyyy-MM-dd HH:mm:ss.SSS} [％thread] ％-5level ％logger{36} - ％msg％n</Property>
       <!--生成日志保存位置-->
       <Property name="logdir">D:/home/demo</Property>
   </Properties>

<Appenders>
       <Console name="Console" target="SYSTEM_OUT">
           <PatternLayout pattern="${patternLayout}"/>

<!--            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>-->
           <!--控制台将会打印执行sql及结果-->
           <!--<ThresholdFilter level="TRACE"/>-->
           <ThresholdFilter level="DEBUG"/>
       </Console>

<RollingFile name="InfoLogger"
                    fileName="D:/home/demo/debug/log.log"
                    filePattern="D:/home/demo/debug/log_％d{yyyy-MM-dd}.log" append="true">
           <PatternLayout pattern="${patternLayout}"/>
           <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
           <Policies>
               <!--根据时间来滚动 -->
               <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
           </Policies>
           <!-- 日志保留策略，配置只保留七天 -->
           <DefaultRolloverStrategy>
               <Delete basePath="${logDir}/debug/" maxDepth="1">
                   <IfFileName glob="log_*.log"/>
                   <IfLastModified age="7d"/>
               </Delete>
           </DefaultRolloverStrategy>
       </RollingFile>

<!-- sql：保存sql相关日志 -->
       <RollingFile name="sql"
                    fileName="${logdir}/sql/sql.log"
                    filePattern="${logdir}/sql/sql_％d{yyyy-MM-dd}.log" append="true">
           <PatternLayout pattern="${patternLayout}"/>
           <Policies>
               <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
           </Policies>
           <DefaultRolloverStrategy>
               <Delete basePath="${logDir}/sql/" maxDepth="1">
                   <IfFileName glob="sql_*.log"/>
                   <IfLastModified age="7d"/>
               </Delete>
           </DefaultRolloverStrategy>
       </RollingFile>

</Appenders>

<Loggers>
       <!-- 开启mybatis的sql日志, name和mybatis-config.xml的logPrefix一致 . 级别为debug或trace-->

<Logger name="com.example.demo.mybatis.plus.dao" level="TRACE" additivity="false">
           <AppenderRef ref="Console"/>
           <AppenderRef ref="sql"/>
       </Logger>

<Root level="debug">
           <AppenderRef ref="Console"/>
           <AppenderRef ref="InfoLogger"/>
       </Root>

</Loggers>

</Configuration>

配置文件名字及位置如下图: log4j2.xml

application.yml配置文件

# 日志配置
logging:
 config: classpath:log4j2.xml
 level:
 # 查询接口路径
   com.example.demo.mybatis.plus.dao: DEBUG

常见问题及解决

① 常见问题
问题原因是没有排除spring-boot中自带的日志。

11:34:08.938 [Thread-1] DEBUG org.springframework.boot.devtools.restart.classloader.RestartClassLoader - Created RestartClassLoader org.springframework.boot.devtools.restart.classloader.RestartClassLoader@21253577
Logging system failed to initialize using configuration from 'classpath:log4j2.xml'
java.lang.IllegalStateException: Logback configuration error detected: 
ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:17 - no applicable action for [Properties], current ElementPath  is [[Configuration][Properties]]

② 解决方案
依赖中添加org.springframework.boot，屏蔽内置日志。

来源：https://blog.csdn.net/qq_37216403/article/details/112344874