SpringBoot日志整合log4j2 + slf4j

良好的日志输出能够在遇到问题的时候很快的定位到出现问题的地方。所以我们首先把log4j集成进去。

我们使用的是log4j2,在使用方面与log4j基本上没什么区别,比较大的区别是log4j2不再支持properties配置文件,支持xml、json格式的文件.

properties文件的可阅读性相对xml差了一些

单独使用log4j2

pom添加依赖

<dependencies>
        <!-- springBoot 的启动器 -->
        <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>
        <!--log4j2 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
</dependencies>

添加log4j2配置文件

resources文件下新建log4j2.xml配置文件

<?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="${LOG_PATTERN}"/>
      <!--控制台只输出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>

xml配置解析

  • 配置简介
  1. 日志级别

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

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

    • CONSOLE(输出到控制台)
    • FILE(输出到文件)
  3. 格式

    • SimpleLayout:以简单的形式显示

    • HTMLLayout:以HTML表格显示

    • PatternLayout:自定义形式显示

      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地址
      
  • 配置详解

    1. 根节点Configuration有两个属性:

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

      • status
      • monitorinterval

      根节点Configuration有两个子节点:

      • Appenders
      • Loggers(表明可以定义多个Appender和Logger).
    2. 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…而不是7am.
      • SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.
      • DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。

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

    测试demo:

    @RequestMapping("/ums")
    @RestController
    @Log4j2
    @Api(value = "用户菜单演示", tags = "用户菜单")
    public class AdminMenusController {
        private Logger logger = LoggerFactory.getLogger(this.getClass());
    
        @Autowired
        AdminMenuService adminMenuService;
    
        @Autowired
        Hello hello;
    
        @RequestMapping(value = "/getMenus", method = RequestMethod.POST)
        @ApiOperation(notes = "需要id", value = "获取用户菜单")
        public AdminMenu getMenus(@ApiParam(required = true, value = "用户id") @RequestBody Integer userId) {
            hello.getHello();
            logger.info("getMenus:{} Log4j2", userId);
            System.out.println("userId :" + userId);
            return adminMenuService.getAdminMenus();
        }
    }
    

    日志为:

    20:05:22.710 [http-nio-8090-exec-2] INFO  com.ll.farm.mall.admin.controller.AdminMenusController - getMenus:123 Log4j2
    userId :123
    

使用slf4j整合log4j2

实际开发中,推荐开发人员直接使用log4j2去记录日志信息。

为什么阿里巴巴禁止工程师直接使用日志系统(Log4j、Logback)中的 API

需要使用slf4j整合log4j2,确保系统兼容性,整体步骤和上述步骤一至。

上面的 log4j2 已经适配了slf4j日志门面,所以我们的代码无需替换,只需要替换使用方法。

使用log记录时,不能使用@Log4j2注解,需要使用@Slf4j注解,其他步骤一致

参考:

Spring Boot 学习笔记(二) 整合 log4j2

Springboot整合log4j2日志全解

Spring Boot 整合 slf4j+log4j 实现日志管理