乐趣区

Spring-Boot-2-集成log4j2日志框架

前言

Log4j2Log4j 的进化版本,并提供了许多 Logback 可用的改进,同时解决了 Logback 体系结构中的一些固有问题。而且日志处理中我们会用到 kafka 作为日志管道。而 kafka 客户端依赖与 Logback 的兼容不是很完美,你可以选择排除依赖冲突或者使用Log4j2
<!– more –>

排除 Logback 依赖

Spring Boot 2.x默认使用 Logback 日志框架,要使用 Log4j2必须先排除 Logback

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
         <!-- 排除 logback-->
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

引入 Log4j2 依赖

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

上面的 log4j2 已经适配了 slf4j 日志门面,所以我们的代码无需替换,只需要替换具体的日志框架以及对应的配置文件。

配置 Log4j2

创建 log4j2.xml 文件,放在工程 resources 目录里。这样就可以不加任何配置。如果你需要指定配置文件需要在 Spring boot 配置文件 application.yml 中指定 logging.config 属性。下面是一份比较详细的 log4j2 配置文件

 <?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}/logs/info.log"
                       filePattern="${sys:user.home}/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/>
                  <SizeBasedTriggeringPolicy size="100 MB"/>
              </Policies>
          </RollingFile>
          <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
                       filePattern="${sys:user.home}/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/>
                  <SizeBasedTriggeringPolicy size="100 MB"/>
              </Policies>
          <!-- DefaultRolloverStrategy 属性如不设置,则默认为最多同一文件夹下 7 个文件,这里设置了 20 -->
              <DefaultRolloverStrategy max="20"/>
          </RollingFile>
          <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
                       filePattern="${sys:user.home}/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/>
                  <SizeBasedTriggeringPolicy size="100 MB"/>
              </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>

基本上你拿上面的配置根据你自己的需要更改一下即可生效。windows 下 ${sys:user.home} 会将日志打印到用户目录下

调用 Logger 输出日志

下面的示例代码使用了神器 lombok 中的 @Slf4j 注解可以很方便的使用 org.slf4j.Logger 对象。 日常开发尽量使用 Slf4j 门面来处理日志,尽量避免使用具体的日志框架。

package cn.felord.spring.security;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalDate;
import java.util.Properties;

/**
 * @author dax
 * @since 2019/10/9 0:03
 */
@Slf4j
@RestController
@RequestMapping("/logging")
public class LogController {@GetMapping("/do")
    public String log() {log.info("log4j2 test date: {}  info: {}", LocalDate.now(), "请关注公众号:Felordcn");
 
        return "log4j2";
    }
    
}

控制台输出:[00:14:48:161] [INFO] - cn.felord.spring.security.LogController.log(LogController.java:23) - log4j2 test date: 2019-10-09 info: 请关注公众号:Felordcn 并存档。

总结

今天我们将 Spring Boot 2.x 的日志框架由默认的Logback 替换为 log4j2 并着重的提及了一些实战中使用的要点。相信你很快能够掌握这一技巧。日志作为应用运行情况,业务执行情况的重要依据,是开发排错,业务追溯的重要保障。希望各位能够重视起来。

关注公众号:Felordcn 或者 https://felord.cn 获取更多资讯

退出移动版