继续创作，加速成长！这是我参与「日新计划 10 月更文应战」的第8天，点击检查活动概况

概述

公司的spring boot项目不是运用默许的logback作为日志框架，而是log4j2, 首要原因是logback出现过一个生产问题导致，具体什么问题难以追溯了。本文首要讲解下SpringBoot 2.x怎么更换springboot的日志框架为log4j2, 以及log4j2的装备。

整合步骤

本次演示选用的springboot 版本为2.7.x。

  1. 依靠引进
<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>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
  • 需要排除掉logback日志框架的依靠spring-boot-starter-logging
  • 引进log4j2的依靠spring-boot-starter-log4j2
  1. 增加log4j2装备文件
  • 在classpath下增加log4j2-spring.xml或许log4j2.xml文件，主张运用log4j-spring.xml，这种方法spring能够控制初始化。
  • 假如你不想把装备放到classpath下，需要自界说方位， 能够在装备文件中经过装备项logging.config: ./log4j2.xml来修正。

SpringBoot 2.x整合Log4j2日志

  1. 增加日志文件内容

下面经过一个最精简的装备内容，下一节具体讲解装备。

<?xml version="1.0" encoding="UTF-8"?>
<configuration monitorInterval="5">
    <!--变量装备-->
    <Properties>
        <!-- 格局化输出：%date表明日期，%thread表明线程名，%-5level：等级从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
        <!-- %logger{36} 表明 Logger 姓名最长36个字符 -->
        <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"/>
        <!-- 界说日志存储的途径 -->
        <property name="FILE_PATH" value="./logs"/>
        <property name="FILE_NAME" value="log4j2Demo"/>
    </Properties>
    <appenders>
        <Console name="Console" 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>
        <!--文件会打印出一切信息，这个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>
        <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>
  1. 增加测试代码

SpringBoot 2.x整合Log4j2日志

  1. 检查结果

SpringBoot 2.x整合Log4j2日志

Log4j2装备详解

log4j2日志等级从低到高，如下：

● trace：追寻，便是程序推进一下，能够写个trace输出

● debug：调试，一般作为最低等级，trace基本不必。

● info：输出重要的信息，运用较多

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

● error：错误信息。用的也许多。

● fatal：丧命错误。

假如一条日志信息的等级大于等于装备文件的等级，就记录。

装备文件模板如下：

<?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是换行符-->
    <!-- %logger{36} 表明 Logger 姓名最长36个字符 -->
    <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
    <!-- 界说日志存储的途径 -->
    <property name="FILE_PATH" value="更换为你的日志途径" />
    <property name="FILE_NAME" value="更换为你的项目名" />
  </Properties>
  <appenders>
    <console name="Console" 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"/>
      <!--控制台只输出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>

根节点configuration

  • 特点status用来指定log4j本身的打印日志的等级.
  • 特点monitorinterval用于指定log4j主动重新装备的监测间隔时刻，单位是s,最小是5s.

子节点Properties

装备全局变量，能够经过${xxx}的方法引用

子节点Appenders

常见的有三种Appender: 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…而不是7am.
  • SizeBasedTriggeringPolicy:Policies子节点，根据指定文件巨细的翻滚战略，size特点用来界说每个日志文件的巨细.
  • DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开端删去最旧的，创立新的(经过max特点)。

子节点Loggers

常见的有两种类型:root和logger, root实际上是一种特殊的logger。root节点用来指定项意图根日志，假如没有独自指定logger，那么就会默许运用该root日志输出。

  • 特点level:日志输出等级
  • 特点appenderRef，用来指定该日志输出到哪个Appender。
  • logger节点用来独自指定日志的形式，比方要为指定包下的class指定不同的日志等级等。
  • logger节点下特点name用来指定该Logger所适用的类或许类地点的包全途径,继承自root节点。
  • logger节点下的特点appenderRef, 用来指定该日志输出到哪个Appender,假如没有指定，就会默许继承自root。假如指定了，那么会在指定的这个appender和root的appender中都会输出，此刻我们能够设置Logger的additivity=”false”只在自界说的appender中进行输出。

总结

本文首要讲解了springboot 2.x整合log4j2的教程，期望对我们有帮助。

参考

/post/687065…

www.cnblogs.com/keeya/p/101…