Re手册-工具篇 - Log4j2日志框架

1. 日志框架

log框架优点

还有多少人在打印日志时还在用System.out.println？我们平时本地写一些简单代码偶尔使用，但是在实际的项目上，是应该不会让你这么做的。打印本身也是一种资源消耗，在生产环境做无意义的日志输出，即是资源的浪费，也会导致日志文件冗余而庞大。所以很多人在本地测试时写了很多的System.out.println，到了上线前又一个个注释掉，其实spring boot早就有Log框架来处理这类需求。

log框架就是帮助开发人员进行日志输出管理的API类库。它最重要的特点就可以配置文件灵活的设置日志信息的优先级、日志信息的输出目的地以及日志信息的输出格式。log框架除了可以记录程序运行日志信息外还有一重要的功能就是用来显示调试信息。

当前流行的log框架有logback、log4j和log4j2三种，spring boot 官方默认的log框架是logback，集成在spring-boot-starter-web下。但目前性能更好的是log4j2，所以本文以log4j2为例讲解。

log4j2提供了AsyncAppender和AsyncLogger以及全局异步，开启方式如下

• 同步模式：默认配置即为同步模式，即没有使用任何AsyncAppender和AsyncLogger
• 全局异步：配置按照同步方式配，通过添加jvm启动参数即可开启全局异步，无需修改配置和应用
• 混合异步：使用异步Logger和同步Logger的混合配置，且不开启全局异步，即Logger配置中部分AsyncLogger，部分Logger

引入log

如果使用默认的logback框架，在引入spring-boot-starter-web即可，无需其他操作。如果是其他框架，则需要先排查logback的依赖包，再进入对应的框架依赖，如下：

        <!--web-->
        <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>
        <!--log4j2-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>

lombok

lombok通常用来解决代码冗余的，同样可以用在log框架中，如果不想每次都写private final Logger logger = LoggerFactory.getLogger(XXX.class); 可以添加类的注解@Slf4j，然后在类中就可以直接使用log对象。

        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.0</version>
        </dependency>

2. xml配置

log的配置有两种方式，一种是通过xml文件来配置，另一种是通过application的配置文件。我个人偏向于application配置文件，因为实在不想再回到spring mvc的恐惧。本段先讲xml的配置，下段再讲配置文件。

简单来说是在classpath目录下创建log4j2.xml（命名无要求），用于配置日志的输出规则，然后在配置文件中指定xml文件路径。

log4j2.xml缺省默认配置文件:

<?xml version="1.0" encoding="UTF-8"?>
 <Configuration status="WARN">
   <Appenders>
     <Console name="Console" target="SYSTEM_OUT">
       <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
     </Console>
   </Appenders>
   <Loggers>
     <Root level="error">
       <AppenderRef ref="Console"/>
     </Root>
   </Loggers>
 </Configuration>

1、根节点Configuration

有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).

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

2、Appenders节点

常见的有三种子节点:Console、RollingFile、File。

1. console:节点用来定义输出到控制台的Appender.

   1.1. name:指定Appender的名字.

   1.2. target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT

   1.3. PatternLayout:输出格式，不设置默认为:%m%n.

2. File:节点用来定义输出到指定位置的文件的Appender.

　　2.1. name:指定Appender的名字.

　　2.2. fileName:指定输出日志的目的文件带全路径的文件名.

　　2.3. PatternLayout:输出格式，不设置默认为:%m%n.

1. RollingFile:节点用来定义超过指定大小自动删除旧的创建新的的Appender.

　　3.1. name:指定Appender的名字.

　　3.2. fileName:指定输出日志的目的文件带全路径的文件名.

　　3.3. PatternLayout:输出格式，不设置默认为:%m%n.

　　3.4. filePattern:指定新建日志文件的名称格式.

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

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

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

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

3、Loggers节点

常见的有两种:Root和Logger.

1. Root：节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出

　　1.1. level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

　　1.2. AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.

1. Logger：节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。

　　2.1. level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

　　2.2. name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.

　　2.3. AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

4、关于日志level.

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

• All:最低等级的，用于打开所有日志记录.
• Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.
• Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
• Info:消息在粗粒度级别上突出强调应用程序的运行过程.
• Warn:输出警告及warn以下级别的日志.
• Error:输出错误信息日志.
• Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
• OFF:最高等级的，用于关闭所有日志记录.

程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少。

比较完整的log4j2.xml配置模板

<?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>
         <logger name="org.mybatis" level="INFO"></logger>
         <root level="all">
             <appender-ref ref="Console"/>
             <appender-ref ref="RollingFileInfo"/>
             <appender-ref ref="RollingFileWarn"/>
             <appender-ref ref="RollingFileError"/>
         </root>
     </loggers>
 </configuration>

3. application 配置

不配置log4j2.xml文件，而通过application.properties文件也可以配置，但是选项较少，不过日常的基础功能就已经够了。

application.properties文件参考：

logging.config = ＃记录配置文件的位置。例如Logback的`classpath:logback.xml` 
logging.exception-conversion-word =％wEx ＃记录异常时使用的转换字。
logging.file =＃日志文件名称。例如`myapp.log` 
logging.level.* = ＃日志级别严重性映射。例如`logging.level.org.springframework = DEBUG` 
logging.path = ＃日志文件的位置。例如`/var/log` 
logging.pattern.console = ＃输出到控制台的Appender模式。仅支持默认的登录设置。
logging.pattern.file = ＃输出到文件的Appender模式。仅支持默认的登录设置。
logging.pattern.level = ＃日志级别的Appender模式（默认％5p）。仅支持默认的登录设置。
logging.register-shutdown-hook = false＃初始化时为日志系统注册一个关闭钩子

参数说明

Spring的配置（可以通过启动是--xxx指定）	系统属性（可以通过启动是-Dxxx指定）	注释
logging.exception-conversion-word	LOG_EXCEPTION_CONVERSION_WORD	记录异常时使用的转换字。
logging.file	LOG_FILE	用于默认日志配置（如果已定义）。
logging.path	LOG_PATH	用于默认日志配置（如果已定义）。
logging.pattern.console	CONSOLE_LOG_PATTERN	在控制台上使用的日志模式（stdout）。（仅支持默认的登录设置。）
logging.pattern.file	FILE_LOG_PATTERN	在文件中使用的日志模式（如果启用LOG_FILE）。（仅支持默认的登录设置。）
logging.pattern.level	LOG_LEVEL_PATTERN	用于呈现日志级别的格式（默认%5p）。（仅支持默认的登录设置。）

logging.path与logging.file的配置注意事项

• 若只配置logging.path，那么将会在F:demo文件夹生成一个日志文件为spring.log（ps：该文件名是固定的，不能更改）。如果path路径不存在，会自动创建该文件夹

• 若只配置logging.file，那将会在项目的当前路径下生成一个demo.log日志文件。这里可以使用绝对路径如，会自动在e盘下创建文件夹和相应的日志文件。

  logging.file=e:\\demo\\demo.log

• logging.path和logging.file同时配置，不会在这个路径有F:demodemo.log日志生成，logging.path和logging.file不会进行叠加（要注意）
• logging.path和logging.file的value都可以是相对路径或者绝对路径