SpringBoot2.* log4j2

前言

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

排除Logback依赖

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

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter</artifactId>
  4.     <exclusions>
  5.          <!--排除logback-->
  6.         <exclusion>
  7.             <groupId>org.springframework.boot</groupId>
  8.             <artifactId>spring-boot-starter-logging</artifactId>
  9.         </exclusion>
  10.     </exclusions>
  11. </dependency>

引入Log4j2依赖

  1. <!--log4j2 依赖-->
  2. <dependency>
  3.     <groupId>org.springframework.boot</groupId>
  4.     <artifactId>spring-boot-starter-log4j2</artifactId>
  5. </dependency>

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

配置Log4j2

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

  1.  <?xml version="1.0" encoding="UTF-8"?>
  2.   <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
  3.   <!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，可以看到log4j2内部各种详细输出-->
  4.   <!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
  5.   <configuration status="WARN" monitorInterval="30">
  6.       <!--先定义所有的appender-->
  7.       <appenders>
  8.       <!--这个输出控制台的配置-->
  9.           <console name="Console" target="SYSTEM_OUT">
  10.           <!--输出日志的格式-->
  11.               <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  12.           </console>
  13.       <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
  14.       <File name="log" fileName="log/test.log" append="false">
  15.          <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
  16.       </File>
  17.       <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
  18.           <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
  19.                        filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
  20.               <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
  21.               <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
  22.               <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  23.               <Policies>
  24.                   <TimeBasedTriggeringPolicy/>
  25.                   <SizeBasedTriggeringPolicy size="100 MB"/>
  26.               </Policies>
  27.           </RollingFile>
  28.           <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
  29.                        filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
  30.               <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
  31.               <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  32.               <Policies>
  33.                   <TimeBasedTriggeringPolicy/>
  34.                   <SizeBasedTriggeringPolicy size="100 MB"/>
  35.               </Policies>
  36.           <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
  37.               <DefaultRolloverStrategy max="20"/>
  38.           </RollingFile>
  39.           <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
  40.                        filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
  41.               <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
  42.               <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  43.               <Policies>
  44.                   <TimeBasedTriggeringPolicy/>
  45.                   <SizeBasedTriggeringPolicy size="100 MB"/>
  46.               </Policies>
  47.           </RollingFile>
  48.       </appenders>
  49.       <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
  50.       <loggers>
  51.           <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
  52.           <logger name="org.springframework" level="INFO"/>
  53.           <logger name="org.mybatis" level="INFO"/>
  54.           <root level="all">
  55.               <appender-ref ref="Console"/>
  56.               <appender-ref ref="RollingFileInfo"/>
  57.               <appender-ref ref="RollingFileWarn"/>
  58.               <appender-ref ref="RollingFileError"/>
  59.           </root>
  60.       </loggers>
  61.   </configuration>

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

调用Logger输出日志

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

  1. import lombok.extern.slf4j.Slf4j;
  2. import org.springframework.web.bind.annotation.GetMapping;
  3. import org.springframework.web.bind.annotation.RequestMapping;
  4. import org.springframework.web.bind.annotation.RestController;
  6. import java.time.LocalDate;
  7. import java.util.Properties;
  9. /**
  10.  * @author dax
  11.  * @since 2019/10/9 0:03
  12.  */
  13. @Slf4j
  14. @RestController
  15. @RequestMapping("/logging")
  16. public class LogController {
  19.     @GetMapping("/do")
  20.     public String log() {
  22.         log.info("log4j2 test date: {}  info: {}", LocalDate.now(), "Hello");
  24.         return "log4j2";
  25.     }
  27. }

控制台输出 ：

  1. [00:14:48:161] [INFO] - cn.fcant.spring.security.LogController.log(LogController.java:23) - log4j2 test date: 2019-10-09 info: Hello

并存档。